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

Timestamp:

07/30/2021 07:34:39 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Replace $this in hook param docs with more appropriate names.

$this is a pseudo-variable that cannot be used as the name of a function parameter, so renaming these helps prevent errors when implementing hook callback functions.

Fixes #53457

File:

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

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

@@ -347 +347 @@
                  *
                  * @param string[]             $components Array of core components to load.
-                 * @param WP_Customize_Manager $this       WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager   WP_Customize_Manager instance.
                  */
                 $components = apply_filters( 'customize_loaded_components', $this->components, $this );
@@ -692 +692 @@
                  * @since 3.4.0
                  *
-                 * @param WP_Customize_Manager $this WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 do_action( 'start_previewing_theme', $this );
@@ -730 +730 @@
                  * @since 3.4.0
                  *
-                 * @param WP_Customize_Manager $this WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 do_action( 'stop_previewing_theme', $this );
@@ -929 +929 @@
                  * @since 3.4.0
                  *
-                 * @param WP_Customize_Manager $this WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 do_action( 'customize_register', $this );
@@ -1860 +1860 @@
                  * @since 4.4.0
                  *
-                 * @param mixed                $value Unsanitized setting post value.
-                 * @param WP_Customize_Manager $this  WP_Customize_Manager instance.
+                 * @param mixed                $value   Unsanitized setting post value.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 do_action( "customize_post_value_set_{$setting_id}", $value, $this );
@@ -1877 +1877 @@
                  * @param string               $setting_id Setting ID.
                  * @param mixed                $value      Unsanitized setting post value.
-                 * @param WP_Customize_Manager $this       WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager    WP_Customize_Manager instance.
                  */
                 do_action( 'customize_post_value_set', $setting_id, $value, $this );
@@ -1938 +1938 @@
                  * @since 3.4.0
                  *
-                 * @param WP_Customize_Manager $this WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 do_action( 'customize_preview_init', $this );
@@ -2593 +2593 @@
                  * @param array                $response Additional information passed back to the 'saved'
                  *                                       event on `wp.customize`.
-                 * @param WP_Customize_Manager $this     WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager  WP_Customize_Manager instance.
                  */
                 $response = apply_filters( 'customize_save_response', $response, $this );
@@ -2761 +2761 @@
                  * @since 4.6.0
                  *
-                 * @param WP_Customize_Manager $this WP_Customize_Manager instance.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 do_action( 'customize_save_validation_before', $this );
@@ -4755 +4755 @@
                  * @since 4.2.0
                  *
-                 * @param string[]             $nonces Array of refreshed nonces for save and
-                 *                                     preview actions.
-                 * @param WP_Customize_Manager $this   WP_Customize_Manager instance.
+                 * @param string[]             $nonces  Array of refreshed nonces for save and
+                 *                                      preview actions.
+                 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
                  */
                 $nonces = apply_filters( 'customize_refresh_nonces', $nonces, $this );