Changeset 35781 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

12/06/2015 06:09:42 PM (9 years ago)

Author:

westonruter

Message:

Customizer: Return added instances for panels, sections, controls, and settings when calling WP_Customize_Manager::add_*() methods.

Add missing phpDoc.

Props fusillicode, jubstuff.
Fixes #34596.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (9 diffs)

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

@@ -1038 +1038 @@
      *
      * @since 3.4.0
-     *
-     * @param WP_Customize_Setting|string $id Customize Setting object, or ID.
-     * @param array $args                     Setting arguments; passed to WP_Customize_Setting
-     *                                        constructor.
+     * @since 4.5.0 Return added WP_Customize_Setting instance.
+     * @access public
+     *
+     * @param WP_Customize_Setting|string $id   Customize Setting object, or ID.
+     * @param array                       $args Setting arguments; passed to WP_Customize_Setting
+     *                                          constructor.
+     * @return WP_Customize_Setting             The instance of the setting that was added.
      */
     public function add_setting( $id, $args = array() ) {
@@ -1049 +1052 @@
             $setting = new WP_Customize_Setting( $this, $id, $args );
         }
+
         $this->settings[ $setting->id ] = $setting;
+        return $setting;
     }
 
@@ -1062 +1067 @@
      *
      * @since 4.2.0
+     * @access public
      *
      * @param array $setting_ids The setting IDs to add.
@@ -1142 +1148 @@
      *
      * @since 4.0.0
+     * @since 4.5.0 Return added WP_Customize_Panel instance.
      * @access public
      *
      * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel ID.
      * @param array                     $args Optional. Panel arguments. Default empty array.
+     *
+     * @return WP_Customize_Panel             The instance of the panel that was added.
      */
     public function add_panel( $id, $args = array() ) {
@@ -1155 +1164 @@
 
         $this->panels[ $panel->id ] = $panel;
+        return $panel;
     }
 
@@ -1217 +1227 @@
      *
      * @since 3.4.0
+     * @since 4.5.0 Return added WP_Customize_Section instance.
+     * @access public
      *
      * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
      * @param array                       $args Section arguments.
+     *
+     * @return WP_Customize_Section             The instance of the section that was added.
      */
     public function add_section( $id, $args = array() ) {
@@ -1227 +1241 @@
             $section = new WP_Customize_Section( $this, $id, $args );
         }
+
         $this->sections[ $section->id ] = $section;
+        return $section;
     }
 
@@ -1287 +1303 @@
      *
      * @since 3.4.0
+     * @since 4.5.0 Return added WP_Customize_Control instance.
+     * @access public
      *
      * @param WP_Customize_Control|string $id   Customize Control object, or ID.
      * @param array                       $args Control arguments; passed to WP_Customize_Control
      *                                          constructor.
+     * @return WP_Customize_Control             The instance of the control that was added.
      */
     public function add_control( $id, $args = array() ) {
@@ -1298 +1317 @@
             $control = new WP_Customize_Control( $this, $id, $args );
         }
+
         $this->controls[ $control->id ] = $control;
+        return $control;
     }