wp-includes/functions.wp-scripts.php

   1 <?php
   2 /**
   3  * BackPress Scripts Procedural API
   4  *
   5  * @since 2.6.0
   6  *
   7  * @package WordPress
   8  * @subpackage BackPress
   9  */
  10
  11 /**
  12  * Initialize $wp_scripts if it has not been set.
  13  *
  14  * @global WP_Scripts $wp_scripts
  15  *
  16  * @since 4.2.0
  17  *
  18  * @return WP_Scripts WP_Scripts instance.
  19  */
  20 function wp_scripts() {
  21         global $wp_scripts;
  22         if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
  23                 $wp_scripts = new WP_Scripts();
  24         }
  25         return $wp_scripts;
  26 }
  27
  28 /**
  29  * Helper function to output a _doing_it_wrong message when applicable.
  30  *
  31  * @ignore
  32  * @since 4.2.0
  33  *
  34  * @param string $function Function name.
  35  */
  36 function _wp_scripts_maybe_doing_it_wrong( $function ) {
  37         if ( did_action( 'init' ) ) {
  38                 return;
  39         }
  40
  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>'
  46         ), '3.3' );
  47 }
  48
  49 /**
  50  * Print scripts in document head that are in the $handles queue.
  51  *
  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.
  56  *
  57  * @see WP_Scripts::do_items()
  58  * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  59  *
  60  * @since 2.6.0
  61  *
  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.
  64  */
  65 function wp_print_scripts( $handles = false ) {
  66         /**
  67          * Fires before scripts in the $handles queue are printed.
  68          *
  69          * @since 2.1.0
  70          */
  71         do_action( 'wp_print_scripts' );
  72         if ( '' === $handles ) { // for wp_head
  73                 $handles = false;
  74         }
  75
  76         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
  77
  78         global $wp_scripts;
  79         if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
  80                 if ( ! $handles ) {
  81                         return array(); // No need to instantiate if nothing is there.
  82                 }
  83         }
  84
  85         return wp_scripts()->do_items( $handles );
  86 }
  87
  88 /**
  89  * Register a new script.
  90  *
  91  * Registers a script to be linked later using the wp_enqueue_script() function.
  92  *
  93  * @see WP_Dependencies::add(), WP_Dependencies::add_data()
  94  * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  95  *
  96  * @since 2.6.0
  97  *
  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'.
 108  */
 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__ );
 112
 113         $wp_scripts->add( $handle, $src, $deps, $ver );
 114         if ( $in_footer ) {
 115                 $wp_scripts->add_data( $handle, 'group', 1 );
 116         }
 117 }
 118
 119 /**
 120  * Localize a script.
 121  *
 122  * Works only if the script has already been added.
 123  *
 124  * Accepts an associative array $l10n and creates a JavaScript object:
 125  *
 126  *     "$object_name" = {
 127  *         key: value,
 128  *         key: value,
 129  *         ...
 130  *     }
 131  *
 132  *
 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.
 136  *
 137  * @since 2.6.0
 138  *
 139  * @todo Documentation cleanup
 140  *
 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.
 146  */
 147 function wp_localize_script( $handle, $object_name, $l10n ) {
 148         global $wp_scripts;
 149         if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
 150                 _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 151                 return false;
 152         }
 153
 154         return wp_scripts()->localize( $handle, $object_name, $l10n );
 155 }
 156
 157 /**
 158  * Remove a registered script.
 159  *
 160  * Note: there are intentional safeguards in place to prevent critical admin scripts,
 161  * such as jQuery core, from being unregistered.
 162  *
 163  * @see WP_Dependencies::remove()
 164  * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
 165  *
 166  * @since 2.6.0
 167  *
 168  * @param string $handle Name of the script to be removed.
 169  */
 170 function wp_deregister_script( $handle ) {
 171         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 172
 173         /**
 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.
 176          */
 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 )
 180         ) {
 181                 $no = array(
 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',
 188                 );
 189
 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' );
 194                         return;
 195                 }
 196         }
 197
 198         wp_scripts()->remove( $handle );
 199 }
 200
 201 /**
 202  * Enqueue a script.
 203  *
 204  * Registers the script if $src provided (does NOT overwrite), and enqueues it.
 205  *
 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.
 208  *
 209  * @since 2.6.0
 210  *
 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'.
 219  */
 220 function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) {
 221         $wp_scripts = wp_scripts();
 222
 223         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 224
 225
 226         if ( $src || $in_footer ) {
 227                 $_handle = explode( '?', $handle );
 228
 229                 if ( $src ) {
 230                         $wp_scripts->add( $_handle[0], $src, $deps, $ver );
 231                 }
 232
 233                 if ( $in_footer ) {
 234                         $wp_scripts->add_data( $_handle[0], 'group', 1 );
 235                 }
 236         }
 237
 238         $wp_scripts->enqueue( $handle );
 239 }
 240
 241 /**
 242  * Remove a previously enqueued script.
 243  *
 244  * @see WP_Dependencies::dequeue()
 245  * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
 246  *
 247  * @since 3.1.0
 248  *
 249  * @param string $handle Name of the script to be removed.
 250  */
 251 function wp_dequeue_script( $handle ) {
 252         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 253
 254         wp_scripts()->dequeue( $handle );
 255 }
 256
 257 /**
 258  * Check whether a script has been added to the queue.
 259  *
 260  * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
 261  *
 262  * @since 2.8.0
 263  * @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
 264  *
 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.
 269  */
 270 function wp_script_is( $handle, $list = 'enqueued' ) {
 271         _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 272
 273         return (bool) wp_scripts()->query( $handle, $list );
 274 }
 275
 276 /**
 277  * Add metadata to a script.
 278  *
 279  * Works only if the script has already been added.
 280  *
 281  * Possible values for $key and $value:
 282  * 'conditional' string Comments for IE 6, lte IE 7, etc.
 283  *
 284  * @since 4.2.0
 285  *
 286  * @see WP_Dependency::add_data()
 287  *
 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.
 292  */
 293 function wp_script_add_data( $handle, $key, $value ){
 294         global $wp_scripts;
 295         return $wp_scripts->add_data( $handle, $key, $value );
 296 }