3 * BackPress Scripts enqueue.
5 * These classes were refactored from the WordPress WP_Scripts and WordPress
13 * BackPress Scripts enqueue class.
16 * @uses WP_Dependencies
19 class WP_Scripts extends WP_Dependencies {
20 public $base_url; // Full URL with trailing slash
22 public $default_version;
23 public $in_footer = array();
25 public $concat_version = '';
26 public $do_concat = false;
27 public $print_html = '';
28 public $print_code = '';
29 public $ext_handles = '';
30 public $ext_version = '';
33 public function __construct() {
35 add_action( 'init', array( $this, 'init' ), 0 );
38 public function init() {
40 * Fires when the WP_Scripts instance is initialized.
44 * @param WP_Scripts &$this WP_Scripts instance, passed by reference.
46 do_action_ref_array( 'wp_default_scripts', array(&$this) );
52 * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
54 * @param mixed $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
55 * that script, (array of strings) prints those scripts. Default false.
56 * @param int $group Optional. If scripts were queued in groups prints this group number.
58 * @return array Scripts that have been printed.
60 public function print_scripts( $handles = false, $group = false ) {
61 return $this->do_items( $handles, $group );
64 // Deprecated since 3.3, see print_extra_script()
65 public function print_scripts_l10n( $handle, $echo = true ) {
66 _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
67 return $this->print_extra_script( $handle, $echo );
70 public function print_extra_script( $handle, $echo = true ) {
71 if ( !$output = $this->get_data( $handle, 'data' ) )
77 echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5
78 echo "/* <![CDATA[ */\n";
86 public function do_item( $handle, $group = false ) {
87 if ( !parent::do_item($handle) )
90 if ( 0 === $group && $this->groups[$handle] > 0 ) {
91 $this->in_footer[] = $handle;
95 if ( false === $group && in_array($handle, $this->in_footer, true) )
96 $this->in_footer = array_diff( $this->in_footer, (array) $handle );
98 $obj = $this->registered[$handle];
100 if ( null === $obj->ver ) {
103 $ver = $obj->ver ? $obj->ver : $this->default_version;
106 if ( isset($this->args[$handle]) )
107 $ver = $ver ? $ver . '&' . $this->args[$handle] : $this->args[$handle];
110 $cond_before = $cond_after = '';
111 $conditional = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
113 if ( $conditional ) {
114 $cond_before = "<!--[if {$conditional}]>\n";
115 $cond_after = "<![endif]-->\n";
118 if ( $this->do_concat ) {
120 * Filter the script loader source.
124 * @param string $src Script loader source path.
125 * @param string $handle Script handle.
127 $srce = apply_filters( 'script_loader_src', $src, $handle );
128 if ( $this->in_default_dir( $srce ) && ! $conditional ) {
129 $this->print_code .= $this->print_extra_script( $handle, false );
130 $this->concat .= "$handle,";
131 $this->concat_version .= "$handle$ver";
134 $this->ext_handles .= "$handle,";
135 $this->ext_version .= "$handle$ver";
139 $has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
141 if ( $has_conditional_data ) {
145 $this->print_extra_script( $handle );
147 if ( $has_conditional_data ) {
151 if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
152 $src = $this->base_url . $src;
155 if ( ! empty( $ver ) )
156 $src = add_query_arg( 'ver', $ver, $src );
158 /** This filter is documented in wp-includes/class.wp-scripts.php */
159 $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
164 $tag = "{$cond_before}<script type='text/javascript' src='$src'></script>\n{$cond_after}";
167 * Filter the HTML script tag of an enqueued script.
171 * @param string $tag The `<script>` tag for the enqueued script.
172 * @param string $handle The script's registered handle.
173 * @param string $src The script's source URL.
175 $tag = apply_filters( 'script_loader_tag', $tag, $handle, $src );
177 if ( $this->do_concat ) {
178 $this->print_html .= $tag;
189 * Localizes only if the script has already been added
191 public function localize( $handle, $object_name, $l10n ) {
192 if ( $handle === 'jquery' )
193 $handle = 'jquery-core';
195 if ( is_array($l10n) && isset($l10n['l10n_print_after']) ) { // back compat, preserve the code in 'l10n_print_after' if present
196 $after = $l10n['l10n_print_after'];
197 unset($l10n['l10n_print_after']);
200 foreach ( (array) $l10n as $key => $value ) {
201 if ( !is_scalar($value) )
204 $l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
207 $script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
209 if ( !empty($after) )
210 $script .= "\n$after;";
212 $data = $this->get_data( $handle, 'data' );
214 if ( !empty( $data ) )
215 $script = "$data\n$script";
217 return $this->add_data( $handle, 'data', $script );
220 public function set_group( $handle, $recursion, $group = false ) {
222 if ( $this->registered[$handle]->args === 1 )
225 $grp = (int) $this->get_data( $handle, 'group' );
227 if ( false !== $group && $grp > $group )
230 return parent::set_group( $handle, $recursion, $grp );
233 public function all_deps( $handles, $recursion = false, $group = false ) {
234 $r = parent::all_deps( $handles, $recursion );
235 if ( ! $recursion ) {
237 * Filter the list of script dependencies left to print.
241 * @param array $to_do An array of script dependencies.
243 $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
248 public function do_head_items() {
249 $this->do_items(false, 0);
253 public function do_footer_items() {
254 $this->do_items(false, 1);
258 public function in_default_dir( $src ) {
259 if ( ! $this->default_dirs ) {
263 if ( 0 === strpos( $src, '/' . WPINC . '/js/l10n' ) ) {
267 foreach ( (array) $this->default_dirs as $test ) {
268 if ( 0 === strpos( $src, $test ) ) {
275 public function reset() {
276 $this->do_concat = false;
277 $this->print_code = '';
279 $this->concat_version = '';
280 $this->print_html = '';
281 $this->ext_version = '';
282 $this->ext_handles = '';