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 );
41 public function init() {
43 * Fires when the WP_Scripts instance is initialized.
47 * @param WP_Scripts &$this WP_Scripts instance, passed by reference.
49 do_action_ref_array( 'wp_default_scripts', array(&$this) );
55 * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
57 * @param mixed $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
58 * that script, (array of strings) prints those scripts. Default false.
59 * @param int $group Optional. If scripts were queued in groups prints this group number.
61 * @return array Scripts that have been printed.
63 public function print_scripts( $handles = false, $group = false ) {
64 return $this->do_items( $handles, $group );
69 * @see print_extra_script()
71 * @param string $handle
73 * @return bool|string|void
75 public function print_scripts_l10n( $handle, $echo = true ) {
76 _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
77 return $this->print_extra_script( $handle, $echo );
81 * @param string $handle
83 * @return bool|string|void
85 public function print_extra_script( $handle, $echo = true ) {
86 if ( !$output = $this->get_data( $handle, 'data' ) )
92 echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5
93 echo "/* <![CDATA[ */\n";
102 * @param string $handle Name of the item. Should be unique.
103 * @param int|bool $group
104 * @return bool True on success, false if not set.
106 public function do_item( $handle, $group = false ) {
107 if ( !parent::do_item($handle) )
110 if ( 0 === $group && $this->groups[$handle] > 0 ) {
111 $this->in_footer[] = $handle;
115 if ( false === $group && in_array($handle, $this->in_footer, true) )
116 $this->in_footer = array_diff( $this->in_footer, (array) $handle );
118 $obj = $this->registered[$handle];
120 if ( null === $obj->ver ) {
123 $ver = $obj->ver ? $obj->ver : $this->default_version;
126 if ( isset($this->args[$handle]) )
127 $ver = $ver ? $ver . '&' . $this->args[$handle] : $this->args[$handle];
130 $cond_before = $cond_after = '';
131 $conditional = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
133 if ( $conditional ) {
134 $cond_before = "<!--[if {$conditional}]>\n";
135 $cond_after = "<![endif]-->\n";
138 if ( $this->do_concat ) {
140 * Filter the script loader source.
144 * @param string $src Script loader source path.
145 * @param string $handle Script handle.
147 $srce = apply_filters( 'script_loader_src', $src, $handle );
148 if ( $this->in_default_dir( $srce ) && ! $conditional ) {
149 $this->print_code .= $this->print_extra_script( $handle, false );
150 $this->concat .= "$handle,";
151 $this->concat_version .= "$handle$ver";
154 $this->ext_handles .= "$handle,";
155 $this->ext_version .= "$handle$ver";
159 $has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
161 if ( $has_conditional_data ) {
165 $this->print_extra_script( $handle );
167 if ( $has_conditional_data ) {
171 if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
172 $src = $this->base_url . $src;
175 if ( ! empty( $ver ) )
176 $src = add_query_arg( 'ver', $ver, $src );
178 /** This filter is documented in wp-includes/class.wp-scripts.php */
179 $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
184 $tag = "{$cond_before}<script type='text/javascript' src='$src'></script>\n{$cond_after}";
187 * Filter the HTML script tag of an enqueued script.
191 * @param string $tag The `<script>` tag for the enqueued script.
192 * @param string $handle The script's registered handle.
193 * @param string $src The script's source URL.
195 $tag = apply_filters( 'script_loader_tag', $tag, $handle, $src );
197 if ( $this->do_concat ) {
198 $this->print_html .= $tag;
207 * Localizes a script, only if the script has already been added
209 * @param string $handle
210 * @param string $object_name
214 public function localize( $handle, $object_name, $l10n ) {
215 if ( $handle === 'jquery' )
216 $handle = 'jquery-core';
218 if ( is_array($l10n) && isset($l10n['l10n_print_after']) ) { // back compat, preserve the code in 'l10n_print_after' if present
219 $after = $l10n['l10n_print_after'];
220 unset($l10n['l10n_print_after']);
223 foreach ( (array) $l10n as $key => $value ) {
224 if ( !is_scalar($value) )
227 $l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
230 $script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
232 if ( !empty($after) )
233 $script .= "\n$after;";
235 $data = $this->get_data( $handle, 'data' );
237 if ( !empty( $data ) )
238 $script = "$data\n$script";
240 return $this->add_data( $handle, 'data', $script );
244 * @param string $handle Name of the item. Should be unique.
245 * @param bool $recursion Internal flag that calling function was called recursively.
246 * @param mixed $group Group level.
247 * @return bool Not already in the group or a lower group
249 public function set_group( $handle, $recursion, $group = false ) {
250 if ( $this->registered[$handle]->args === 1 )
253 $grp = (int) $this->get_data( $handle, 'group' );
255 if ( false !== $group && $grp > $group )
258 return parent::set_group( $handle, $recursion, $grp );
262 * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
263 * @param bool $recursion Internal flag that function is calling itself.
264 * @param mixed $group Group level: (int) level, (false) no groups.
265 * @return bool True on success, false on failure.
267 public function all_deps( $handles, $recursion = false, $group = false ) {
268 $r = parent::all_deps( $handles, $recursion );
269 if ( ! $recursion ) {
271 * Filter the list of script dependencies left to print.
275 * @param array $to_do An array of script dependencies.
277 $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
285 public function do_head_items() {
286 $this->do_items(false, 0);
293 public function do_footer_items() {
294 $this->do_items(false, 1);
302 public function in_default_dir( $src ) {
303 if ( ! $this->default_dirs ) {
307 if ( 0 === strpos( $src, '/' . WPINC . '/js/l10n' ) ) {
311 foreach ( (array) $this->default_dirs as $test ) {
312 if ( 0 === strpos( $src, $test ) ) {
322 public function reset() {
323 $this->do_concat = false;
324 $this->print_code = '';
326 $this->concat_version = '';
327 $this->print_html = '';
328 $this->ext_version = '';
329 $this->ext_handles = '';