Changeset 30676

Timestamp:

11/30/2014 11:32:31 PM (10 years ago)

Author:

wonderboymusic

Message:

Improve various @param docs for src/wp-includes/class-wp-customize*.php.

See #30224.

Location:

trunk/src/wp-includes

Files:

• class-wp-customize-control.php (modified) (2 diffs)
• class-wp-customize-manager.php (modified) (2 diffs)
• class-wp-customize-setting.php (modified) (3 diffs)
• class-wp-customize-widgets.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-customize-control.php

@@ -823 +823 @@
      *
      * @param WP_Customize_Manager $manager
+     * @param string $id
+     * @param array  $args
      */
     public function __construct( $manager, $id, $args = array() ) {
@@ -902 +904 @@
     public $default_headers;
 
+    /**
+     * @param WP_Customize_Manager $manager
+     */
     public function __construct( $manager ) {
         parent::__construct( $manager, 'header_image', array(

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -63 +63 @@
     protected $registered_control_types = array();
 
-    /** 
+    /**
      * $_POST values for Customize Settings.
      *
@@ -404 +404 @@
      * @since 3.4.0
      *
-     * @param mixed $setting A WP_Customize_Setting derived object
+     * @param WP_Customize_Setting $setting A WP_Customize_Setting derived object
      * @return string $post_value Sanitized value
      */

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -169 +169 @@
      * @since 3.4.0
      *
-     * @return bool False if cap check fails or value isn't set.
+     * @return false|null False if cap check fails or value isn't set.
      */
     public final function save() {
@@ -295 +295 @@
      *
      * @param mixed $value The value to update.
-     * @return mixed The result of saving the value.
+     * @return bool|null The result of saving the value.
      */
     protected function _update_option( $value ) {
@@ -470 +470 @@
      * @param $root
      * @param $keys
-     * @param $default A default value which is used as a fallback. Default is null.
+     * @param mixed $default A default value which is used as a fallback. Default is null.
      * @return mixed The requested value or the default value.
      */

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -326 +326 @@
      * @access public
      *
-     * @param array $sidebars_widgets
+     * @param array $old_sidebars_widgets
      */
     public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) {