[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> functions.wp-scripts.php (source)

   1  <?php
   2  /**
   3   * Dependencies API: Scripts functions
   4   *
   5   * @since 2.6.0
   6   *
   7   * @package WordPress
   8   * @subpackage Dependencies
   9   */
  10  
  11  /**
  12   * Initializes $wp_scripts if it has not been set.
  13   *
  14   * @since 4.2.0
  15   *
  16   * @global WP_Scripts $wp_scripts
  17   *
  18   * @return WP_Scripts WP_Scripts instance.
  19   */
  20  function wp_scripts() {
  21      global $wp_scripts;
  22  
  23      if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
  24          $wp_scripts = new WP_Scripts();
  25      }
  26  
  27      return $wp_scripts;
  28  }
  29  
  30  /**
  31   * Helper function to output a _doing_it_wrong message when applicable.
  32   *
  33   * @ignore
  34   * @since 4.2.0
  35   * @since 5.5.0 Added the `$handle` parameter.
  36   *
  37   * @param string $function_name Function name.
  38   * @param string $handle        Optional. Name of the script or stylesheet that was
  39   *                              registered or enqueued too early. Default empty.
  40   */
  41  function _wp_scripts_maybe_doing_it_wrong( $function_name, $handle = '' ) {
  42      if ( did_action( 'init' ) || did_action( 'wp_enqueue_scripts' )
  43          || did_action( 'admin_enqueue_scripts' ) || did_action( 'login_enqueue_scripts' )
  44      ) {
  45          return;
  46      }
  47  
  48      $message = sprintf(
  49          /* translators: 1: wp_enqueue_scripts, 2: admin_enqueue_scripts, 3: login_enqueue_scripts */
  50          __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
  51          '<code>wp_enqueue_scripts</code>',
  52          '<code>admin_enqueue_scripts</code>',
  53          '<code>login_enqueue_scripts</code>'
  54      );
  55  
  56      if ( $handle ) {
  57          $message .= ' ' . sprintf(
  58              /* translators: %s: Name of the script or stylesheet. */
  59              __( 'This notice was triggered by the %s handle.' ),
  60              '<code>' . $handle . '</code>'
  61          );
  62      }
  63  
  64      _doing_it_wrong(
  65          $function_name,
  66          $message,
  67          '3.3.0'
  68      );
  69  }
  70  
  71  /**
  72   * Prints scripts in document head that are in the $handles queue.
  73   *
  74   * Called by admin-header.php and {@see 'wp_head'} hook. Since it is called by wp_head on every page load,
  75   * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
  76   * Makes use of already-instantiated `$wp_scripts` global if present. Use provided {@see 'wp_print_scripts'}
  77   * hook to register/enqueue new scripts.
  78   *
  79   * @see WP_Scripts::do_item()
  80   * @since 2.1.0
  81   *
  82   * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  83   *
  84   * @param string|string[]|false $handles Optional. Scripts to be printed. Default 'false'.
  85   * @return string[] On success, an array of handles of processed WP_Dependencies items; otherwise, an empty array.
  86   */
  87  function wp_print_scripts( $handles = false ) {
  88      global $wp_scripts;
  89  
  90      /**
  91       * Fires before scripts in the $handles queue are printed.
  92       *
  93       * @since 2.1.0
  94       */
  95      do_action( 'wp_print_scripts' );
  96  
  97      if ( '' === $handles ) { // For 'wp_head'.
  98          $handles = false;
  99      }
 100  
 101      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 102  
 103      if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
 104          if ( ! $handles ) {
 105              return array(); // No need to instantiate if nothing is there.
 106          }
 107      }
 108  
 109      return wp_scripts()->do_items( $handles );
 110  }
 111  
 112  /**
 113   * Adds extra code to a registered script.
 114   *
 115   * Code will only be added if the script is already in the queue.
 116   * Accepts a string `$data` containing the code. If two or more code blocks
 117   * are added to the same script `$handle`, they will be printed in the order
 118   * they were added, i.e. the latter added code can redeclare the previous.
 119   *
 120   * @since 4.5.0
 121   *
 122   * @see WP_Scripts::add_inline_script()
 123   *
 124   * @param string $handle   Name of the script to add the inline script to.
 125   * @param string $data     String containing the JavaScript to be added.
 126   * @param string $position Optional. Whether to add the inline script before the handle
 127   *                         or after. Default 'after'.
 128   * @return bool True on success, false on failure.
 129   */
 130  function wp_add_inline_script( $handle, $data, $position = 'after' ) {
 131      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 132  
 133      if ( false !== stripos( $data, '</script>' ) ) {
 134          _doing_it_wrong(
 135              __FUNCTION__,
 136              sprintf(
 137                  /* translators: 1: <script>, 2: wp_add_inline_script() */
 138                  __( 'Do not pass %1$s tags to %2$s.' ),
 139                  '<code>&lt;script&gt;</code>',
 140                  '<code>wp_add_inline_script()</code>'
 141              ),
 142              '4.5.0'
 143          );
 144          $data = trim( preg_replace( '#<script[^>]*>(.*)</script>#is', '$1', $data ) );
 145      }
 146  
 147      return wp_scripts()->add_inline_script( $handle, $data, $position );
 148  }
 149  
 150  /**
 151   * Registers a new script.
 152   *
 153   * Registers a script to be enqueued later using the wp_enqueue_script() function.
 154   *
 155   * @see WP_Dependencies::add()
 156   * @see WP_Dependencies::add_data()
 157   *
 158   * @since 2.1.0
 159   * @since 4.3.0 A return value was added.
 160   * @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
 161   *
 162   * @param string           $handle    Name of the script. Should be unique.
 163   * @param string|false     $src       Full URL of the script, or path of the script relative to the WordPress root directory.
 164   *                                    If source is set to false, script is an alias of other scripts it depends on.
 165   * @param string[]         $deps      Optional. An array of registered script handles this script depends on. Default empty array.
 166   * @param string|bool|null $ver       Optional. String specifying script version number, if it has one, which is added to the URL
 167   *                                    as a query string for cache busting purposes. If version is set to false, a version
 168   *                                    number is automatically added equal to current installed WordPress version.
 169   *                                    If set to null, no version is added.
 170   * @param array|bool       $args     {
 171   *     Optional. An array of additional script loading strategies. Default empty array.
 172   *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
 173   *
 174   *     @type string    $strategy     Optional. If provided, may be either 'defer' or 'async'.
 175   *     @type bool      $in_footer    Optional. Whether to print the script in the footer. Default 'false'.
 176   * }
 177   * @return bool Whether the script has been registered. True on success, false on failure.
 178   */
 179  function wp_register_script( $handle, $src, $deps = array(), $ver = false, $args = array() ) {
 180      if ( ! is_array( $args ) ) {
 181          $args = array(
 182              'in_footer' => (bool) $args,
 183          );
 184      }
 185      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 186  
 187      $wp_scripts = wp_scripts();
 188  
 189      $registered = $wp_scripts->add( $handle, $src, $deps, $ver );
 190      if ( ! empty( $args['in_footer'] ) ) {
 191          $wp_scripts->add_data( $handle, 'group', 1 );
 192      }
 193      if ( ! empty( $args['strategy'] ) ) {
 194          $wp_scripts->add_data( $handle, 'strategy', $args['strategy'] );
 195      }
 196      return $registered;
 197  }
 198  
 199  /**
 200   * Localizes a script.
 201   *
 202   * Works only if the script has already been registered.
 203   *
 204   * Accepts an associative array `$l10n` and creates a JavaScript object:
 205   *
 206   *     "$object_name": {
 207   *         key: value,
 208   *         key: value,
 209   *         ...
 210   *     }
 211   *
 212   * @see WP_Scripts::localize()
 213   * @link https://core.trac.wordpress.org/ticket/11520
 214   *
 215   * @since 2.2.0
 216   *
 217   * @todo Documentation cleanup
 218   *
 219   * @param string $handle      Script handle the data will be attached to.
 220   * @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
 221   *                            Example: '/[a-zA-Z0-9_]+/'.
 222   * @param array  $l10n        The data itself. The data can be either a single or multi-dimensional array.
 223   * @return bool True if the script was successfully localized, false otherwise.
 224   */
 225  function wp_localize_script( $handle, $object_name, $l10n ) {
 226      $wp_scripts = wp_scripts();
 227  
 228      return $wp_scripts->localize( $handle, $object_name, $l10n );
 229  }
 230  
 231  /**
 232   * Sets translated strings for a script.
 233   *
 234   * Works only if the script has already been registered.
 235   *
 236   * @see WP_Scripts::set_translations()
 237   * @since 5.0.0
 238   * @since 5.1.0 The `$domain` parameter was made optional.
 239   *
 240   * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
 241   *
 242   * @param string $handle Script handle the textdomain will be attached to.
 243   * @param string $domain Optional. Text domain. Default 'default'.
 244   * @param string $path   Optional. The full file path to the directory containing translation files.
 245   * @return bool True if the text domain was successfully localized, false otherwise.
 246   */
 247  function wp_set_script_translations( $handle, $domain = 'default', $path = '' ) {
 248      global $wp_scripts;
 249  
 250      if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
 251          _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 252          return false;
 253      }
 254  
 255      return $wp_scripts->set_translations( $handle, $domain, $path );
 256  }
 257  
 258  /**
 259   * Removes a registered script.
 260   *
 261   * Note: there are intentional safeguards in place to prevent critical admin scripts,
 262   * such as jQuery core, from being unregistered.
 263   *
 264   * @see WP_Dependencies::remove()
 265   *
 266   * @since 2.1.0
 267   *
 268   * @global string $pagenow The filename of the current screen.
 269   *
 270   * @param string $handle Name of the script to be removed.
 271   */
 272  function wp_deregister_script( $handle ) {
 273      global $pagenow;
 274  
 275      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 276  
 277      /**
 278       * Do not allow accidental or negligent de-registering of critical scripts in the admin.
 279       * Show minimal remorse if the correct hook is used.
 280       */
 281      $current_filter = current_filter();
 282      if ( ( is_admin() && 'admin_enqueue_scripts' !== $current_filter ) ||
 283          ( 'wp-login.php' === $pagenow && 'login_enqueue_scripts' !== $current_filter )
 284      ) {
 285          $not_allowed = array(
 286              'jquery',
 287              'jquery-core',
 288              'jquery-migrate',
 289              'jquery-ui-core',
 290              'jquery-ui-accordion',
 291              'jquery-ui-autocomplete',
 292              'jquery-ui-button',
 293              'jquery-ui-datepicker',
 294              'jquery-ui-dialog',
 295              'jquery-ui-draggable',
 296              'jquery-ui-droppable',
 297              'jquery-ui-menu',
 298              'jquery-ui-mouse',
 299              'jquery-ui-position',
 300              'jquery-ui-progressbar',
 301              'jquery-ui-resizable',
 302              'jquery-ui-selectable',
 303              'jquery-ui-slider',
 304              'jquery-ui-sortable',
 305              'jquery-ui-spinner',
 306              'jquery-ui-tabs',
 307              'jquery-ui-tooltip',
 308              'jquery-ui-widget',
 309              'underscore',
 310              'backbone',
 311          );
 312  
 313          if ( in_array( $handle, $not_allowed, true ) ) {
 314              _doing_it_wrong(
 315                  __FUNCTION__,
 316                  sprintf(
 317                      /* translators: 1: Script name, 2: wp_enqueue_scripts */
 318                      __( 'Do not deregister the %1$s script in the administration area. To target the front-end theme, use the %2$s hook.' ),
 319                      "<code>$handle</code>",
 320                      '<code>wp_enqueue_scripts</code>'
 321                  ),
 322                  '3.6.0'
 323              );
 324              return;
 325          }
 326      }
 327  
 328      wp_scripts()->remove( $handle );
 329  }
 330  
 331  /**
 332   * Enqueues a script.
 333   *
 334   * Registers the script if `$src` provided (does NOT overwrite), and enqueues it.
 335   *
 336   * @see WP_Dependencies::add()
 337   * @see WP_Dependencies::add_data()
 338   * @see WP_Dependencies::enqueue()
 339   *
 340   * @since 2.1.0
 341   * @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
 342   *
 343   * @param string           $handle    Name of the script. Should be unique.
 344   * @param string           $src       Full URL of the script, or path of the script relative to the WordPress root directory.
 345   *                                    Default empty.
 346   * @param string[]         $deps      Optional. An array of registered script handles this script depends on. Default empty array.
 347   * @param string|bool|null $ver       Optional. String specifying script version number, if it has one, which is added to the URL
 348   *                                    as a query string for cache busting purposes. If version is set to false, a version
 349   *                                    number is automatically added equal to current installed WordPress version.
 350   *                                    If set to null, no version is added.
 351   * @param array|bool       $args     {
 352   *     Optional. An array of additional script loading strategies. Default empty array.
 353   *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
 354   *
 355   *     @type string    $strategy     Optional. If provided, may be either 'defer' or 'async'.
 356   *     @type bool      $in_footer    Optional. Whether to print the script in the footer. Default 'false'.
 357   * }
 358   */
 359  function wp_enqueue_script( $handle, $src = '', $deps = array(), $ver = false, $args = array() ) {
 360      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 361  
 362      $wp_scripts = wp_scripts();
 363  
 364      if ( $src || ! empty( $args ) ) {
 365          $_handle = explode( '?', $handle );
 366          if ( ! is_array( $args ) ) {
 367              $args = array(
 368                  'in_footer' => (bool) $args,
 369              );
 370          }
 371  
 372          if ( $src ) {
 373              $wp_scripts->add( $_handle[0], $src, $deps, $ver );
 374          }
 375          if ( ! empty( $args['in_footer'] ) ) {
 376              $wp_scripts->add_data( $_handle[0], 'group', 1 );
 377          }
 378          if ( ! empty( $args['strategy'] ) ) {
 379              $wp_scripts->add_data( $_handle[0], 'strategy', $args['strategy'] );
 380          }
 381      }
 382  
 383      $wp_scripts->enqueue( $handle );
 384  }
 385  
 386  /**
 387   * Removes a previously enqueued script.
 388   *
 389   * @see WP_Dependencies::dequeue()
 390   *
 391   * @since 3.1.0
 392   *
 393   * @param string $handle Name of the script to be removed.
 394   */
 395  function wp_dequeue_script( $handle ) {
 396      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 397  
 398      wp_scripts()->dequeue( $handle );
 399  }
 400  
 401  /**
 402   * Determines whether a script has been added to the queue.
 403   *
 404   * For more information on this and similar theme functions, check out
 405   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 406   * Conditional Tags} article in the Theme Developer Handbook.
 407   *
 408   * @since 2.8.0
 409   * @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
 410   *
 411   * @param string $handle Name of the script.
 412   * @param string $status Optional. Status of the script to check. Default 'enqueued'.
 413   *                       Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.
 414   * @return bool Whether the script is queued.
 415   */
 416  function wp_script_is( $handle, $status = 'enqueued' ) {
 417      _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
 418  
 419      return (bool) wp_scripts()->query( $handle, $status );
 420  }
 421  
 422  /**
 423   * Adds metadata to a script.
 424   *
 425   * Works only if the script has already been registered.
 426   *
 427   * Possible values for $key and $value:
 428   * 'conditional' string Comments for IE 6, lte IE 7, etc.
 429   *
 430   * @since 4.2.0
 431   *
 432   * @see WP_Dependencies::add_data()
 433   *
 434   * @param string $handle Name of the script.
 435   * @param string $key    Name of data point for which we're storing a value.
 436   * @param mixed  $value  String containing the data to be added.
 437   * @return bool True on success, false on failure.
 438   */
 439  function wp_script_add_data( $handle, $key, $value ) {
 440      return wp_scripts()->add_data( $handle, $key, $value );
 441  }


Generated : Tue Dec 24 08:20:01 2024 Cross-referenced by PHPXref