2022-12-15 17:47:31 +01:00
< ? php
/**
* Dependencies API : WP_Scripts class
*
* @ since 2.6 . 0
*
* @ package WordPress
* @ subpackage Dependencies
*/
/**
* Core class used to register scripts .
*
* @ since 2.1 . 0
*
* @ see WP_Dependencies
*/
class WP_Scripts extends WP_Dependencies {
/**
* Base URL for scripts .
*
* Full URL with trailing slash .
*
* @ since 2.6 . 0
* @ var string
*/
public $base_url ;
/**
* URL of the content directory .
*
* @ since 2.8 . 0
* @ var string
*/
public $content_url ;
/**
* Default version string for scripts .
*
* @ since 2.6 . 0
* @ var string
*/
public $default_version ;
/**
* Holds handles of scripts which are enqueued in footer .
*
* @ since 2.8 . 0
* @ var array
*/
public $in_footer = array ();
/**
* Holds a list of script handles which will be concatenated .
*
* @ since 2.8 . 0
* @ var string
*/
public $concat = '' ;
/**
* Holds a string which contains script handles and their version .
*
* @ since 2.8 . 0
* @ deprecated 3.4 . 0
* @ var string
*/
public $concat_version = '' ;
/**
* Whether to perform concatenation .
*
* @ since 2.8 . 0
* @ var bool
*/
public $do_concat = false ;
/**
* Holds HTML markup of scripts and additional data if concatenation
* is enabled .
*
* @ since 2.8 . 0
* @ var string
*/
public $print_html = '' ;
/**
* Holds inline code if concatenation is enabled .
*
* @ since 2.8 . 0
* @ var string
*/
public $print_code = '' ;
/**
* Holds a list of script handles which are not in the default directory
* if concatenation is enabled .
*
* Unused in core .
*
* @ since 2.8 . 0
* @ var string
*/
public $ext_handles = '' ;
/**
* Holds a string which contains handles and versions of scripts which
* are not in the default directory if concatenation is enabled .
*
* Unused in core .
*
* @ since 2.8 . 0
* @ var string
*/
public $ext_version = '' ;
/**
* List of default directories .
*
* @ since 2.8 . 0
* @ var array
*/
public $default_dirs ;
2023-09-26 10:33:34 +02:00
/**
* Holds a mapping of dependents ( as handles ) for a given script handle .
* Used to optimize recursive dependency tree checks .
*
* @ since 6.3 . 0
2025-12-12 13:15:55 +01:00
* @ var array < string , string [] >
2023-09-26 10:33:34 +02:00
*/
private $dependents_map = array ();
/**
* Holds a reference to the delayed ( non - blocking ) script loading strategies .
* Used by methods that validate loading strategies .
*
* @ since 6.3 . 0
* @ var string []
*/
private $delayed_strategies = array ( 'defer' , 'async' );
2022-12-15 17:47:31 +01:00
/**
* Constructor .
*
* @ since 2.6 . 0
*/
public function __construct () {
$this -> init ();
add_action ( 'init' , array ( $this , 'init' ), 0 );
}
/**
* Initialize the class .
*
* @ since 3.4 . 0
*/
public function init () {
/**
* Fires when the WP_Scripts instance is initialized .
*
* @ since 2.6 . 0
*
* @ param WP_Scripts $wp_scripts WP_Scripts instance ( passed by reference ) .
*/
do_action_ref_array ( 'wp_default_scripts' , array ( & $this ) );
}
/**
* Prints scripts .
*
* Prints the scripts passed to it or the print queue . Also prints all necessary dependencies .
*
* @ since 2.1 . 0
* @ since 2.8 . 0 Added the `$group` parameter .
*
* @ param string | string [] | false $handles Optional . Scripts to be printed : queue ( false ),
* single script ( string ), or multiple scripts ( array of strings ) .
* Default false .
* @ param int | false $group Optional . Group level : level ( int ), no groups ( false ) .
* Default false .
* @ return string [] Handles of scripts that have been printed .
*/
public function print_scripts ( $handles = false , $group = false ) {
return $this -> do_items ( $handles , $group );
}
/**
* Prints extra scripts of a registered script .
*
* @ since 2.1 . 0
* @ since 2.8 . 0 Added the `$display` parameter .
* @ deprecated 3.3 . 0
*
* @ see print_extra_script ()
*
* @ param string $handle The script ' s registered handle .
* @ param bool $display Optional . Whether to print the extra script
* instead of just returning it . Default true .
* @ return bool | string | void Void if no data exists , extra scripts if `$display` is true ,
* true otherwise .
*/
public function print_scripts_l10n ( $handle , $display = true ) {
_deprecated_function ( __FUNCTION__ , '3.3.0' , 'WP_Scripts::print_extra_script()' );
return $this -> print_extra_script ( $handle , $display );
}
/**
* Prints extra scripts of a registered script .
*
* @ since 3.3 . 0
*
* @ param string $handle The script ' s registered handle .
* @ param bool $display Optional . Whether to print the extra script
* instead of just returning it . Default true .
* @ return bool | string | void Void if no data exists , extra scripts if `$display` is true ,
* true otherwise .
*/
public function print_extra_script ( $handle , $display = true ) {
$output = $this -> get_data ( $handle , 'data' );
if ( ! $output ) {
return ;
}
2025-12-12 13:15:55 +01:00
/*
* Do not print a sourceURL comment if concatenation is enabled .
*
* Extra scripts may be concatenated into a single script .
* The line - based sourceURL comments may break concatenated scripts
* and do not make sense when multiple scripts are joined together .
*/
if ( ! $this -> do_concat ) {
$output .= sprintf (
" \n //# sourceURL=%s " ,
rawurlencode ( " { $handle } -js-extra " )
);
}
2022-12-15 17:47:31 +01:00
if ( ! $display ) {
return $output ;
}
2023-12-07 09:44:11 +01:00
wp_print_inline_script_tag ( $output , array ( 'id' => " { $handle } -js-extra " ) );
2022-12-15 17:47:31 +01:00
2023-12-07 09:44:11 +01:00
return true ;
}
2022-12-15 17:47:31 +01:00
2023-12-07 09:44:11 +01:00
/**
* Checks whether all dependents of a given handle are in the footer .
*
* If there are no dependents , this is considered the same as if all dependents were in the footer .
*
* @ since 6.4 . 0
*
* @ param string $handle Script handle .
* @ return bool Whether all dependents are in the footer .
*/
private function are_all_dependents_in_footer ( $handle ) {
foreach ( $this -> get_dependents ( $handle ) as $dep ) {
if ( isset ( $this -> groups [ $dep ] ) && 0 === $this -> groups [ $dep ] ) {
return false ;
}
2022-12-15 17:47:31 +01:00
}
return true ;
}
/**
* Processes a script dependency .
*
* @ since 2.6 . 0
* @ since 2.8 . 0 Added the `$group` parameter .
*
* @ see WP_Dependencies :: do_item ()
*
* @ param string $handle The script ' s registered handle .
* @ param int | false $group Optional . Group level : level ( int ), no groups ( false ) .
* Default false .
* @ return bool True on success , false on failure .
*/
public function do_item ( $handle , $group = false ) {
if ( ! parent :: do_item ( $handle ) ) {
return false ;
}
if ( 0 === $group && $this -> groups [ $handle ] > 0 ) {
$this -> in_footer [] = $handle ;
return false ;
}
if ( false === $group && in_array ( $handle , $this -> in_footer , true ) ) {
$this -> in_footer = array_diff ( $this -> in_footer , ( array ) $handle );
}
$obj = $this -> registered [ $handle ];
2025-12-12 13:15:55 +01:00
if ( $obj -> extra [ 'conditional' ] ? ? false ) {
return false ;
}
2022-12-15 17:47:31 +01:00
if ( null === $obj -> ver ) {
$ver = '' ;
} else {
$ver = $obj -> ver ? $obj -> ver : $this -> default_version ;
}
if ( isset ( $this -> args [ $handle ] ) ) {
$ver = $ver ? $ver . '&' . $this -> args [ $handle ] : $this -> args [ $handle ];
}
2025-12-12 13:15:55 +01:00
$src = $obj -> src ;
$strategy = $this -> get_eligible_loading_strategy ( $handle );
$intended_strategy = ( string ) $this -> get_data ( $handle , 'strategy' );
2023-09-26 10:33:34 +02:00
if ( ! $this -> is_delayed_strategy ( $intended_strategy ) ) {
$intended_strategy = '' ;
}
2022-12-15 17:47:31 +01:00
2023-12-07 09:44:11 +01:00
/*
* Move this script to the footer if :
* 1. The script is in the header group .
* 2. The current output is the header .
* 3. The intended strategy is delayed .
* 4. The actual strategy is not delayed .
* 5. All dependent scripts are in the footer .
*/
if (
0 === $group &&
0 === $this -> groups [ $handle ] &&
$intended_strategy &&
! $this -> is_delayed_strategy ( $strategy ) &&
$this -> are_all_dependents_in_footer ( $handle )
) {
$this -> in_footer [] = $handle ;
return false ;
}
2023-09-26 10:33:34 +02:00
$before_script = $this -> get_inline_script_tag ( $handle , 'before' );
$after_script = $this -> get_inline_script_tag ( $handle , 'after' );
2022-12-15 17:47:31 +01:00
2023-09-26 10:33:34 +02:00
if ( $before_script || $after_script ) {
2025-12-12 13:15:55 +01:00
$inline_script_tag = $before_script . $after_script ;
2022-12-15 17:47:31 +01:00
} else {
$inline_script_tag = '' ;
}
/*
* Prevent concatenation of scripts if the text domain is defined
* to ensure the dependency order is respected .
*/
$translations_stop_concat = ! empty ( $obj -> textdomain );
$translations = $this -> print_translations ( $handle , false );
if ( $translations ) {
2025-12-12 13:15:55 +01:00
/*
* The sourceURL comment is not included by WP_Scripts :: print_translations ()
* when `$display` is `false` to prevent issues where the script tag contents are used
* by extenders for other purposes , for example concatenated with other script content .
*
* Include the sourceURL comment here as it would be when printed directly .
*/
$source_url = rawurlencode ( " { $handle } -js-translations " );
$translations .= " \n //# sourceURL= { $source_url } " ;
$translations = wp_get_inline_script_tag ( $translations , array ( 'id' => " { $handle } -js-translations " ) );
2022-12-15 17:47:31 +01:00
}
if ( $this -> do_concat ) {
/**
* Filters the script loader source .
*
* @ since 2.2 . 0
*
* @ param string $src Script loader source path .
* @ param string $handle Script handle .
*/
2025-02-28 08:42:11 +01:00
$filtered_src = apply_filters ( 'script_loader_src' , $src , $handle );
2022-12-15 17:47:31 +01:00
2023-09-26 10:33:34 +02:00
if (
2025-02-28 08:42:11 +01:00
$this -> in_default_dir ( $filtered_src )
2023-09-26 10:33:34 +02:00
&& ( $before_script || $after_script || $translations_stop_concat || $this -> is_delayed_strategy ( $strategy ) )
) {
2022-12-15 17:47:31 +01:00
$this -> do_concat = false ;
// Have to print the so-far concatenated scripts right away to maintain the right order.
_print_scripts ();
$this -> reset ();
2025-12-12 13:15:55 +01:00
} elseif ( $this -> in_default_dir ( $filtered_src ) ) {
2022-12-15 17:47:31 +01:00
$this -> print_code .= $this -> print_extra_script ( $handle , false );
$this -> concat .= " $handle , " ;
$this -> concat_version .= " $handle $ver " ;
return true ;
} else {
$this -> ext_handles .= " $handle , " ;
$this -> ext_version .= " $handle $ver " ;
}
}
$this -> print_extra_script ( $handle );
// A single item may alias a set of items, by having dependencies, but no source.
if ( ! $src ) {
if ( $inline_script_tag ) {
if ( $this -> do_concat ) {
$this -> print_html .= $inline_script_tag ;
} else {
echo $inline_script_tag ;
}
}
return true ;
}
2023-09-26 10:33:34 +02:00
if ( ! preg_match ( '|^(https?:)?//|' , $src ) && ! ( $this -> content_url && str_starts_with ( $src , $this -> content_url ) ) ) {
2022-12-15 17:47:31 +01:00
$src = $this -> base_url . $src ;
}
if ( ! empty ( $ver ) ) {
$src = add_query_arg ( 'ver' , $ver , $src );
}
/** This filter is documented in wp-includes/class-wp-scripts.php */
2023-12-07 09:44:11 +01:00
$src = esc_url_raw ( apply_filters ( 'script_loader_src' , $src , $handle ) );
2022-12-15 17:47:31 +01:00
if ( ! $src ) {
return true ;
}
2023-12-07 09:44:11 +01:00
$attr = array (
'src' => $src ,
'id' => " { $handle } -js " ,
2023-09-26 10:33:34 +02:00
);
2023-12-07 09:44:11 +01:00
if ( $strategy ) {
$attr [ $strategy ] = true ;
}
if ( $intended_strategy ) {
$attr [ 'data-wp-strategy' ] = $intended_strategy ;
}
2025-12-12 13:15:55 +01:00
// Determine fetchpriority.
$original_fetchpriority = isset ( $obj -> extra [ 'fetchpriority' ] ) ? $obj -> extra [ 'fetchpriority' ] : null ;
if ( null === $original_fetchpriority || ! $this -> is_valid_fetchpriority ( $original_fetchpriority ) ) {
$original_fetchpriority = 'auto' ;
}
$actual_fetchpriority = $this -> get_highest_fetchpriority_with_dependents ( $handle );
if ( null === $actual_fetchpriority ) {
// If null, it's likely this script was not explicitly enqueued, so in this case use the original priority.
$actual_fetchpriority = $original_fetchpriority ;
}
if ( is_string ( $actual_fetchpriority ) && 'auto' !== $actual_fetchpriority ) {
$attr [ 'fetchpriority' ] = $actual_fetchpriority ;
}
if ( $original_fetchpriority !== $actual_fetchpriority ) {
$attr [ 'data-wp-fetchpriority' ] = $original_fetchpriority ;
}
$tag = $translations . $before_script ;
2023-12-07 09:44:11 +01:00
$tag .= wp_get_script_tag ( $attr );
2025-12-12 13:15:55 +01:00
$tag .= $after_script ;
2022-12-15 17:47:31 +01:00
/**
* Filters the HTML script tag of an enqueued script .
*
* @ since 4.1 . 0
*
* @ param string $tag The `<script>` tag for the enqueued script .
* @ param string $handle The script ' s registered handle .
* @ param string $src The script ' s source URL .
*/
$tag = apply_filters ( 'script_loader_tag' , $tag , $handle , $src );
if ( $this -> do_concat ) {
$this -> print_html .= $tag ;
} else {
echo $tag ;
}
return true ;
}
/**
* Adds extra code to a registered script .
*
* @ since 4.5 . 0
*
* @ param string $handle Name of the script to add the inline script to .
* Must be lowercase .
* @ param string $data String containing the JavaScript to be added .
* @ param string $position Optional . Whether to add the inline script
* before the handle or after . Default 'after' .
* @ return bool True on success , false on failure .
*/
public function add_inline_script ( $handle , $data , $position = 'after' ) {
if ( ! $data ) {
return false ;
}
if ( 'after' !== $position ) {
$position = 'before' ;
}
$script = ( array ) $this -> get_data ( $handle , $position );
$script [] = $data ;
return $this -> add_data ( $handle , $position , $script );
}
/**
* Prints inline scripts registered for a specific handle .
*
* @ since 4.5 . 0
2023-09-26 10:33:34 +02:00
* @ deprecated 6.3 . 0 Use methods get_inline_script_tag () or get_inline_script_data () instead .
2022-12-15 17:47:31 +01:00
*
2023-09-26 10:33:34 +02:00
* @ param string $handle Name of the script to print inline scripts for .
2022-12-15 17:47:31 +01:00
* Must be lowercase .
* @ param string $position Optional . Whether to add the inline script
* before the handle or after . Default 'after' .
2023-09-26 10:33:34 +02:00
* @ param bool $display Optional . Whether to print the script tag
* instead of just returning the script data . Default true .
* @ return string | false Script data on success , false otherwise .
2022-12-15 17:47:31 +01:00
*/
public function print_inline_script ( $handle , $position = 'after' , $display = true ) {
2023-09-26 10:33:34 +02:00
_deprecated_function ( __METHOD__ , '6.3.0' , 'WP_Scripts::get_inline_script_data() or WP_Scripts::get_inline_script_tag()' );
2022-12-15 17:47:31 +01:00
2023-09-26 10:33:34 +02:00
$output = $this -> get_inline_script_data ( $handle , $position );
2022-12-15 17:47:31 +01:00
if ( empty ( $output ) ) {
return false ;
}
if ( $display ) {
2023-09-26 10:33:34 +02:00
echo $this -> get_inline_script_tag ( $handle , $position );
2022-12-15 17:47:31 +01:00
}
return $output ;
}
2023-09-26 10:33:34 +02:00
/**
* Gets data for inline scripts registered for a specific handle .
*
* @ since 6.3 . 0
*
* @ param string $handle Name of the script to get data for .
* Must be lowercase .
* @ param string $position Optional . Whether to add the inline script
* before the handle or after . Default 'after' .
* @ return string Inline script , which may be empty string .
*/
public function get_inline_script_data ( $handle , $position = 'after' ) {
$data = $this -> get_data ( $handle , $position );
if ( empty ( $data ) || ! is_array ( $data ) ) {
return '' ;
}
2025-12-12 13:15:55 +01:00
/*
* Print sourceURL comment regardless of concatenation .
*
* Inline scripts prevent scripts from being concatenated , so
* sourceURL comments are safe to print for inline scripts .
*/
$data [] = sprintf (
'//# sourceURL=%s' ,
rawurlencode ( " { $handle } -js- { $position } " )
);
2023-09-26 10:33:34 +02:00
return trim ( implode ( " \n " , $data ), " \n " );
}
/**
* Gets tags for inline scripts registered for a specific handle .
*
* @ since 6.3 . 0
*
* @ param string $handle Name of the script to get associated inline script tag for .
* Must be lowercase .
* @ param string $position Optional . Whether to get tag for inline
* scripts in the before or after position . Default 'after' .
* @ return string Inline script , which may be empty string .
*/
public function get_inline_script_tag ( $handle , $position = 'after' ) {
$js = $this -> get_inline_script_data ( $handle , $position );
if ( empty ( $js ) ) {
return '' ;
}
$id = " { $handle } -js- { $position } " ;
return wp_get_inline_script_tag ( $js , compact ( 'id' ) );
}
2022-12-15 17:47:31 +01:00
/**
* Localizes a script , only if the script has already been added .
*
* @ since 2.1 . 0
*
* @ param string $handle Name of the script to attach data to .
* @ param string $object_name Name of the variable that will contain the data .
* @ param array $l10n Array of data to localize .
* @ return bool True on success , false on failure .
*/
public function localize ( $handle , $object_name , $l10n ) {
if ( 'jquery' === $handle ) {
$handle = 'jquery-core' ;
}
if ( is_array ( $l10n ) && isset ( $l10n [ 'l10n_print_after' ] ) ) { // back compat, preserve the code in 'l10n_print_after' if present.
$after = $l10n [ 'l10n_print_after' ];
unset ( $l10n [ 'l10n_print_after' ] );
}
if ( ! is_array ( $l10n ) ) {
_doing_it_wrong (
__METHOD__ ,
sprintf (
/* translators: 1: $l10n, 2: wp_add_inline_script() */
__ ( 'The %1$s parameter must be an array. To pass arbitrary data to scripts, use the %2$s function instead.' ),
'<code>$l10n</code>' ,
'<code>wp_add_inline_script()</code>'
),
'5.7.0'
);
if ( false === $l10n ) {
// This should really not be needed, but is necessary for backward compatibility.
$l10n = array ( $l10n );
}
}
if ( is_string ( $l10n ) ) {
$l10n = html_entity_decode ( $l10n , ENT_QUOTES , 'UTF-8' );
} elseif ( is_array ( $l10n ) ) {
foreach ( $l10n as $key => $value ) {
if ( ! is_scalar ( $value ) ) {
continue ;
}
$l10n [ $key ] = html_entity_decode ( ( string ) $value , ENT_QUOTES , 'UTF-8' );
}
}
2025-12-12 13:15:55 +01:00
$script = " var $object_name = " . wp_json_encode ( $l10n , JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) . ';' ;
2022-12-15 17:47:31 +01:00
if ( ! empty ( $after ) ) {
$script .= " \n $after ; " ;
}
$data = $this -> get_data ( $handle , 'data' );
if ( ! empty ( $data ) ) {
$script = " $data\n $script " ;
}
return $this -> add_data ( $handle , 'data' , $script );
}
/**
* Sets handle group .
*
* @ since 2.8 . 0
*
* @ see WP_Dependencies :: set_group ()
*
* @ param string $handle Name of the item . Should be unique .
* @ param bool $recursion Internal flag that calling function was called recursively .
* @ param int | false $group Optional . Group level : level ( int ), no groups ( false ) .
* Default false .
* @ return bool Not already in the group or a lower group .
*/
public function set_group ( $handle , $recursion , $group = false ) {
if ( isset ( $this -> registered [ $handle ] -> args ) && 1 === $this -> registered [ $handle ] -> args ) {
2025-02-28 08:42:11 +01:00
$calculated_group = 1 ;
2022-12-15 17:47:31 +01:00
} else {
2025-02-28 08:42:11 +01:00
$calculated_group = ( int ) $this -> get_data ( $handle , 'group' );
2022-12-15 17:47:31 +01:00
}
2025-02-28 08:42:11 +01:00
if ( false !== $group && $calculated_group > $group ) {
$calculated_group = $group ;
2022-12-15 17:47:31 +01:00
}
2025-02-28 08:42:11 +01:00
return parent :: set_group ( $handle , $recursion , $calculated_group );
2022-12-15 17:47:31 +01:00
}
/**
* Sets a translation textdomain .
*
* @ since 5.0 . 0
* @ since 5.1 . 0 The `$domain` parameter was made optional .
*
* @ param string $handle Name of the script to register a translation domain to .
* @ param string $domain Optional . Text domain . Default 'default' .
* @ param string $path Optional . The full file path to the directory containing translation files .
* @ return bool True if the text domain was registered , false if not .
*/
public function set_translations ( $handle , $domain = 'default' , $path = '' ) {
if ( ! isset ( $this -> registered [ $handle ] ) ) {
return false ;
}
/** @var \_WP_Dependency $obj */
$obj = $this -> registered [ $handle ];
if ( ! in_array ( 'wp-i18n' , $obj -> deps , true ) ) {
$obj -> deps [] = 'wp-i18n' ;
}
return $obj -> set_translations ( $domain , $path );
}
/**
* Prints translations set for a specific handle .
*
* @ since 5.0 . 0
*
* @ param string $handle Name of the script to add the inline script to .
* Must be lowercase .
* @ param bool $display Optional . Whether to print the script
* instead of just returning it . Default true .
* @ return string | false Script on success , false otherwise .
*/
public function print_translations ( $handle , $display = true ) {
if ( ! isset ( $this -> registered [ $handle ] ) || empty ( $this -> registered [ $handle ] -> textdomain ) ) {
return false ;
}
$domain = $this -> registered [ $handle ] -> textdomain ;
$path = '' ;
if ( isset ( $this -> registered [ $handle ] -> translations_path ) ) {
$path = $this -> registered [ $handle ] -> translations_path ;
}
$json_translations = load_script_textdomain ( $handle , $domain , $path );
if ( ! $json_translations ) {
return false ;
}
$output = <<< JS
( function ( domain , translations ) {
var localeData = translations . locale_data [ domain ] || translations . locale_data . messages ;
localeData [ " " ] . domain = domain ;
wp . i18n . setLocaleData ( localeData , domain );
} )( " { $domain } " , { $json_translations } );
JS ;
if ( $display ) {
2025-12-12 13:15:55 +01:00
$source_url = rawurlencode ( " { $handle } -js-translations " );
$output .= " \n //# sourceURL= { $source_url } " ;
2023-12-07 09:44:11 +01:00
wp_print_inline_script_tag ( $output , array ( 'id' => " { $handle } -js-translations " ) );
2022-12-15 17:47:31 +01:00
}
return $output ;
}
/**
* Determines script dependencies .
*
* @ since 2.1 . 0
*
* @ see WP_Dependencies :: all_deps ()
*
* @ param string | string [] $handles Item handle ( string ) or item handles ( array of strings ) .
* @ param bool $recursion Optional . Internal flag that function is calling itself .
* Default false .
* @ param int | false $group Optional . Group level : level ( int ), no groups ( false ) .
* Default false .
* @ return bool True on success , false on failure .
*/
public function all_deps ( $handles , $recursion = false , $group = false ) {
2025-02-28 08:42:11 +01:00
$result = parent :: all_deps ( $handles , $recursion , $group );
2022-12-15 17:47:31 +01:00
if ( ! $recursion ) {
/**
* Filters the list of script dependencies left to print .
*
* @ since 2.3 . 0
*
* @ param string [] $to_do An array of script dependency handles .
*/
$this -> to_do = apply_filters ( 'print_scripts_array' , $this -> to_do );
}
2025-02-28 08:42:11 +01:00
return $result ;
2022-12-15 17:47:31 +01:00
}
/**
* Processes items and dependencies for the head group .
*
* @ since 2.8 . 0
*
* @ see WP_Dependencies :: do_items ()
*
* @ return string [] Handles of items that have been processed .
*/
public function do_head_items () {
$this -> do_items ( false , 0 );
return $this -> done ;
}
/**
* Processes items and dependencies for the footer group .
*
* @ since 2.8 . 0
*
* @ see WP_Dependencies :: do_items ()
*
* @ return string [] Handles of items that have been processed .
*/
public function do_footer_items () {
$this -> do_items ( false , 1 );
return $this -> done ;
}
/**
* Whether a handle ' s source is in a default directory .
*
* @ since 2.8 . 0
*
* @ param string $src The source of the enqueued script .
* @ return bool True if found , false if not .
*/
public function in_default_dir ( $src ) {
if ( ! $this -> default_dirs ) {
return true ;
}
2023-09-26 10:33:34 +02:00
if ( str_starts_with ( $src , '/' . WPINC . '/js/l10n' ) ) {
2022-12-15 17:47:31 +01:00
return false ;
}
foreach ( ( array ) $this -> default_dirs as $test ) {
2023-09-26 10:33:34 +02:00
if ( str_starts_with ( $src , $test ) ) {
2022-12-15 17:47:31 +01:00
return true ;
}
}
return false ;
}
2023-09-26 10:33:34 +02:00
/**
* This overrides the add_data method from WP_Dependencies , to support normalizing of $args .
*
* @ since 6.3 . 0
*
* @ param string $handle Name of the item . Should be unique .
* @ param string $key The data key .
* @ param mixed $value The data value .
* @ return bool True on success , false on failure .
*/
public function add_data ( $handle , $key , $value ) {
if ( ! isset ( $this -> registered [ $handle ] ) ) {
return false ;
}
2025-12-12 13:15:55 +01:00
if ( 'conditional' === $key ) {
// If a dependency is declared by a conditional script, remove it.
$this -> registered [ $handle ] -> deps = array ();
}
2023-09-26 10:33:34 +02:00
if ( 'strategy' === $key ) {
if ( ! empty ( $value ) && ! $this -> is_delayed_strategy ( $value ) ) {
_doing_it_wrong (
__METHOD__ ,
sprintf (
/* translators: 1: $strategy, 2: $handle */
__ ( 'Invalid strategy `%1$s` defined for `%2$s` during script registration.' ),
$value ,
$handle
),
'6.3.0'
);
return false ;
} elseif ( ! $this -> registered [ $handle ] -> src && $this -> is_delayed_strategy ( $value ) ) {
_doing_it_wrong (
__METHOD__ ,
sprintf (
/* translators: 1: $strategy, 2: $handle */
__ ( 'Cannot supply a strategy `%1$s` for script `%2$s` because it is an alias (it lacks a `src` value).' ),
$value ,
$handle
),
'6.3.0'
);
return false ;
}
2025-12-12 13:15:55 +01:00
} elseif ( 'fetchpriority' === $key ) {
if ( empty ( $value ) ) {
$value = 'auto' ;
}
if ( ! $this -> is_valid_fetchpriority ( $value ) ) {
_doing_it_wrong (
__METHOD__ ,
sprintf (
/* translators: 1: $fetchpriority, 2: $handle */
__ ( 'Invalid fetchpriority `%1$s` defined for `%2$s` during script registration.' ),
is_string ( $value ) ? $value : gettype ( $value ),
$handle
),
'6.9.0'
);
return false ;
} elseif ( ! $this -> registered [ $handle ] -> src ) {
_doing_it_wrong (
__METHOD__ ,
sprintf (
/* translators: 1: $fetchpriority, 2: $handle */
__ ( 'Cannot supply a fetchpriority `%1$s` for script `%2$s` because it is an alias (it lacks a `src` value).' ),
is_string ( $value ) ? $value : gettype ( $value ),
$handle
),
'6.9.0'
);
return false ;
}
2023-09-26 10:33:34 +02:00
}
return parent :: add_data ( $handle , $key , $value );
}
/**
* Gets all dependents of a script .
*
2025-12-12 13:15:55 +01:00
* This is not recursive .
*
2023-09-26 10:33:34 +02:00
* @ since 6.3 . 0
*
* @ param string $handle The script handle .
* @ return string [] Script handles .
*/
private function get_dependents ( $handle ) {
// Check if dependents map for the handle in question is present. If so, use it.
if ( isset ( $this -> dependents_map [ $handle ] ) ) {
return $this -> dependents_map [ $handle ];
}
$dependents = array ();
// Iterate over all registered scripts, finding dependents of the script passed to this method.
foreach ( $this -> registered as $registered_handle => $args ) {
if ( in_array ( $handle , $args -> deps , true ) ) {
$dependents [] = $registered_handle ;
}
}
// Add the handles dependents to the map to ease future lookups.
$this -> dependents_map [ $handle ] = $dependents ;
return $dependents ;
}
/**
* Checks if the strategy passed is a valid delayed ( non - blocking ) strategy .
*
* @ since 6.3 . 0
*
2025-12-12 13:15:55 +01:00
* @ param string | mixed $strategy The strategy to check .
2023-09-26 10:33:34 +02:00
* @ return bool True if $strategy is one of the delayed strategies , otherwise false .
*/
2025-12-12 13:15:55 +01:00
private function is_delayed_strategy ( $strategy ) : bool {
2023-09-26 10:33:34 +02:00
return in_array (
$strategy ,
$this -> delayed_strategies ,
true
);
}
2025-12-12 13:15:55 +01:00
/**
* Checks if the provided fetchpriority is valid .
*
* @ since 6.9 . 0
*
* @ param string | mixed $priority Fetch priority .
* @ return bool Whether valid fetchpriority .
*/
private function is_valid_fetchpriority ( $priority ) : bool {
return in_array ( $priority , array ( 'auto' , 'low' , 'high' ), true );
}
2023-09-26 10:33:34 +02:00
/**
* Gets the best eligible loading strategy for a script .
*
* @ since 6.3 . 0
*
* @ param string $handle The script handle .
* @ return string The best eligible loading strategy .
*/
private function get_eligible_loading_strategy ( $handle ) {
2025-02-28 08:42:11 +01:00
$intended_strategy = ( string ) $this -> get_data ( $handle , 'strategy' );
2023-09-26 10:33:34 +02:00
// Bail early if there is no intended strategy.
2025-02-28 08:42:11 +01:00
if ( ! $intended_strategy ) {
2023-09-26 10:33:34 +02:00
return '' ;
}
/*
* If the intended strategy is 'defer' , limit the initial list of eligible
* strategies , since 'async' can fallback to 'defer' , but not vice - versa .
*/
2025-02-28 08:42:11 +01:00
$initial_strategy = ( 'defer' === $intended_strategy ) ? array ( 'defer' ) : null ;
2023-09-26 10:33:34 +02:00
2025-02-28 08:42:11 +01:00
$eligible_strategies = $this -> filter_eligible_strategies ( $handle , $initial_strategy );
2023-09-26 10:33:34 +02:00
// Return early once we know the eligible strategy is blocking.
2025-02-28 08:42:11 +01:00
if ( empty ( $eligible_strategies ) ) {
2023-09-26 10:33:34 +02:00
return '' ;
}
2025-02-28 08:42:11 +01:00
return in_array ( 'async' , $eligible_strategies , true ) ? 'async' : 'defer' ;
2023-09-26 10:33:34 +02:00
}
/**
* Filter the list of eligible loading strategies for a script .
*
* @ since 6.3 . 0
*
2025-12-12 13:15:55 +01:00
* @ 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 .
* @ param array < string , string [] > $stored_results Optional . An array of already computed eligible loading strategies by handle , used to increase performance in large dependency lists .
2023-09-26 10:33:34 +02:00
* @ return string [] A list of eligible loading strategies that could be used .
*/
2025-12-12 13:15:55 +01:00
private function filter_eligible_strategies ( $handle , $eligible_strategies = null , $checked = array (), array & $stored_results = array () ) {
if ( isset ( $stored_results [ $handle ] ) ) {
return $stored_results [ $handle ];
}
2023-09-26 10:33:34 +02:00
// If no strategies are being passed, all strategies are eligible.
2025-02-28 08:42:11 +01:00
if ( null === $eligible_strategies ) {
$eligible_strategies = $this -> delayed_strategies ;
2023-09-26 10:33:34 +02:00
}
// If this handle was already checked, return early.
if ( isset ( $checked [ $handle ] ) ) {
2025-02-28 08:42:11 +01:00
return $eligible_strategies ;
2023-09-26 10:33:34 +02:00
}
// Mark this handle as checked.
$checked [ $handle ] = true ;
// If this handle isn't registered, don't filter anything and return.
if ( ! isset ( $this -> registered [ $handle ] ) ) {
2025-02-28 08:42:11 +01:00
return $eligible_strategies ;
2023-09-26 10:33:34 +02:00
}
// If the handle is not enqueued, don't filter anything and return.
if ( ! $this -> query ( $handle , 'enqueued' ) ) {
2025-02-28 08:42:11 +01:00
return $eligible_strategies ;
2023-09-26 10:33:34 +02:00
}
2023-12-07 09:44:11 +01:00
$is_alias = ( bool ) ! $this -> registered [ $handle ] -> src ;
2023-09-26 10:33:34 +02:00
$intended_strategy = $this -> get_data ( $handle , 'strategy' );
// For non-alias handles, an empty intended strategy filters all strategies.
if ( ! $is_alias && empty ( $intended_strategy ) ) {
return array ();
}
// Handles with inline scripts attached in the 'after' position cannot be delayed.
if ( $this -> has_inline_script ( $handle , 'after' ) ) {
return array ();
}
// If the intended strategy is 'defer', filter out 'async'.
if ( 'defer' === $intended_strategy ) {
2025-02-28 08:42:11 +01:00
$eligible_strategies = array ( 'defer' );
2023-09-26 10:33:34 +02:00
}
$dependents = $this -> get_dependents ( $handle );
// Recursively filter eligible strategies for dependents.
foreach ( $dependents as $dependent ) {
// Bail early once we know the eligible strategy is blocking.
2025-02-28 08:42:11 +01:00
if ( empty ( $eligible_strategies ) ) {
2023-09-26 10:33:34 +02:00
return array ();
}
2025-12-12 13:15:55 +01:00
$eligible_strategies = $this -> filter_eligible_strategies ( $dependent , $eligible_strategies , $checked , $stored_results );
2023-09-26 10:33:34 +02:00
}
2025-12-12 13:15:55 +01:00
$stored_results [ $handle ] = $eligible_strategies ;
2025-02-28 08:42:11 +01:00
return $eligible_strategies ;
2023-09-26 10:33:34 +02:00
}
2025-12-12 13:15:55 +01:00
/**
* Gets the highest fetch priority for a given script and all of its dependent scripts .
*
* @ since 6.9 . 0
* @ see self :: filter_eligible_strategies ()
2026-03-31 11:30:59 +02:00
* @ see WP_Script_Modules :: get_highest_fetchpriority ()
2025-12-12 13:15:55 +01:00
*
* @ param string $handle Script module ID .
* @ param array < string , true > $checked Optional . An array of already checked script handles , used to avoid recursive loops .
* @ param array < string , string > $stored_results Optional . An array of already computed max priority by handle , used to increase performance in large dependency lists .
* @ return string | null Highest fetch priority for the script and its dependents .
*/
private function get_highest_fetchpriority_with_dependents ( string $handle , array $checked = array (), array & $stored_results = array () ) : ? string {
if ( isset ( $stored_results [ $handle ] ) ) {
return $stored_results [ $handle ];
}
// If there is a recursive dependency, return early.
if ( isset ( $checked [ $handle ] ) ) {
return null ;
}
// Mark this handle as checked to guard against infinite recursion.
$checked [ $handle ] = true ;
// Abort if the script is not enqueued or a dependency of an enqueued script.
if ( ! $this -> query ( $handle , 'enqueued' ) ) {
return null ;
}
$fetchpriority = $this -> get_data ( $handle , 'fetchpriority' );
if ( ! $this -> is_valid_fetchpriority ( $fetchpriority ) ) {
$fetchpriority = 'auto' ;
}
static $priorities = array (
'low' ,
'auto' ,
'high' ,
);
$high_priority_index = count ( $priorities ) - 1 ;
$highest_priority_index = ( int ) array_search ( $fetchpriority , $priorities , true );
if ( $highest_priority_index !== $high_priority_index ) {
foreach ( $this -> get_dependents ( $handle ) as $dependent_handle ) {
$dependent_priority = $this -> get_highest_fetchpriority_with_dependents ( $dependent_handle , $checked , $stored_results );
if ( is_string ( $dependent_priority ) ) {
$highest_priority_index = max (
$highest_priority_index ,
( int ) array_search ( $dependent_priority , $priorities , true )
);
if ( $highest_priority_index === $high_priority_index ) {
break ;
}
}
}
}
$stored_results [ $handle ] = $priorities [ $highest_priority_index ]; // @phpstan-ignore parameterByRef.type (We know the index is valid and that this will be a string.)
return $priorities [ $highest_priority_index ];
}
2023-09-26 10:33:34 +02:00
/**
* Gets data for inline scripts registered for a specific handle .
*
* @ since 6.3 . 0
*
* @ param string $handle Name of the script to get data for . Must be lowercase .
* @ param string $position The position of the inline script .
* @ return bool Whether the handle has an inline script ( either before or after ) .
*/
private function has_inline_script ( $handle , $position = null ) {
if ( $position && in_array ( $position , array ( 'before' , 'after' ), true ) ) {
return ( bool ) $this -> get_data ( $handle , $position );
}
return ( bool ) ( $this -> get_data ( $handle , 'before' ) || $this -> get_data ( $handle , 'after' ) );
}
2022-12-15 17:47:31 +01:00
/**
* Resets class properties .
*
* @ since 2.8 . 0
*/
public function reset () {
$this -> do_concat = false ;
$this -> print_code = '' ;
$this -> concat = '' ;
$this -> concat_version = '' ;
$this -> print_html = '' ;
$this -> ext_version = '' ;
$this -> ext_handles = '' ;
}
2026-03-31 11:30:59 +02:00
/**
* Gets a script - specific dependency warning message .
*
* @ since 6.9 . 1
*
* @ param string $handle Script handle with missing dependencies .
* @ param string [] $missing_dependency_handles Missing dependency handles .
* @ return string Formatted , localized warning message .
*/
protected function get_dependency_warning_message ( $handle , $missing_dependency_handles ) {
return sprintf (
/* translators: 1: Script handle, 2: List of missing dependency handles. */
__ ( 'The script with the handle "%1$s" was enqueued with dependencies that are not registered: %2$s.' ),
$handle ,
implode ( wp_get_list_item_separator (), $missing_dependency_handles )
);
}
2022-12-15 17:47:31 +01:00
}