Changeset 54930

Timestamp:

12/04/2022 12:44:21 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/functions.wp-scripts.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 $function parameter to $function_name in _wp_scripts_maybe_doing_it_wrong().
• Renames the $list parameter to $status in wp_script_is().

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

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

File:

• trunk/src/wp-includes/functions.wp-scripts.php (modified) (3 diffs)

trunk/src/wp-includes/functions.wp-scripts.php

@@ -35 +35 @@
  * @since 5.5.0 Added the `$handle` parameter.
  *
- * @param string $function Function name.
- * @param string $handle   Optional. Name of the script or stylesheet that was
- *                         registered or enqueued too early. Default empty.
- */
-function _wp_scripts_maybe_doing_it_wrong( $function, $handle = '' ) {
+ * @param string $function_name Function name.
+ * @param string $handle        Optional. Name of the script or stylesheet that was
+ *                              registered or enqueued too early. Default empty.
+ */
+function _wp_scripts_maybe_doing_it_wrong( $function_name, $handle = '' ) {
     if ( did_action( 'init' ) || did_action( 'wp_enqueue_scripts' )
         || did_action( 'admin_enqueue_scripts' ) || did_action( 'login_enqueue_scripts' )
@@ -63 +63 @@
 
     _doing_it_wrong(
-        $function,
+        $function_name,
         $message,
         '3.3.0'
@@ -390 +390 @@
  *
  * @param string $handle Name of the script.
- * @param string $list   Optional. Status of the script to check. Default 'enqueued'.
+ * @param string $status Optional. Status of the script to check. Default 'enqueued'.
  *                       Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.
  * @return bool Whether the script is queued.
  */
-function wp_script_is( $handle, $list = 'enqueued' ) {
-    _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
-
-    return (bool) wp_scripts()->query( $handle, $list );
+function wp_script_is( $handle, $status = 'enqueued' ) {
+    _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
+
+    return (bool) wp_scripts()->query( $handle, $status );
 }