Changeset 58878 for trunk/src/wp-includes/class-wp-scripts.php

Timestamp:

08/10/2024 10:58:07 PM (2 months ago)

Author:

peterwilsoncc

Message:

Code Quality: Clarify variable names in dependency classes.

Renames several variables in the WP_Scripts and WP_Styles classes to clarify their purpose for developers reading the code.

Props peterwilsoncc, sergeybiryukov.
See #61607.

File:

• trunk/src/wp-includes/class-wp-scripts.php (modified) (17 diffs)

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

@@ -290 +290 @@
         }
 
-        $src               = $obj->src;
-        $strategy          = $this->get_eligible_loading_strategy( $handle );
-        $intended_strategy = (string) $this->get_data( $handle, 'strategy' );
-        $cond_before       = '';
-        $cond_after        = '';
-        $conditional       = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
+        $src                   = $obj->src;
+        $strategy              = $this->get_eligible_loading_strategy( $handle );
+        $intended_strategy     = (string) $this->get_data( $handle, 'strategy' );
+        $ie_conditional_prefix = '';
+        $ie_conditional_suffix = '';
+        $conditional           = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
 
         if ( ! $this->is_delayed_strategy( $intended_strategy ) ) {
@@ -321 +321 @@
 
         if ( $conditional ) {
-            $cond_before = "<!--[if {$conditional}]>\n";
-            $cond_after  = "<![endif]-->\n";
+            $ie_conditional_prefix = "<!--[if {$conditional}]>\n";
+            $ie_conditional_suffix = "<![endif]-->\n";
         }
 
@@ -329 +329 @@
 
         if ( $before_script || $after_script ) {
-            $inline_script_tag = $cond_before . $before_script . $after_script . $cond_after;
+            $inline_script_tag = $ie_conditional_prefix . $before_script . $after_script . $ie_conditional_suffix;
         } else {
             $inline_script_tag = '';
@@ -354 +354 @@
              * @param string $handle Script handle.
              */
-            $srce = apply_filters( 'script_loader_src', $src, $handle );
+            $filtered_src = apply_filters( 'script_loader_src', $src, $handle );
 
             if (
-                $this->in_default_dir( $srce )
+                $this->in_default_dir( $filtered_src )
                 && ( $before_script || $after_script || $translations_stop_concat || $this->is_delayed_strategy( $strategy ) )
             ) {
@@ -365 +365 @@
                 _print_scripts();
                 $this->reset();
-            } elseif ( $this->in_default_dir( $srce ) && ! $conditional ) {
+            } elseif ( $this->in_default_dir( $filtered_src ) && ! $conditional ) {
                 $this->print_code     .= $this->print_extra_script( $handle, false );
                 $this->concat         .= "$handle,";
@@ -379 +379 @@
 
         if ( $has_conditional_data ) {
-            echo $cond_before;
+            echo $ie_conditional_prefix;
         }
 
@@ -385 +385 @@
 
         if ( $has_conditional_data ) {
-            echo $cond_after;
+            echo $ie_conditional_suffix;
         }
 
@@ -426 +426 @@
             $attr['data-wp-strategy'] = $intended_strategy;
         }
-        $tag  = $translations . $cond_before . $before_script;
+        $tag  = $translations . $ie_conditional_prefix . $before_script;
         $tag .= wp_get_script_tag( $attr );
-        $tag .= $after_script . $cond_after;
+        $tag .= $after_script . $ie_conditional_suffix;
 
         /**
@@ -627 +627 @@
     public function set_group( $handle, $recursion, $group = false ) {
         if ( isset( $this->registered[ $handle ]->args ) && 1 === $this->registered[ $handle ]->args ) {
-            $grp = 1;
+            $calculated_group = 1;
         } else {
-            $grp = (int) $this->get_data( $handle, 'group' );
-        }
-
-        if ( false !== $group && $grp > $group ) {
-            $grp = $group;
-        }
-
-        return parent::set_group( $handle, $recursion, $grp );
+            $calculated_group = (int) $this->get_data( $handle, 'group' );
+        }
+
+        if ( false !== $group && $calculated_group > $group ) {
+            $calculated_group = $group;
+        }
+
+        return parent::set_group( $handle, $recursion, $calculated_group );
     }
 
@@ -724 +724 @@
      */
     public function all_deps( $handles, $recursion = false, $group = false ) {
-        $r = parent::all_deps( $handles, $recursion, $group );
+        $result = parent::all_deps( $handles, $recursion, $group );
         if ( ! $recursion ) {
             /**
@@ -735 +735 @@
             $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
         }
-        return $r;
+        return $result;
     }
 
@@ -890 +890 @@
      */
     private function get_eligible_loading_strategy( $handle ) {
-        $intended = (string) $this->get_data( $handle, 'strategy' );
+        $intended_strategy = (string) $this->get_data( $handle, 'strategy' );
 
         // Bail early if there is no intended strategy.
-        if ( ! $intended ) {
+        if ( ! $intended_strategy ) {
             return '';
         }
@@ -901 +901 @@
          * strategies, since 'async' can fallback to 'defer', but not vice-versa.
          */
-        $initial = ( 'defer' === $intended ) ? array( 'defer' ) : null;
-
-        $eligible = $this->filter_eligible_strategies( $handle, $initial );
+        $initial_strategy = ( 'defer' === $intended_strategy ) ? array( 'defer' ) : null;
+
+        $eligible_strategies = $this->filter_eligible_strategies( $handle, $initial_strategy );
 
         // Return early once we know the eligible strategy is blocking.
-        if ( empty( $eligible ) ) {
+        if ( empty( $eligible_strategies ) ) {
             return '';
         }
 
-        return in_array( 'async', $eligible, true ) ? 'async' : 'defer';
+        return in_array( 'async', $eligible_strategies, true ) ? 'async' : 'defer';
     }
 
@@ -918 +918 @@
      * @since 6.3.0
      *
-     * @param string              $handle   The script handle.
-     * @param string[]|null       $eligible Optional. The list of strategies to filter. Default null.
-     * @param array<string, true> $checked  Optional. An array of already checked script handles, used to avoid recursive loops.
+     * @param string              $handle              The script handle.
+     * @param string[]|null       $eligible_strategies Optional. The list of strategies to filter. Default null.
+     * @param array<string, true> $checked             Optional. An array of already checked script handles, used to avoid recursive loops.
      * @return string[] A list of eligible loading strategies that could be used.
      */
-    private function filter_eligible_strategies( $handle, $eligible = null, $checked = array() ) {
+    private function filter_eligible_strategies( $handle, $eligible_strategies = null, $checked = array() ) {
         // If no strategies are being passed, all strategies are eligible.
-        if ( null === $eligible ) {
-            $eligible = $this->delayed_strategies;
+        if ( null === $eligible_strategies ) {
+            $eligible_strategies = $this->delayed_strategies;
         }
 
         // If this handle was already checked, return early.
         if ( isset( $checked[ $handle ] ) ) {
-            return $eligible;
+            return $eligible_strategies;
         }
 
@@ -939 +939 @@
         // If this handle isn't registered, don't filter anything and return.
         if ( ! isset( $this->registered[ $handle ] ) ) {
-            return $eligible;
+            return $eligible_strategies;
         }
 
         // If the handle is not enqueued, don't filter anything and return.
         if ( ! $this->query( $handle, 'enqueued' ) ) {
-            return $eligible;
+            return $eligible_strategies;
         }
 
@@ -962 +962 @@
         // If the intended strategy is 'defer', filter out 'async'.
         if ( 'defer' === $intended_strategy ) {
-            $eligible = array( 'defer' );
+            $eligible_strategies = array( 'defer' );
         }
 
@@ -970 +970 @@
         foreach ( $dependents as $dependent ) {
             // Bail early once we know the eligible strategy is blocking.
-            if ( empty( $eligible ) ) {
+            if ( empty( $eligible_strategies ) ) {
                 return array();
             }
 
-            $eligible = $this->filter_eligible_strategies( $dependent, $eligible, $checked );
-        }
-
-        return $eligible;
+            $eligible_strategies = $this->filter_eligible_strategies( $dependent, $eligible_strategies, $checked );
+        }
+
+        return $eligible_strategies;
     }