Нема описа

class.wp-scripts.php 18KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718
  1. <?php
  2. /**
  3. * Dependencies API: WP_Scripts class
  4. *
  5. * @since 2.6.0
  6. *
  7. * @package WordPress
  8. * @subpackage Dependencies
  9. */
  10. /**
  11. * Core class used to register scripts.
  12. *
  13. * @since 2.1.0
  14. *
  15. * @see WP_Dependencies
  16. */
  17. class WP_Scripts extends WP_Dependencies {
  18. /**
  19. * Base URL for scripts.
  20. *
  21. * Full URL with trailing slash.
  22. *
  23. * @since 2.6.0
  24. * @var string
  25. */
  26. public $base_url;
  27. /**
  28. * URL of the content directory.
  29. *
  30. * @since 2.8.0
  31. * @var string
  32. */
  33. public $content_url;
  34. /**
  35. * Default version string for scripts.
  36. *
  37. * @since 2.6.0
  38. * @var string
  39. */
  40. public $default_version;
  41. /**
  42. * Holds handles of scripts which are enqueued in footer.
  43. *
  44. * @since 2.8.0
  45. * @var array
  46. */
  47. public $in_footer = array();
  48. /**
  49. * Holds a list of script handles which will be concatenated.
  50. *
  51. * @since 2.8.0
  52. * @var string
  53. */
  54. public $concat = '';
  55. /**
  56. * Holds a string which contains script handles and their version.
  57. *
  58. * @since 2.8.0
  59. * @deprecated 3.4.0
  60. * @var string
  61. */
  62. public $concat_version = '';
  63. /**
  64. * Whether to perform concatenation.
  65. *
  66. * @since 2.8.0
  67. * @var bool
  68. */
  69. public $do_concat = false;
  70. /**
  71. * Holds HTML markup of scripts and additional data if concatenation
  72. * is enabled.
  73. *
  74. * @since 2.8.0
  75. * @var string
  76. */
  77. public $print_html = '';
  78. /**
  79. * Holds inline code if concatenation is enabled.
  80. *
  81. * @since 2.8.0
  82. * @var string
  83. */
  84. public $print_code = '';
  85. /**
  86. * Holds a list of script handles which are not in the default directory
  87. * if concatenation is enabled.
  88. *
  89. * Unused in core.
  90. *
  91. * @since 2.8.0
  92. * @var string
  93. */
  94. public $ext_handles = '';
  95. /**
  96. * Holds a string which contains handles and versions of scripts which
  97. * are not in the default directory if concatenation is enabled.
  98. *
  99. * Unused in core.
  100. *
  101. * @since 2.8.0
  102. * @var string
  103. */
  104. public $ext_version = '';
  105. /**
  106. * List of default directories.
  107. *
  108. * @since 2.8.0
  109. * @var array
  110. */
  111. public $default_dirs;
  112. /**
  113. * Holds a string which contains the type attribute for script tag.
  114. *
  115. * If the current theme does not declare HTML5 support for 'script',
  116. * then it initializes as `type='text/javascript'`.
  117. *
  118. * @since 5.3.0
  119. * @var string
  120. */
  121. private $type_attr = '';
  122. /**
  123. * Constructor.
  124. *
  125. * @since 2.6.0
  126. */
  127. public function __construct() {
  128. $this->init();
  129. add_action( 'init', array( $this, 'init' ), 0 );
  130. }
  131. /**
  132. * Initialize the class.
  133. *
  134. * @since 3.4.0
  135. */
  136. public function init() {
  137. if (
  138. function_exists( 'is_admin' ) && ! is_admin()
  139. &&
  140. function_exists( 'current_theme_supports' ) && ! current_theme_supports( 'html5', 'script' )
  141. ) {
  142. $this->type_attr = " type='text/javascript'";
  143. }
  144. /**
  145. * Fires when the WP_Scripts instance is initialized.
  146. *
  147. * @since 2.6.0
  148. *
  149. * @param WP_Scripts $this WP_Scripts instance (passed by reference).
  150. */
  151. do_action_ref_array( 'wp_default_scripts', array( &$this ) );
  152. }
  153. /**
  154. * Prints scripts.
  155. *
  156. * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
  157. *
  158. * @since 2.1.0
  159. * @since 2.8.0 Added the `$group` parameter.
  160. *
  161. * @param string|string[]|false $handles Optional. Scripts to be printed: queue (false),
  162. * single script (string), or multiple scripts (array of strings).
  163. * Default false.
  164. * @param int|false $group Optional. Group level: level (int), no groups (false).
  165. * Default false.
  166. * @return string[] Handles of scripts that have been printed.
  167. */
  168. public function print_scripts( $handles = false, $group = false ) {
  169. return $this->do_items( $handles, $group );
  170. }
  171. /**
  172. * Prints extra scripts of a registered script.
  173. *
  174. * @since 2.1.0
  175. * @since 2.8.0 Added the `$echo` parameter.
  176. * @deprecated 3.3.0
  177. *
  178. * @see print_extra_script()
  179. *
  180. * @param string $handle The script's registered handle.
  181. * @param bool $echo Optional. Whether to echo the extra script
  182. * instead of just returning it. Default true.
  183. * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true,
  184. * true otherwise.
  185. */
  186. public function print_scripts_l10n( $handle, $echo = true ) {
  187. _deprecated_function( __FUNCTION__, '3.3.0', 'WP_Scripts::print_extra_script()' );
  188. return $this->print_extra_script( $handle, $echo );
  189. }
  190. /**
  191. * Prints extra scripts of a registered script.
  192. *
  193. * @since 3.3.0
  194. *
  195. * @param string $handle The script's registered handle.
  196. * @param bool $echo Optional. Whether to echo the extra script
  197. * instead of just returning it. Default true.
  198. * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true,
  199. * true otherwise.
  200. */
  201. public function print_extra_script( $handle, $echo = true ) {
  202. $output = $this->get_data( $handle, 'data' );
  203. if ( ! $output ) {
  204. return;
  205. }
  206. if ( ! $echo ) {
  207. return $output;
  208. }
  209. printf( "<script%s id='%s-js-extra'>\n", $this->type_attr, esc_attr( $handle ) );
  210. // CDATA is not needed for HTML 5.
  211. if ( $this->type_attr ) {
  212. echo "/* <![CDATA[ */\n";
  213. }
  214. echo "$output\n";
  215. if ( $this->type_attr ) {
  216. echo "/* ]]> */\n";
  217. }
  218. echo "</script>\n";
  219. return true;
  220. }
  221. /**
  222. * Processes a script dependency.
  223. *
  224. * @since 2.6.0
  225. * @since 2.8.0 Added the `$group` parameter.
  226. *
  227. * @see WP_Dependencies::do_item()
  228. *
  229. * @param string $handle The script's registered handle.
  230. * @param int|false $group Optional. Group level: level (int), no groups (false).
  231. * Default false.
  232. * @return bool True on success, false on failure.
  233. */
  234. public function do_item( $handle, $group = false ) {
  235. if ( ! parent::do_item( $handle ) ) {
  236. return false;
  237. }
  238. if ( 0 === $group && $this->groups[ $handle ] > 0 ) {
  239. $this->in_footer[] = $handle;
  240. return false;
  241. }
  242. if ( false === $group && in_array( $handle, $this->in_footer, true ) ) {
  243. $this->in_footer = array_diff( $this->in_footer, (array) $handle );
  244. }
  245. $obj = $this->registered[ $handle ];
  246. if ( null === $obj->ver ) {
  247. $ver = '';
  248. } else {
  249. $ver = $obj->ver ? $obj->ver : $this->default_version;
  250. }
  251. if ( isset( $this->args[ $handle ] ) ) {
  252. $ver = $ver ? $ver . '&amp;' . $this->args[ $handle ] : $this->args[ $handle ];
  253. }
  254. $src = $obj->src;
  255. $cond_before = '';
  256. $cond_after = '';
  257. $conditional = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
  258. if ( $conditional ) {
  259. $cond_before = "<!--[if {$conditional}]>\n";
  260. $cond_after = "<![endif]-->\n";
  261. }
  262. $before_handle = $this->print_inline_script( $handle, 'before', false );
  263. $after_handle = $this->print_inline_script( $handle, 'after', false );
  264. if ( $before_handle ) {
  265. $before_handle = sprintf( "<script%s id='%s-js-before'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $before_handle );
  266. }
  267. if ( $after_handle ) {
  268. $after_handle = sprintf( "<script%s id='%s-js-after'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $after_handle );
  269. }
  270. if ( $before_handle || $after_handle ) {
  271. $inline_script_tag = $cond_before . $before_handle . $after_handle . $cond_after;
  272. } else {
  273. $inline_script_tag = '';
  274. }
  275. $translations = $this->print_translations( $handle, false );
  276. if ( $translations ) {
  277. $translations = sprintf( "<script%s id='%s-js-translations'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $translations );
  278. }
  279. if ( $this->do_concat ) {
  280. /**
  281. * Filters the script loader source.
  282. *
  283. * @since 2.2.0
  284. *
  285. * @param string $src Script loader source path.
  286. * @param string $handle Script handle.
  287. */
  288. $srce = apply_filters( 'script_loader_src', $src, $handle );
  289. if ( $this->in_default_dir( $srce ) && ( $before_handle || $after_handle || $translations ) ) {
  290. $this->do_concat = false;
  291. // Have to print the so-far concatenated scripts right away to maintain the right order.
  292. _print_scripts();
  293. $this->reset();
  294. } elseif ( $this->in_default_dir( $srce ) && ! $conditional ) {
  295. $this->print_code .= $this->print_extra_script( $handle, false );
  296. $this->concat .= "$handle,";
  297. $this->concat_version .= "$handle$ver";
  298. return true;
  299. } else {
  300. $this->ext_handles .= "$handle,";
  301. $this->ext_version .= "$handle$ver";
  302. }
  303. }
  304. $has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
  305. if ( $has_conditional_data ) {
  306. echo $cond_before;
  307. }
  308. $this->print_extra_script( $handle );
  309. if ( $has_conditional_data ) {
  310. echo $cond_after;
  311. }
  312. // A single item may alias a set of items, by having dependencies, but no source.
  313. if ( ! $src ) {
  314. if ( $inline_script_tag ) {
  315. if ( $this->do_concat ) {
  316. $this->print_html .= $inline_script_tag;
  317. } else {
  318. echo $inline_script_tag;
  319. }
  320. }
  321. return true;
  322. }
  323. if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
  324. $src = $this->base_url . $src;
  325. }
  326. if ( ! empty( $ver ) ) {
  327. $src = add_query_arg( 'ver', $ver, $src );
  328. }
  329. /** This filter is documented in wp-includes/class.wp-scripts.php */
  330. $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
  331. if ( ! $src ) {
  332. return true;
  333. }
  334. $tag = $translations . $cond_before . $before_handle;
  335. $tag .= sprintf( "<script%s src='%s' id='%s-js'></script>\n", $this->type_attr, $src, esc_attr( $handle ) );
  336. $tag .= $after_handle . $cond_after;
  337. /**
  338. * Filters the HTML script tag of an enqueued script.
  339. *
  340. * @since 4.1.0
  341. *
  342. * @param string $tag The `<script>` tag for the enqueued script.
  343. * @param string $handle The script's registered handle.
  344. * @param string $src The script's source URL.
  345. */
  346. $tag = apply_filters( 'script_loader_tag', $tag, $handle, $src );
  347. if ( $this->do_concat ) {
  348. $this->print_html .= $tag;
  349. } else {
  350. echo $tag;
  351. }
  352. return true;
  353. }
  354. /**
  355. * Adds extra code to a registered script.
  356. *
  357. * @since 4.5.0
  358. *
  359. * @param string $handle Name of the script to add the inline script to.
  360. * Must be lowercase.
  361. * @param string $data String containing the JavaScript to be added.
  362. * @param string $position Optional. Whether to add the inline script
  363. * before the handle or after. Default 'after'.
  364. * @return bool True on success, false on failure.
  365. */
  366. public function add_inline_script( $handle, $data, $position = 'after' ) {
  367. if ( ! $data ) {
  368. return false;
  369. }
  370. if ( 'after' !== $position ) {
  371. $position = 'before';
  372. }
  373. $script = (array) $this->get_data( $handle, $position );
  374. $script[] = $data;
  375. return $this->add_data( $handle, $position, $script );
  376. }
  377. /**
  378. * Prints inline scripts registered for a specific handle.
  379. *
  380. * @since 4.5.0
  381. *
  382. * @param string $handle Name of the script to add the inline script to.
  383. * Must be lowercase.
  384. * @param string $position Optional. Whether to add the inline script
  385. * before the handle or after. Default 'after'.
  386. * @param bool $echo Optional. Whether to echo the script
  387. * instead of just returning it. Default true.
  388. * @return string|false Script on success, false otherwise.
  389. */
  390. public function print_inline_script( $handle, $position = 'after', $echo = true ) {
  391. $output = $this->get_data( $handle, $position );
  392. if ( empty( $output ) ) {
  393. return false;
  394. }
  395. $output = trim( implode( "\n", $output ), "\n" );
  396. if ( $echo ) {
  397. printf( "<script%s id='%s-js-%s'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), esc_attr( $position ), $output );
  398. }
  399. return $output;
  400. }
  401. /**
  402. * Localizes a script, only if the script has already been added.
  403. *
  404. * @since 2.1.0
  405. *
  406. * @param string $handle Name of the script to attach data to.
  407. * @param string $object_name Name of the variable that will contain the data.
  408. * @param array $l10n Array of data to localize.
  409. * @return bool True on success, false on failure.
  410. */
  411. public function localize( $handle, $object_name, $l10n ) {
  412. if ( 'jquery' === $handle ) {
  413. $handle = 'jquery-core';
  414. }
  415. if ( is_array( $l10n ) && isset( $l10n['l10n_print_after'] ) ) { // back compat, preserve the code in 'l10n_print_after' if present.
  416. $after = $l10n['l10n_print_after'];
  417. unset( $l10n['l10n_print_after'] );
  418. }
  419. if ( ! is_array( $l10n ) ) {
  420. _doing_it_wrong(
  421. __METHOD__,
  422. sprintf(
  423. /* translators: 1: $l10n, 2: wp_add_inline_script() */
  424. __( 'The %1$s parameter must be an array. To pass arbitrary data to scripts, use the %2$s function instead.' ),
  425. '<code>$l10n</code>',
  426. '<code>wp_add_inline_script()</code>'
  427. ),
  428. '5.7.0'
  429. );
  430. }
  431. if ( is_string( $l10n ) ) {
  432. $l10n = html_entity_decode( $l10n, ENT_QUOTES, 'UTF-8' );
  433. } else {
  434. foreach ( (array) $l10n as $key => $value ) {
  435. if ( ! is_scalar( $value ) ) {
  436. continue;
  437. }
  438. $l10n[ $key ] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8' );
  439. }
  440. }
  441. $script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
  442. if ( ! empty( $after ) ) {
  443. $script .= "\n$after;";
  444. }
  445. $data = $this->get_data( $handle, 'data' );
  446. if ( ! empty( $data ) ) {
  447. $script = "$data\n$script";
  448. }
  449. return $this->add_data( $handle, 'data', $script );
  450. }
  451. /**
  452. * Sets handle group.
  453. *
  454. * @since 2.8.0
  455. *
  456. * @see WP_Dependencies::set_group()
  457. *
  458. * @param string $handle Name of the item. Should be unique.
  459. * @param bool $recursion Internal flag that calling function was called recursively.
  460. * @param int|false $group Optional. Group level: level (int), no groups (false).
  461. * Default false.
  462. * @return bool Not already in the group or a lower group.
  463. */
  464. public function set_group( $handle, $recursion, $group = false ) {
  465. if ( isset( $this->registered[ $handle ]->args ) && 1 === $this->registered[ $handle ]->args ) {
  466. $grp = 1;
  467. } else {
  468. $grp = (int) $this->get_data( $handle, 'group' );
  469. }
  470. if ( false !== $group && $grp > $group ) {
  471. $grp = $group;
  472. }
  473. return parent::set_group( $handle, $recursion, $grp );
  474. }
  475. /**
  476. * Sets a translation textdomain.
  477. *
  478. * @since 5.0.0
  479. * @since 5.1.0 The `$domain` parameter was made optional.
  480. *
  481. * @param string $handle Name of the script to register a translation domain to.
  482. * @param string $domain Optional. Text domain. Default 'default'.
  483. * @param string $path Optional. The full file path to the directory containing translation files.
  484. * @return bool True if the text domain was registered, false if not.
  485. */
  486. public function set_translations( $handle, $domain = 'default', $path = null ) {
  487. if ( ! isset( $this->registered[ $handle ] ) ) {
  488. return false;
  489. }
  490. /** @var \_WP_Dependency $obj */
  491. $obj = $this->registered[ $handle ];
  492. if ( ! in_array( 'wp-i18n', $obj->deps, true ) ) {
  493. $obj->deps[] = 'wp-i18n';
  494. }
  495. return $obj->set_translations( $domain, $path );
  496. }
  497. /**
  498. * Prints translations set for a specific handle.
  499. *
  500. * @since 5.0.0
  501. *
  502. * @param string $handle Name of the script to add the inline script to.
  503. * Must be lowercase.
  504. * @param bool $echo Optional. Whether to echo the script
  505. * instead of just returning it. Default true.
  506. * @return string|false Script on success, false otherwise.
  507. */
  508. public function print_translations( $handle, $echo = true ) {
  509. if ( ! isset( $this->registered[ $handle ] ) || empty( $this->registered[ $handle ]->textdomain ) ) {
  510. return false;
  511. }
  512. $domain = $this->registered[ $handle ]->textdomain;
  513. $path = $this->registered[ $handle ]->translations_path;
  514. $json_translations = load_script_textdomain( $handle, $domain, $path );
  515. if ( ! $json_translations ) {
  516. // Register empty locale data object to ensure the domain still exists.
  517. $json_translations = '{ "locale_data": { "messages": { "": {} } } }';
  518. }
  519. $output = <<<JS
  520. ( function( domain, translations ) {
  521. var localeData = translations.locale_data[ domain ] || translations.locale_data.messages;
  522. localeData[""].domain = domain;
  523. wp.i18n.setLocaleData( localeData, domain );
  524. } )( "{$domain}", {$json_translations} );
  525. JS;
  526. if ( $echo ) {
  527. printf( "<script%s id='%s-js-translations'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $output );
  528. }
  529. return $output;
  530. }
  531. /**
  532. * Determines script dependencies.
  533. *
  534. * @since 2.1.0
  535. *
  536. * @see WP_Dependencies::all_deps()
  537. *
  538. * @param string|string[] $handles Item handle (string) or item handles (array of strings).
  539. * @param bool $recursion Optional. Internal flag that function is calling itself.
  540. * Default false.
  541. * @param int|false $group Optional. Group level: level (int), no groups (false).
  542. * Default false.
  543. * @return bool True on success, false on failure.
  544. */
  545. public function all_deps( $handles, $recursion = false, $group = false ) {
  546. $r = parent::all_deps( $handles, $recursion, $group );
  547. if ( ! $recursion ) {
  548. /**
  549. * Filters the list of script dependencies left to print.
  550. *
  551. * @since 2.3.0
  552. *
  553. * @param string[] $to_do An array of script dependency handles.
  554. */
  555. $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
  556. }
  557. return $r;
  558. }
  559. /**
  560. * Processes items and dependencies for the head group.
  561. *
  562. * @since 2.8.0
  563. *
  564. * @see WP_Dependencies::do_items()
  565. *
  566. * @return string[] Handles of items that have been processed.
  567. */
  568. public function do_head_items() {
  569. $this->do_items( false, 0 );
  570. return $this->done;
  571. }
  572. /**
  573. * Processes items and dependencies for the footer group.
  574. *
  575. * @since 2.8.0
  576. *
  577. * @see WP_Dependencies::do_items()
  578. *
  579. * @return string[] Handles of items that have been processed.
  580. */
  581. public function do_footer_items() {
  582. $this->do_items( false, 1 );
  583. return $this->done;
  584. }
  585. /**
  586. * Whether a handle's source is in a default directory.
  587. *
  588. * @since 2.8.0
  589. *
  590. * @param string $src The source of the enqueued script.
  591. * @return bool True if found, false if not.
  592. */
  593. public function in_default_dir( $src ) {
  594. if ( ! $this->default_dirs ) {
  595. return true;
  596. }
  597. if ( 0 === strpos( $src, '/' . WPINC . '/js/l10n' ) ) {
  598. return false;
  599. }
  600. foreach ( (array) $this->default_dirs as $test ) {
  601. if ( 0 === strpos( $src, $test ) ) {
  602. return true;
  603. }
  604. }
  605. return false;
  606. }
  607. /**
  608. * Resets class properties.
  609. *
  610. * @since 2.8.0
  611. */
  612. public function reset() {
  613. $this->do_concat = false;
  614. $this->print_code = '';
  615. $this->concat = '';
  616. $this->concat_version = '';
  617. $this->print_html = '';
  618. $this->ext_version = '';
  619. $this->ext_handles = '';
  620. }
  621. }