X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/d3b1ea255664edd2deef17f900a655613d20820d..607b7e02d77e7326161e8ec15639052d2040f745:/wp-includes/functions.wp-scripts.php diff --git a/wp-includes/functions.wp-scripts.php b/wp-includes/functions.wp-scripts.php index 0a60c968..767d995d 100644 --- a/wp-includes/functions.wp-scripts.php +++ b/wp-includes/functions.wp-scripts.php @@ -1,67 +1,192 @@ wp_enqueue_scripts', + 'admin_enqueue_scripts', + 'login_enqueue_scripts' + ), '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_items() + * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts. * - * Called by admin-header.php and by 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. Does make use of already - * instantiated $wp_scripts if present. Use provided wp_print_scripts hook to - * register/enqueue new scripts. + * @since 2.1.0 * - * @since r16 - * @see WP_Dependencies::print_scripts() + * @param string|bool|array $handles Optional. Scripts to be printed. Default 'false'. + * @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array. */ function wp_print_scripts( $handles = false ) { + /** + * Fires before scripts in the $handles queue are printed. + * + * @since 2.1.0 + */ do_action( 'wp_print_scripts' ); - if ( '' === $handles ) // for wp_head + if ( '' === $handles ) { // for wp_head $handles = false; + } + + _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ ); global $wp_scripts; - if ( !is_a($wp_scripts, 'WP_Scripts') ) { - if ( !$handles ) - return array(); // No need to instantiate if nothing's there. - else - $wp_scripts = new WP_Scripts(); + 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 in 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__ ); + + if ( false !== stripos( $data, '' ) ) { + _doing_it_wrong( __FUNCTION__, sprintf( + /* translators: 1: #is', '$1', $data ) ); } - return $wp_scripts->do_items( $handles ); + return wp_scripts()->add_inline_script( $handle, $data, $position ); } /** - * Register new JavaScript file. + * Register 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 r16 - * @see WP_Dependencies::add() For parameter information. + * @since 2.1.0 + * @since 4.3.0 A return value was added. + * + * @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. + * @param array $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 bool $in_footer Optional. Whether to enqueue the script before instead of in the . + * 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, $in_footer = false ) { - global $wp_scripts; - if ( !is_a($wp_scripts, 'WP_Scripts') ) - $wp_scripts = new WP_Scripts(); + $wp_scripts = wp_scripts(); + _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ ); - $wp_scripts->add( $handle, $src, $deps, $ver ); - if ( $in_footer ) + $registered = $wp_scripts->add( $handle, $src, $deps, $ver ); + if ( $in_footer ) { $wp_scripts->add_data( $handle, 'group', 1 ); + } + + return $registered; } /** - * Localizes a script. + * Localize a script. * - * Localizes only if script has already been added. + * Works only if the script has already been added. * - * @since r16 - * @see WP_Script::localize() + * Accepts an associative array $l10n and creates a JavaScript object: + * + * "$object_name" = { + * key: value, + * key: value, + * ... + * } + * + * + * @see WP_Dependencies::localize() + * @link https://core.trac.wordpress.org/ticket/11520 + * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts. + * + * @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 ) { global $wp_scripts; - if ( !is_a($wp_scripts, 'WP_Scripts') ) + if ( ! ( $wp_scripts instanceof WP_Scripts ) ) { + _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ ); return false; + } return $wp_scripts->localize( $handle, $object_name, $l10n ); } @@ -69,60 +194,137 @@ function wp_localize_script( $handle, $object_name, $l10n ) { /** * Remove a registered script. * - * @since r16 - * @see WP_Scripts::remove() For parameter information. + * 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 + * + * @param string $handle Name of the script to be removed. */ function wp_deregister_script( $handle ) { - global $wp_scripts; - if ( !is_a($wp_scripts, 'WP_Scripts') ) - $wp_scripts = new WP_Scripts(); + _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ ); + + /** + * 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' === $GLOBALS['pagenow'] && 'login_enqueue_scripts' !== $current_filter ) + ) { + $no = 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', + ); - $wp_scripts->remove( $handle ); + if ( in_array( $handle, $no ) ) { + $message = sprintf( __( 'Do not deregister the %1$s script in the administration area. To target the front-end theme, use the %2$s hook.' ), + "$handle", 'wp_enqueue_scripts' ); + _doing_it_wrong( __FUNCTION__, $message, '3.6.0' ); + return; + } + } + + wp_scripts()->remove( $handle ); } /** - * Enqueues script. + * Enqueue a script. + * + * Registers the script if $src provided (does NOT overwrite), and enqueues it. * - * Registers the script if src provided (does NOT overwrite) and enqueues. + * @see WP_Dependencies::add() + * @see WP_Dependencies::add_data() + * @see WP_Dependencies::enqueue() * - * @since r16 - * @see WP_Script::add(), WP_Script::enqueue() -*/ + * @since 2.1.0 + * + * @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. + * @param array $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 bool $in_footer Optional. Whether to enqueue the script before instead of in the . + * Default 'false'. + */ function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) { - global $wp_scripts; - if ( !is_a($wp_scripts, 'WP_Scripts') ) - $wp_scripts = new WP_Scripts(); + $wp_scripts = wp_scripts(); + + _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ ); - if ( $src ) { - $_handle = explode('?', $handle); - $wp_scripts->add( $_handle[0], $src, $deps, $ver ); - if ( $in_footer ) + + if ( $src || $in_footer ) { + $_handle = explode( '?', $handle ); + + if ( $src ) { + $wp_scripts->add( $_handle[0], $src, $deps, $ver ); + } + + if ( $in_footer ) { $wp_scripts->add_data( $_handle[0], 'group', 1 ); + } } + $wp_scripts->enqueue( $handle ); } /** - * Check whether script has been added to WordPress Scripts. + * Remove a previously enqueued script. * - * The values for list defaults to 'queue', which is the same as enqueue for - * scripts. + * @see WP_Dependencies::dequeue() * - * @since WP unknown; BP unknown + * @since 3.1.0 * - * @param string $handle Handle used to add script. - * @param string $list Optional, defaults to 'queue'. Others values are 'registered', 'queue', 'done', 'to_do' - * @return bool + * @param string $handle Name of the script to be removed. */ -function wp_script_is( $handle, $list = 'queue' ) { - global $wp_scripts; - if ( !is_a($wp_scripts, 'WP_Scripts') ) - $wp_scripts = new WP_Scripts(); +function wp_dequeue_script( $handle ) { + _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ ); + + wp_scripts()->dequeue( $handle ); +} - $query = $wp_scripts->query( $handle, $list ); +/** + * Check whether a script has been added to the queue. + * + * @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 $list 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__ ); - if ( is_object( $query ) ) - return true; + return (bool) wp_scripts()->query( $handle, $list ); +} - return $query; +/** + * Add metadata to a script. + * + * Works only if the script has already been added. + * + * Possible values for $key and $value: + * 'conditional' string Comments for IE 6, lte IE 7, etc. + * + * @since 4.2.0 + * + * @see WP_Dependency::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 ); }