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 if ( null === $this->registered[$handle]->ver )
101 $ver = $this->registered[$handle]->ver ? $this->registered[$handle]->ver : $this->default_version;
103 if ( isset($this->args[$handle]) )
104 $ver = $ver ? $ver . '&' . $this->args[$handle] : $this->args[$handle];
106 $src = $this->registered[$handle]->src;
108 if ( $this->do_concat ) {
110 * Filter the script loader source.
114 * @param string $src Script loader source path.
115 * @param string $handle Script handle.
117 $srce = apply_filters( 'script_loader_src', $src, $handle );
118 if ( $this->in_default_dir($srce) ) {
119 $this->print_code .= $this->print_extra_script( $handle, false );
120 $this->concat .= "$handle,";
121 $this->concat_version .= "$handle$ver";
124 $this->ext_handles .= "$handle,";
125 $this->ext_version .= "$handle$ver";
129 $this->print_extra_script( $handle );
130 if ( !preg_match('|^(https?:)?//|', $src) && ! ( $this->content_url && 0 === strpos($src, $this->content_url) ) ) {
131 $src = $this->base_url . $src;
135 $src = add_query_arg('ver', $ver, $src);
137 /** This filter is documented in wp-includes/class.wp-scripts.php */
138 $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
143 $tag = "<script type='text/javascript' src='$src'></script>\n";
146 * Filter the HTML script tag of an enqueued script.
150 * @param string $tag The `<script>` tag for the enqueued script.
151 * @param string $handle The script's registered handle.
152 * @param string $src The script's source URL.
154 $tag = apply_filters( 'script_loader_tag', $tag, $handle, $src );
156 if ( $this->do_concat ) {
157 $this->print_html .= $tag;
168 * Localizes only if the script has already been added
170 public function localize( $handle, $object_name, $l10n ) {
171 if ( $handle === 'jquery' )
172 $handle = 'jquery-core';
174 if ( is_array($l10n) && isset($l10n['l10n_print_after']) ) { // back compat, preserve the code in 'l10n_print_after' if present
175 $after = $l10n['l10n_print_after'];
176 unset($l10n['l10n_print_after']);
179 foreach ( (array) $l10n as $key => $value ) {
180 if ( !is_scalar($value) )
183 $l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
186 $script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
188 if ( !empty($after) )
189 $script .= "\n$after;";
191 $data = $this->get_data( $handle, 'data' );
193 if ( !empty( $data ) )
194 $script = "$data\n$script";
196 return $this->add_data( $handle, 'data', $script );
199 public function set_group( $handle, $recursion, $group = false ) {
201 if ( $this->registered[$handle]->args === 1 )
204 $grp = (int) $this->get_data( $handle, 'group' );
206 if ( false !== $group && $grp > $group )
209 return parent::set_group( $handle, $recursion, $grp );
212 public function all_deps( $handles, $recursion = false, $group = false ) {
213 $r = parent::all_deps( $handles, $recursion );
214 if ( ! $recursion ) {
216 * Filter the list of script dependencies left to print.
220 * @param array $to_do An array of script dependencies.
222 $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
227 public function do_head_items() {
228 $this->do_items(false, 0);
232 public function do_footer_items() {
233 $this->do_items(false, 1);
237 public function in_default_dir( $src ) {
238 if ( ! $this->default_dirs ) {
242 if ( 0 === strpos( $src, '/' . WPINC . '/js/l10n' ) ) {
246 foreach ( (array) $this->default_dirs as $test ) {
247 if ( 0 === strpos( $src, $test ) ) {
254 public function reset() {
255 $this->do_concat = false;
256 $this->print_code = '';
258 $this->concat_version = '';
259 $this->print_html = '';
260 $this->ext_version = '';
261 $this->ext_handles = '';