Changeset 51783

Timestamp:

09/09/2021 02:31:13 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_Customize_Setting::sanitize().

In each child class: renames the parameter to match the parent's method signature.

Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

Changes for readability:

• @since clearly specifies the original parameter name and its new name as well as why the change happened.

• In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.

Follow-up to [19995], [32806].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

Location:

trunk/src/wp-includes

Files:

• class-wp-customize-setting.php (modified) (1 diff)
• customize/class-wp-customize-nav-menu-item-setting.php (modified) (1 diff)
• customize/class-wp-customize-nav-menu-setting.php (modified) (1 diff)

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

@@ -560 +560 @@
      * @since 3.4.0
      *
-     * @param string|array $value    The value to sanitize.
+     * @param string|array $value The value to sanitize.
      * @return string|array|null|WP_Error Sanitized value, or `null`/`WP_Error` if invalid.
      */

trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

@@ -654 +654 @@
      *
      * @since 4.3.0
-     *
-     * @param array $menu_item_value The value to sanitize.
+     * @since 5.9.0 Renamed `$menu_item_value` to `$value` for PHP 8 named parameter support.
+     *
+     * @param array $value The menu item value to sanitize.
      * @return array|false|null|WP_Error Null or WP_Error if an input isn't valid. False if it is marked for deletion.
      *                                   Otherwise the sanitized value.
      */
-    public function sanitize( $menu_item_value ) {
+    public function sanitize( $value ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $menu_item_value = $value;
+
         // Menu is marked for deletion.
         if ( false === $menu_item_value ) {

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

@@ -408 +408 @@
      * @since 4.3.0
      *
-     * @param array $value The value to sanitize.
+     * @param array $value The menu value to sanitize.
      * @return array|false|null Null if an input isn't valid. False if it is marked for deletion.
      *                          Otherwise the sanitized value.