Changeset 32032

Timestamp:

04/05/2015 03:06:40 PM (10 years ago)

Author:

DrewAPicture

Message:

Fix inline documentation syntax in a variety of DocBlocks and hook docs in WP_Customize_Manager.

See [31370]. See #31888.

File:

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

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

@@ -571 +571 @@
      *
      * @since 4.2.0
+     * @access public
      */
     public function customize_preview_loading_style() {
@@ -769 +770 @@
 
         /**
-         * Filter response data for a successful customize_save Ajax request.
+         * Filter response data for a successful customize_save AJAX request.
          *
          * This filter does not apply if there was a nonce or authentication failure.
@@ -802 +803 @@
 
     /**
-     * Register any dynamically-created settings, such as those from $_POST['customized'] that have no corresponding setting created.
+     * Register any dynamically-created settings, such as those from $_POST['customized']
+     * that have no corresponding setting created.
      *
      * This is a mechanism to "wake up" settings that have been dynamically created
-     * on the frontend and have been sent to WordPress in $_POST['customized']. When WP
+     * on the frontend and have been sent to WordPress in `$_POST['customized']`. When WP
      * loads, the dynamically-created settings then will get created and previewed
      * even though they are not directly created statically with code.
@@ -811 +813 @@
      * @since 4.2.0
      *
-     * @param string[] $setting_ids The setting IDs to add.
-     * @return WP_Customize_Setting[] The settings added.
+     * @param string $setting_ids The setting IDs to add.
+     * @return WP_Customize_Setting The settings added.
      */
     public function add_dynamic_settings( $setting_ids ) {
@@ -834 +836 @@
              * @since 4.2.0
              *
-             * @param false|array $setting_args  The arguments to the WP_Customize_Setting constructor.
-             * @param string      $setting_id    ID for dynamic setting, usually coming from $_POST['customized'].
+             * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor.
+             * @param string      $setting_id   ID for dynamic setting, usually coming from `$_POST['customized']`.
              */
             $setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id );
@@ -847 +849 @@
              * @since 4.2.0
              *
-             * @param string $setting_class  WP_Customize_Setting or a subclass.
-             * @param string $setting_id     ID for dynamic setting, usually coming from $_POST['customized'].
-             * @param string $setting_args   WP_Customize_Setting or a subclass.
+             * @param string $setting_class WP_Customize_Setting or a subclass.
+             * @param string $setting_id    ID for dynamic setting, usually coming from `$_POST['customized']`.
+             * @param string $setting_args  WP_Customize_Setting or a subclass.
              */
             $setting_class = apply_filters( 'customize_dynamic_setting_class', $setting_class, $setting_id, $setting_args );
 
             $setting = new $setting_class( $this, $setting_id, $setting_args );
+
             $this->add_setting( $setting );
             $new_settings[] = $setting;
@@ -1451 +1454 @@
      *
      * @since 4.2.0
+     * @access public
+     *
+     * @see add_dynamic_settings()
      */
     public function register_dynamic_settings() {