Changeset 51518 for trunk/src/wp-includes/class-wp-customize-setting.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-setting.php (modified) (5 diffs)

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

@@ -395 +395 @@
                                  * @since 3.4.0
                                  *
-                                 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+                                 * @param WP_Customize_Setting $setting WP_Customize_Setting instance.
                                  */
                                 do_action( "customize_preview_{$this->id}", $this );
@@ -407 +407 @@
                                  * @since 4.1.0
                                  *
-                                 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+                                 * @param WP_Customize_Setting $setting WP_Customize_Setting instance.
                                  */
                                 do_action( "customize_preview_{$this->type}", $this );
@@ -534 +534 @@
                  * @since 3.4.0
                  *
-                 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+                 * @param WP_Customize_Setting $setting WP_Customize_Setting instance.
                  */
                 do_action( "customize_save_{$id_base}", $this );
@@ -570 +570 @@
                  * @since 3.4.0
                  *
-                 * @param mixed                $value Value of the setting.
-                 * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+                 * @param mixed                $value   Value of the setting.
+                 * @param WP_Customize_Setting $setting WP_Customize_Setting instance.
                  */
                 return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
@@ -698 +698 @@
                          * @since 3.4.0
                          *
-                         * @param mixed                $value Value of the setting.
-                         * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+                         * @param mixed                $value   Value of the setting.
+                         * @param WP_Customize_Setting $setting WP_Customize_Setting instance.
                          */
                         do_action( "customize_update_{$this->type}", $value, $this );