Changeset 51785

Timestamp:

09/09/2021 03:17:20 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatch with parent in WP_Customize_Custom_CSS_Setting::validate().

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.

Adds @since to clearly specify why the change happened.

Reassigns the generic parameter to the original parameter.
Why? Restoring the original name keeps the context intact within the method and makes the code more readable. An inline comment explains why this reassignment is made

Follow-up to [37476], [38829], [41376].

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

File:

• trunk/src/wp-includes/customize/class-wp-customize-custom-css-setting.php (modified) (2 diffs)

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

@@ -146 +146 @@
 
     /**
-     * Validate CSS.
+     * Validate a received value for being valid CSS.
      *
      * Checks for imbalanced braces, brackets, and comments.
@@ -153 +153 @@
      * @since 4.7.0
      * @since 4.9.0 Checking for balanced characters has been moved client-side via linting in code editor.
-     *
-     * @param string $css The input string.
+     * @since 5.9.0 Renamed `$css` to `$value` for PHP 8 named parameter support.
+     *
+     * @param string $value CSS to validate.
      * @return true|WP_Error True if the input was validated, otherwise WP_Error.
      */
-    public function validate( $css ) {
+    public function validate( $value ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $css = $value;
+
         $validity = new WP_Error();