Changeset 30368

Timestamp:

11/17/2014 05:07:19 PM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-admin/includes/screen.php (modified) (1 diff)

trunk/src/wp-admin/includes/screen.php

@@ -649 +649 @@
      *
      * @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 ) {