<?php
/**
- * BackPress script procedural API.
+ * BackPress Scripts Procedural API
*
- * @package BackPress
- * @since r16
+ * @since 2.6.0
+ *
+ * @package WordPress
+ * @subpackage BackPress
*/
/**
- * Prints script tags in document head.
+ * Initialize $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.
*
- * 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.
+ * @ignore
+ * @since 4.2.0
*
- * @since r16
- * @see WP_Dependencies::print_scripts()
+ * @param string $function Function name.
+ */
+function _wp_scripts_maybe_doing_it_wrong( $function ) {
+ if ( did_action( 'init' ) ) {
+ return;
+ }
+
+ _doing_it_wrong( $function, sprintf(
+ __( '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>'
+ ), '3.3' );
+}
+
+/**
+ * Print scripts in document head that are in the $handles queue.
+ *
+ * Called by admin-header.php and 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 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.
+ *
+ * @since 2.6.0
+ *
+ * @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 );
+ return wp_scripts()->do_items( $handles );
}
/**
- * Register new JavaScript file.
- *
- * @since r16
- * @param string $handle Script name
- * @param string $src Script url
- * @param array $deps (optional) Array of script names on which this script depends
- * @param string|bool $ver (optional) Script version (used for cache busting), set to NULL to disable
- * @param bool $in_footer (optional) Whether to enqueue the script before </head> or before </body>
- * @return null
+ * Register a new script.
+ *
+ * Registers a script to be linked later using the wp_enqueue_script() function.
+ *
+ * @see WP_Dependencies::add(), WP_Dependencies::add_data()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.6.0
+ *
+ * @param string $handle Name of the script. Should be unique.
+ * @param string $src Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
+ * @param array $deps Optional. An array of registered script handles this script depends on. Set to false if there
+ * are no dependencies. Default empty array.
+ * @param string|bool $ver Optional. String specifying script version number, if it has one, which is concatenated
+ * to end of path as a query string. If no version is specified or set to false, a version
+ * number is automatically added equal to current installed WordPress version.
+ * If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
+ * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
+ * Default 'false'. Accepts 'false' or 'true'.
*/
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 )
+ if ( $in_footer ) {
$wp_scripts->add_data( $handle, 'group', 1 );
+ }
}
/**
- * Localizes a script.
+ * Localize a script.
+ *
+ * Works only if the script has already been added.
+ *
+ * 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.
*
- * Localizes only if script has already been added.
+ * @since 2.6.0
*
- * @since r16
- * @see WP_Scripts::localize()
+ * @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 );
+ return wp_scripts()->localize( $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()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.6.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',
+ );
+
+ if ( in_array( $handle, $no ) ) {
+ $message = sprintf( __( 'Do not deregister the %1$s script in the administration area. To target the frontend theme, use the %2$s hook.' ),
+ "<code>$handle</code>", '<code>wp_enqueue_scripts</code>' );
+ _doing_it_wrong( __FUNCTION__, $message, '3.6' );
+ return;
+ }
+ }
- $wp_scripts->remove( $handle );
+ wp_scripts()->remove( $handle );
}
/**
- * Enqueues script.
+ * Enqueue a script.
+ *
+ * Registers the script if $src provided (does NOT overwrite), and enqueues it.
+ *
+ * @see WP_Dependencies::add(), WP_Dependencies::add_data(), WP_Dependencies::enqueue()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
*
- * Registers the script if src provided (does NOT overwrite) and enqueues.
+ * @since 2.6.0
*
- * @since r16
- * @see wp_register_script() For parameter information.
+ * @param string $handle Name of the script.
+ * @param string|bool $src Path to the script from the root directory of WordPress. Example: '/js/myscript.js'.
+ * @param array $deps An array of registered handles this script depends on. Default empty array.
+ * @param string|bool $ver Optional. String specifying the script version number, if it has one. This parameter
+ * is used to ensure that the correct version is sent to the client regardless of caching,
+ * and so should be included if a version number is available and makes sense for the script.
+ * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
+ * Default 'false'. Accepts 'false' or 'true'.
*/
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 || $in_footer ) {
+ $_handle = explode( '?', $handle );
+
+ if ( $src ) {
+ $wp_scripts->add( $_handle[0], $src, $deps, $ver );
+ }
- if ( $src ) {
- $_handle = explode('?', $handle);
- $wp_scripts->add( $_handle[0], $src, $deps, $ver );
- if ( $in_footer )
+ if ( $in_footer ) {
$wp_scripts->add_data( $_handle[0], 'group', 1 );
+ }
}
+
$wp_scripts->enqueue( $handle );
}
/**
- * Remove an enqueued script.
+ * Remove a previously enqueued script.
+ *
+ * @see WP_Dependencies::dequeue()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 3.1.0
*
- * @since WP 3.1
- * @see WP_Scripts::dequeue() For parameter information.
+ * @param string $handle Name of the script to be removed.
*/
function wp_dequeue_script( $handle ) {
- global $wp_scripts;
- if ( !is_a($wp_scripts, 'WP_Scripts') )
- $wp_scripts = new WP_Scripts();
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- $wp_scripts->dequeue( $handle );
+ wp_scripts()->dequeue( $handle );
}
/**
- * Check whether script has been added to WordPress Scripts.
+ * Check whether a script has been added to the queue.
*
- * The values for list defaults to 'queue', which is the same as enqueue for
- * scripts.
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
*
- * @since WP unknown; BP unknown
+ * @since 2.8.0
+ * @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
*
- * @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.
+ * @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 script is queued.
*/
-function wp_script_is( $handle, $list = 'queue' ) {
- global $wp_scripts;
- if ( !is_a($wp_scripts, 'WP_Scripts') )
- $wp_scripts = new WP_Scripts();
+function wp_script_is( $handle, $list = 'enqueued' ) {
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
- $query = $wp_scripts->query( $handle, $list );
-
- 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 ){
+ global $wp_scripts;
+ return $wp_scripts->add_data( $handle, $key, $value );
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff