Changeset 54929 for trunk/src/wp-includes/formatting.php

Timestamp:

12/03/2022 03:05:41 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/functions.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 $echo parameter to $display in:
  • wp_nonce_field()
  • wp_referer_field()
  • wp_original_referer_field()
• Renames the $string parameter to $input_string in
  • _wp_json_convert_string()
  • _wp_to_kebab_case()
• Renames the $list parameter to $input_list in:
  • wp_parse_list()
  • wp_parse_id_list()
  • wp_parse_slug_list()
  • wp_filter_object_list()
  • wp_list_filter()
  • wp_list_pluck()
  • wp_list_sort()
• Renames the $array parameter to $input_array in:
  • add_magic_quotes()
  • wp_array_slice_assoc()
  • _wp_array_get()
  • _wp_array_set()
• Renames the $function parameter to $function_name in:
  • _deprecated_function()
  • _deprecated_argument()
  • _doing_it_wrong()
• Renames the $class parameter to $class_name in _deprecated_constructor().
• Renames the $default parameter to $default_value in apache_mod_loaded().
• Renames the $var parameter to $value in wp_validate_boolean().
• Amends the $input parameter in wp_parse_str() for consistency.

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].

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

File:

• trunk/src/wp-includes/formatting.php (modified) (1 diff)

trunk/src/wp-includes/formatting.php

@@ -5034 +5034 @@
  * @since 2.2.1
  *
- * @param string $input  The string to be parsed.
- * @param array  $result Variables will be stored in this array.
- */
-function wp_parse_str( $input, &$result ) {
-    parse_str( (string) $input, $result );
+ * @param string $input_string The string to be parsed.
+ * @param array  $result       Variables will be stored in this array.
+ */
+function wp_parse_str( $input_string, &$result ) {
+    parse_str( (string) $input_string, $result );
 
     /**