Changeset 51783 for trunk/src/wp-includes/class-wp-customize-setting.php

Timestamp:

09/09/2021 02:31:13 PM (4 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.

File:

• trunk/src/wp-includes/class-wp-customize-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.
      */