3 * BackPress Scripts Procedural API
8 * @subpackage BackPress
12 * Initialize $wp_scripts if it has not been set.
14 * @global WP_Scripts $wp_scripts
18 * @return WP_Scripts WP_Scripts instance.
20 function wp_scripts() {
22 if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
23 $wp_scripts = new WP_Scripts();
29 * Helper function to output a _doing_it_wrong message when applicable.
34 * @param string $function Function name.
36 function _wp_scripts_maybe_doing_it_wrong( $function ) {
37 if ( did_action( 'init' ) ) {
41 _doing_it_wrong( $function, sprintf(
42 __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
43 '<code>wp_enqueue_scripts</code>',
44 '<code>admin_enqueue_scripts</code>',
45 '<code>login_enqueue_scripts</code>'
50 * Print scripts in document head that are in the $handles queue.
52 * Called by admin-header.php and wp_head hook. Since it is called by wp_head on every page load,
53 * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
54 * Makes use of already-instantiated $wp_scripts global if present. Use provided wp_print_scripts
55 * hook to register/enqueue new scripts.
57 * @see WP_Scripts::do_items()
58 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
62 * @param string|bool|array $handles Optional. Scripts to be printed. Default 'false'.
63 * @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array.
65 function wp_print_scripts( $handles = false ) {
67 * Fires before scripts in the $handles queue are printed.
71 do_action( 'wp_print_scripts' );
72 if ( '' === $handles ) { // for wp_head
76 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
79 if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
81 return array(); // No need to instantiate if nothing is there.
85 return wp_scripts()->do_items( $handles );
89 * Register a new script.
91 * Registers a script to be linked later using the wp_enqueue_script() function.
93 * @see WP_Dependencies::add(), WP_Dependencies::add_data()
94 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
98 * @param string $handle Name of the script. Should be unique.
99 * @param string $src Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
100 * @param array $deps Optional. An array of registered script handles this script depends on. Set to false if there
101 * are no dependencies. Default empty array.
102 * @param string|bool $ver Optional. String specifying script version number, if it has one, which is concatenated
103 * to end of path as a query string. If no version is specified or set to false, a version
104 * number is automatically added equal to current installed WordPress version.
105 * If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
106 * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
107 * Default 'false'. Accepts 'false' or 'true'.
109 function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
110 $wp_scripts = wp_scripts();
111 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
113 $wp_scripts->add( $handle, $src, $deps, $ver );
115 $wp_scripts->add_data( $handle, 'group', 1 );
122 * Works only if the script has already been added.
124 * Accepts an associative array $l10n and creates a JavaScript object:
133 * @see WP_Dependencies::localize()
134 * @link https://core.trac.wordpress.org/ticket/11520
135 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
139 * @todo Documentation cleanup
141 * @param string $handle Script handle the data will be attached to.
142 * @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
143 * Example: '/[a-zA-Z0-9_]+/'.
144 * @param array $l10n The data itself. The data can be either a single or multi-dimensional array.
145 * @return bool True if the script was successfully localized, false otherwise.
147 function wp_localize_script( $handle, $object_name, $l10n ) {
149 if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
150 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
154 return wp_scripts()->localize( $handle, $object_name, $l10n );
158 * Remove a registered script.
160 * Note: there are intentional safeguards in place to prevent critical admin scripts,
161 * such as jQuery core, from being unregistered.
163 * @see WP_Dependencies::remove()
164 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
168 * @param string $handle Name of the script to be removed.
170 function wp_deregister_script( $handle ) {
171 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
174 * Do not allow accidental or negligent de-registering of critical scripts in the admin.
175 * Show minimal remorse if the correct hook is used.
177 $current_filter = current_filter();
178 if ( ( is_admin() && 'admin_enqueue_scripts' !== $current_filter ) ||
179 ( 'wp-login.php' === $GLOBALS['pagenow'] && 'login_enqueue_scripts' !== $current_filter )
182 'jquery', 'jquery-core', 'jquery-migrate', 'jquery-ui-core', 'jquery-ui-accordion',
183 'jquery-ui-autocomplete', 'jquery-ui-button', 'jquery-ui-datepicker', 'jquery-ui-dialog',
184 'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-menu', 'jquery-ui-mouse',
185 'jquery-ui-position', 'jquery-ui-progressbar', 'jquery-ui-resizable', 'jquery-ui-selectable',
186 'jquery-ui-slider', 'jquery-ui-sortable', 'jquery-ui-spinner', 'jquery-ui-tabs',
187 'jquery-ui-tooltip', 'jquery-ui-widget', 'underscore', 'backbone',
190 if ( in_array( $handle, $no ) ) {
191 $message = sprintf( __( 'Do not deregister the %1$s script in the administration area. To target the frontend theme, use the %2$s hook.' ),
192 "<code>$handle</code>", '<code>wp_enqueue_scripts</code>' );
193 _doing_it_wrong( __FUNCTION__, $message, '3.6' );
198 wp_scripts()->remove( $handle );
204 * Registers the script if $src provided (does NOT overwrite), and enqueues it.
206 * @see WP_Dependencies::add(), WP_Dependencies::add_data(), WP_Dependencies::enqueue()
207 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
211 * @param string $handle Name of the script.
212 * @param string|bool $src Path to the script from the root directory of WordPress. Example: '/js/myscript.js'.
213 * @param array $deps An array of registered handles this script depends on. Default empty array.
214 * @param string|bool $ver Optional. String specifying the script version number, if it has one. This parameter
215 * is used to ensure that the correct version is sent to the client regardless of caching,
216 * and so should be included if a version number is available and makes sense for the script.
217 * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
218 * Default 'false'. Accepts 'false' or 'true'.
220 function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) {
221 $wp_scripts = wp_scripts();
223 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
226 if ( $src || $in_footer ) {
227 $_handle = explode( '?', $handle );
230 $wp_scripts->add( $_handle[0], $src, $deps, $ver );
234 $wp_scripts->add_data( $_handle[0], 'group', 1 );
238 $wp_scripts->enqueue( $handle );
242 * Remove a previously enqueued script.
244 * @see WP_Dependencies::dequeue()
245 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
249 * @param string $handle Name of the script to be removed.
251 function wp_dequeue_script( $handle ) {
252 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
254 wp_scripts()->dequeue( $handle );
258 * Check whether a script has been added to the queue.
260 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
263 * @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
265 * @param string $handle Name of the script.
266 * @param string $list Optional. Status of the script to check. Default 'enqueued'.
267 * Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.
268 * @return bool Whether the script script is queued.
270 function wp_script_is( $handle, $list = 'enqueued' ) {
271 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
273 return (bool) wp_scripts()->query( $handle, $list );
277 * Add metadata to a script.
279 * Works only if the script has already been added.
281 * Possible values for $key and $value:
282 * 'conditional' string Comments for IE 6, lte IE 7, etc.
286 * @see WP_Dependency::add_data()
288 * @param string $handle Name of the script.
289 * @param string $key Name of data point for which we're storing a value.
290 * @param mixed $value String containing the data to be added.
291 * @return bool True on success, false on failure.
293 function wp_script_add_data( $handle, $key, $value ){
295 return $wp_scripts->add_data( $handle, $key, $value );