Changeset 55014

Timestamp:

12/23/2022 11:36:13 AM (22 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/theme.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 $default parameter to $default_value in get_theme_mod().
• Renames the $include parameter to $file in require_if_theme_supports().

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].

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

File:

• trunk/src/wp-includes/theme.php (modified) (4 diffs)

trunk/src/wp-includes/theme.php

@@ -992 +992 @@
  * Retrieves theme modification value for the active theme.
  *
- * If the modification name does not exist and `$default` is a string, then the
+ * If the modification name does not exist and `$default_value` is a string, then the
  * default will be passed through the {@link https://www.php.net/sprintf sprintf()}
  * PHP function with the template directory URI as the first value and the
@@ -999 +999 @@
  * @since 2.1.0
  *
- * @param string $name    Theme modification name.
- * @param mixed  $default Optional. Theme modification default value. Default false.
+ * @param string $name          Theme modification name.
+ * @param mixed  $default_value Optional. Theme modification default value. Default false.
  * @return mixed Theme modification value.
  */
-function get_theme_mod( $name, $default = false ) {
+function get_theme_mod( $name, $default_value = false ) {
     $mods = get_theme_mods();
 
@@ -1021 +1021 @@
     }
 
-    if ( is_string( $default ) ) {
+    if ( is_string( $default_value ) ) {
         // Only run the replacement if an sprintf() string format pattern was found.
-        if ( preg_match( '#(?<!%)%(?:\d+\$?)?s#', $default ) ) {
+        if ( preg_match( '#(?<!%)%(?:\d+\$?)?s#', $default_value ) ) {
             // Remove a single trailing percent sign.
-            $default = preg_replace( '#(?<!%)%$#', '', $default );
-            $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
+            $default_value = preg_replace( '#(?<!%)%$#', '', $default_value );
+            $default_value = sprintf( $default_value, get_template_directory_uri(), get_stylesheet_directory_uri() );
         }
     }
 
     /** This filter is documented in wp-includes/theme.php */
-    return apply_filters( "theme_mod_{$name}", $default );
+    return apply_filters( "theme_mod_{$name}", $default_value );
 }
 
@@ -3126 +3126 @@
  * @param string $feature The feature being checked. See add_theme_support() for the list
  *                        of possible values.
- * @param string $include Path to the file.
+ * @param string $file    Path to the file.
  * @return bool True if the active theme supports the supplied feature, false otherwise.
  */
-function require_if_theme_supports( $feature, $include ) {
+function require_if_theme_supports( $feature, $file ) {
     if ( current_theme_supports( $feature ) ) {
-        require $include;
+        require $file;
         return true;
     }