mirror of
https://github.com/WordPress/WordPress.git
synced 2024-06-27 07:14:57 +02:00
5d6024cefb
Before, `wp_localize_script()` did not work when the `$wp_scripts` global was not already set (for example because of a script registration happening elsewhere) and even emitted a warning in that case. Due to side effects such as block registration early in the load process, this usually never happened. However, the absence of these side effects in 6.5 caused the `wp_localize_script()` to no longer work in places such as the `login_enqueue_scripts`. By calling `wp_scripts()` in `wp_localize_script()`, the `$wp_scripts` global is automatically set if needed, restoring previous behavior. Adds both a PHP unit test and an e2e test to verify this use case. Hat tip: jorbin. Happy birthday, Aaron! Props salcode, aslamdoctor, jorbin, swissspidy. Fixes #60862. Built from https://develop.svn.wordpress.org/trunk@58068 git-svn-id: http://core.svn.wordpress.org/trunk@57533 1a063a9b-81f0-0310-95a4-ce76da25c4cd
442 lines
14 KiB
PHP
442 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* Dependencies API: Scripts functions
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Dependencies
|
|
*/
|
|
|
|
/**
|
|
* Initializes $wp_scripts if it has not been set.
|
|
*
|
|
* @global WP_Scripts $wp_scripts
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @return WP_Scripts WP_Scripts instance.
|
|
*/
|
|
function wp_scripts() {
|
|
global $wp_scripts;
|
|
|
|
if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
|
|
$wp_scripts = new WP_Scripts();
|
|
}
|
|
|
|
return $wp_scripts;
|
|
}
|
|
|
|
/**
|
|
* Helper function to output a _doing_it_wrong message when applicable.
|
|
*
|
|
* @ignore
|
|
* @since 4.2.0
|
|
* @since 5.5.0 Added the `$handle` parameter.
|
|
*
|
|
* @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' )
|
|
) {
|
|
return;
|
|
}
|
|
|
|
$message = sprintf(
|
|
/* translators: 1: wp_enqueue_scripts, 2: admin_enqueue_scripts, 3: login_enqueue_scripts */
|
|
__( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
|
|
'<code>wp_enqueue_scripts</code>',
|
|
'<code>admin_enqueue_scripts</code>',
|
|
'<code>login_enqueue_scripts</code>'
|
|
);
|
|
|
|
if ( $handle ) {
|
|
$message .= ' ' . sprintf(
|
|
/* translators: %s: Name of the script or stylesheet. */
|
|
__( 'This notice was triggered by the %s handle.' ),
|
|
'<code>' . $handle . '</code>'
|
|
);
|
|
}
|
|
|
|
_doing_it_wrong(
|
|
$function_name,
|
|
$message,
|
|
'3.3.0'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Prints scripts in document head that are in the $handles queue.
|
|
*
|
|
* Called by admin-header.php and {@see 'wp_head'} hook. Since it is called by wp_head on every page load,
|
|
* the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
|
|
* Makes use of already-instantiated `$wp_scripts` global if present. Use provided {@see 'wp_print_scripts'}
|
|
* hook to register/enqueue new scripts.
|
|
*
|
|
* @see WP_Scripts::do_item()
|
|
* @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
|
|
*
|
|
* @since 2.1.0
|
|
*
|
|
* @param string|string[]|false $handles Optional. Scripts to be printed. Default 'false'.
|
|
* @return string[] On success, an array of handles of processed WP_Dependencies items; otherwise, an empty array.
|
|
*/
|
|
function wp_print_scripts( $handles = false ) {
|
|
global $wp_scripts;
|
|
|
|
/**
|
|
* Fires before scripts in the $handles queue are printed.
|
|
*
|
|
* @since 2.1.0
|
|
*/
|
|
do_action( 'wp_print_scripts' );
|
|
|
|
if ( '' === $handles ) { // For 'wp_head'.
|
|
$handles = false;
|
|
}
|
|
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
|
|
|
|
if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
|
|
if ( ! $handles ) {
|
|
return array(); // No need to instantiate if nothing is there.
|
|
}
|
|
}
|
|
|
|
return wp_scripts()->do_items( $handles );
|
|
}
|
|
|
|
/**
|
|
* Adds extra code to a registered script.
|
|
*
|
|
* Code will only be added if the script is already in the queue.
|
|
* Accepts a string `$data` containing the code. If two or more code blocks
|
|
* are added to the same script `$handle`, they will be printed in the order
|
|
* they were added, i.e. the latter added code can redeclare the previous.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @see WP_Scripts::add_inline_script()
|
|
*
|
|
* @param string $handle Name of the script to add the inline script to.
|
|
* @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.
|
|
*/
|
|
function wp_add_inline_script( $handle, $data, $position = 'after' ) {
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
|
|
if ( false !== stripos( $data, '</script>' ) ) {
|
|
_doing_it_wrong(
|
|
__FUNCTION__,
|
|
sprintf(
|
|
/* translators: 1: <script>, 2: wp_add_inline_script() */
|
|
__( 'Do not pass %1$s tags to %2$s.' ),
|
|
'<code><script></code>',
|
|
'<code>wp_add_inline_script()</code>'
|
|
),
|
|
'4.5.0'
|
|
);
|
|
$data = trim( preg_replace( '#<script[^>]*>(.*)</script>#is', '$1', $data ) );
|
|
}
|
|
|
|
return wp_scripts()->add_inline_script( $handle, $data, $position );
|
|
}
|
|
|
|
/**
|
|
* Registers a new script.
|
|
*
|
|
* Registers a script to be enqueued later using the wp_enqueue_script() function.
|
|
*
|
|
* @see WP_Dependencies::add()
|
|
* @see WP_Dependencies::add_data()
|
|
*
|
|
* @since 2.1.0
|
|
* @since 4.3.0 A return value was added.
|
|
* @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
|
|
*
|
|
* @param string $handle Name of the script. Should be unique.
|
|
* @param string|false $src Full URL of the script, or path of the script relative to the WordPress root directory.
|
|
* If source is set to false, script is an alias of other scripts it depends on.
|
|
* @param string[] $deps Optional. An array of registered script handles this script depends on. Default empty array.
|
|
* @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
|
|
* as a query string for cache busting purposes. If version is set to false, a version
|
|
* number is automatically added equal to current installed WordPress version.
|
|
* If set to null, no version is added.
|
|
* @param array|bool $args {
|
|
* Optional. An array of additional script loading strategies. Default empty array.
|
|
* Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
|
|
*
|
|
* @type string $strategy Optional. If provided, may be either 'defer' or 'async'.
|
|
* @type bool $in_footer Optional. Whether to print the script in the footer. Default 'false'.
|
|
* }
|
|
* @return bool Whether the script has been registered. True on success, false on failure.
|
|
*/
|
|
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $args = array() ) {
|
|
if ( ! is_array( $args ) ) {
|
|
$args = array(
|
|
'in_footer' => (bool) $args,
|
|
);
|
|
}
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
|
|
$wp_scripts = wp_scripts();
|
|
|
|
$registered = $wp_scripts->add( $handle, $src, $deps, $ver );
|
|
if ( ! empty( $args['in_footer'] ) ) {
|
|
$wp_scripts->add_data( $handle, 'group', 1 );
|
|
}
|
|
if ( ! empty( $args['strategy'] ) ) {
|
|
$wp_scripts->add_data( $handle, 'strategy', $args['strategy'] );
|
|
}
|
|
return $registered;
|
|
}
|
|
|
|
/**
|
|
* Localizes a script.
|
|
*
|
|
* Works only if the script has already been registered.
|
|
*
|
|
* Accepts an associative array `$l10n` and creates a JavaScript object:
|
|
*
|
|
* "$object_name": {
|
|
* key: value,
|
|
* key: value,
|
|
* ...
|
|
* }
|
|
*
|
|
* @see WP_Scripts::localize()
|
|
* @link https://core.trac.wordpress.org/ticket/11520
|
|
*
|
|
* @since 2.2.0
|
|
*
|
|
* @todo Documentation cleanup
|
|
*
|
|
* @param string $handle Script handle the data will be attached to.
|
|
* @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
|
|
* Example: '/[a-zA-Z0-9_]+/'.
|
|
* @param array $l10n The data itself. The data can be either a single or multi-dimensional array.
|
|
* @return bool True if the script was successfully localized, false otherwise.
|
|
*/
|
|
function wp_localize_script( $handle, $object_name, $l10n ) {
|
|
$wp_scripts = wp_scripts();
|
|
|
|
return $wp_scripts->localize( $handle, $object_name, $l10n );
|
|
}
|
|
|
|
/**
|
|
* Sets translated strings for a script.
|
|
*
|
|
* Works only if the script has already been registered.
|
|
*
|
|
* @see WP_Scripts::set_translations()
|
|
* @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
|
|
*
|
|
* @since 5.0.0
|
|
* @since 5.1.0 The `$domain` parameter was made optional.
|
|
*
|
|
* @param string $handle Script handle the textdomain will be attached 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 successfully localized, false otherwise.
|
|
*/
|
|
function wp_set_script_translations( $handle, $domain = 'default', $path = '' ) {
|
|
global $wp_scripts;
|
|
|
|
if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
return false;
|
|
}
|
|
|
|
return $wp_scripts->set_translations( $handle, $domain, $path );
|
|
}
|
|
|
|
/**
|
|
* Removes a registered script.
|
|
*
|
|
* Note: there are intentional safeguards in place to prevent critical admin scripts,
|
|
* such as jQuery core, from being unregistered.
|
|
*
|
|
* @see WP_Dependencies::remove()
|
|
*
|
|
* @since 2.1.0
|
|
*
|
|
* @global string $pagenow The filename of the current screen.
|
|
*
|
|
* @param string $handle Name of the script to be removed.
|
|
*/
|
|
function wp_deregister_script( $handle ) {
|
|
global $pagenow;
|
|
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
|
|
/**
|
|
* Do not allow accidental or negligent de-registering of critical scripts in the admin.
|
|
* Show minimal remorse if the correct hook is used.
|
|
*/
|
|
$current_filter = current_filter();
|
|
if ( ( is_admin() && 'admin_enqueue_scripts' !== $current_filter ) ||
|
|
( 'wp-login.php' === $pagenow && 'login_enqueue_scripts' !== $current_filter )
|
|
) {
|
|
$not_allowed = array(
|
|
'jquery',
|
|
'jquery-core',
|
|
'jquery-migrate',
|
|
'jquery-ui-core',
|
|
'jquery-ui-accordion',
|
|
'jquery-ui-autocomplete',
|
|
'jquery-ui-button',
|
|
'jquery-ui-datepicker',
|
|
'jquery-ui-dialog',
|
|
'jquery-ui-draggable',
|
|
'jquery-ui-droppable',
|
|
'jquery-ui-menu',
|
|
'jquery-ui-mouse',
|
|
'jquery-ui-position',
|
|
'jquery-ui-progressbar',
|
|
'jquery-ui-resizable',
|
|
'jquery-ui-selectable',
|
|
'jquery-ui-slider',
|
|
'jquery-ui-sortable',
|
|
'jquery-ui-spinner',
|
|
'jquery-ui-tabs',
|
|
'jquery-ui-tooltip',
|
|
'jquery-ui-widget',
|
|
'underscore',
|
|
'backbone',
|
|
);
|
|
|
|
if ( in_array( $handle, $not_allowed, true ) ) {
|
|
_doing_it_wrong(
|
|
__FUNCTION__,
|
|
sprintf(
|
|
/* translators: 1: Script name, 2: wp_enqueue_scripts */
|
|
__( 'Do not deregister the %1$s script in the administration area. To target the front-end theme, use the %2$s hook.' ),
|
|
"<code>$handle</code>",
|
|
'<code>wp_enqueue_scripts</code>'
|
|
),
|
|
'3.6.0'
|
|
);
|
|
return;
|
|
}
|
|
}
|
|
|
|
wp_scripts()->remove( $handle );
|
|
}
|
|
|
|
/**
|
|
* Enqueues a script.
|
|
*
|
|
* Registers the script if `$src` provided (does NOT overwrite), and enqueues it.
|
|
*
|
|
* @see WP_Dependencies::add()
|
|
* @see WP_Dependencies::add_data()
|
|
* @see WP_Dependencies::enqueue()
|
|
*
|
|
* @since 2.1.0
|
|
* @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
|
|
*
|
|
* @param string $handle Name of the script. Should be unique.
|
|
* @param string $src Full URL of the script, or path of the script relative to the WordPress root directory.
|
|
* Default empty.
|
|
* @param string[] $deps Optional. An array of registered script handles this script depends on. Default empty array.
|
|
* @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
|
|
* as a query string for cache busting purposes. If version is set to false, a version
|
|
* number is automatically added equal to current installed WordPress version.
|
|
* If set to null, no version is added.
|
|
* @param array|bool $args {
|
|
* Optional. An array of additional script loading strategies. Default empty array.
|
|
* Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
|
|
*
|
|
* @type string $strategy Optional. If provided, may be either 'defer' or 'async'.
|
|
* @type bool $in_footer Optional. Whether to print the script in the footer. Default 'false'.
|
|
* }
|
|
*/
|
|
function wp_enqueue_script( $handle, $src = '', $deps = array(), $ver = false, $args = array() ) {
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
|
|
$wp_scripts = wp_scripts();
|
|
|
|
if ( $src || ! empty( $args ) ) {
|
|
$_handle = explode( '?', $handle );
|
|
if ( ! is_array( $args ) ) {
|
|
$args = array(
|
|
'in_footer' => (bool) $args,
|
|
);
|
|
}
|
|
|
|
if ( $src ) {
|
|
$wp_scripts->add( $_handle[0], $src, $deps, $ver );
|
|
}
|
|
if ( ! empty( $args['in_footer'] ) ) {
|
|
$wp_scripts->add_data( $_handle[0], 'group', 1 );
|
|
}
|
|
if ( ! empty( $args['strategy'] ) ) {
|
|
$wp_scripts->add_data( $_handle[0], 'strategy', $args['strategy'] );
|
|
}
|
|
}
|
|
|
|
$wp_scripts->enqueue( $handle );
|
|
}
|
|
|
|
/**
|
|
* Removes a previously enqueued script.
|
|
*
|
|
* @see WP_Dependencies::dequeue()
|
|
*
|
|
* @since 3.1.0
|
|
*
|
|
* @param string $handle Name of the script to be removed.
|
|
*/
|
|
function wp_dequeue_script( $handle ) {
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
|
|
wp_scripts()->dequeue( $handle );
|
|
}
|
|
|
|
/**
|
|
* Determines whether a script has been added to the queue.
|
|
*
|
|
* For more information on this and similar theme functions, check out
|
|
* the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
|
|
* Conditional Tags} article in the Theme Developer Handbook.
|
|
*
|
|
* @since 2.8.0
|
|
* @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
|
|
*
|
|
* @param string $handle Name of the script.
|
|
* @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, $status = 'enqueued' ) {
|
|
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
|
|
|
|
return (bool) wp_scripts()->query( $handle, $status );
|
|
}
|
|
|
|
/**
|
|
* Adds metadata to a script.
|
|
*
|
|
* Works only if the script has already been registered.
|
|
*
|
|
* Possible values for $key and $value:
|
|
* 'conditional' string Comments for IE 6, lte IE 7, etc.
|
|
*
|
|
* @since 4.2.0
|
|
*
|
|
* @see WP_Dependencies::add_data()
|
|
*
|
|
* @param string $handle Name of the script.
|
|
* @param string $key Name of data point for which we're storing a value.
|
|
* @param mixed $value String containing the data to be added.
|
|
* @return bool True on success, false on failure.
|
|
*/
|
|
function wp_script_add_data( $handle, $key, $value ) {
|
|
return wp_scripts()->add_data( $handle, $key, $value );
|
|
}
|