Add a missing @return description for WP_Screen::get_option().

Also declare the default value for the `$key` parameter.

Props dustyf for the initial patch.
Fixes #30363.

Built from https://develop.svn.wordpress.org/trunk@30368


git-svn-id: http://core.svn.wordpress.org/trunk@30366 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-17 17:08:21 +00:00
parent 14bf4939e4
commit bc054387d9

View File

@ -648,7 +648,8 @@ final class WP_Screen {
* @since 3.3.0
*
* @param string $option Option ID.
* @param mixed $key Optional. Specific array key for when the option is an array.
* @param string $key Optional. Specific array key for when the option is an array. Default false.
* @return mixed The option value if set, null otherwise.
*/
public function get_option( $option, $key = false ) {
if ( ! isset( $this->_options[ $option ] ) )