Changeset 55162

Timestamp:

01/30/2023 02:13:49 PM (21 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/formatting.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the $class parameter to $classname in sanitize_html_class().

Follow-up to [54927].

See also: equivalent commits for other files.

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

File:

• trunk/src/wp-includes/formatting.php (modified) (2 diffs)

trunk/src/wp-includes/formatting.php

@@ -2406 +2406 @@
  * @since 2.8.0
  *
- * @param string $class    The classname to be sanitized
- * @param string $fallback Optional. The value to return if the sanitization ends up as an empty string.
- *  Defaults to an empty string.
- * @return string The sanitized value
- */
-function sanitize_html_class( $class, $fallback = '' ) {
+ * @param string $classname The classname to be sanitized.
+ * @param string $fallback  Optional. The value to return if the sanitization ends up as an empty string.
+ *                          Default empty string.
+ * @return string The sanitized value.
+ */
+function sanitize_html_class( $classname, $fallback = '' ) {
     // Strip out any %-encoded octets.
-    $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $class );
+    $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $classname );
 
     // Limit to A-Z, a-z, 0-9, '_', '-'.
@@ -2427 +2427 @@
      *
      * @param string $sanitized The sanitized HTML class.
-     * @param string $class     HTML class before sanitization.
+     * @param string $classname HTML class before sanitization.
      * @param string $fallback  The fallback string.
      */
-    return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );
+    return apply_filters( 'sanitize_html_class', $sanitized, $classname, $fallback );
 }