Wordpress 3.5
[autoinstalls/wordpress.git] / wp-includes / class.wp-scripts.php
1 <?php
2 /**
3  * BackPress Scripts enqueue.
4  *
5  * These classes were refactored from the WordPress WP_Scripts and WordPress
6  * script enqueue API.
7  *
8  * @package BackPress
9  * @since r16
10  */
11
12 /**
13  * BackPress Scripts enqueue class.
14  *
15  * @package BackPress
16  * @uses WP_Dependencies
17  * @since r16
18  */
19 class WP_Scripts extends WP_Dependencies {
20         var $base_url; // Full URL with trailing slash
21         var $content_url;
22         var $default_version;
23         var $in_footer = array();
24         var $concat = '';
25         var $concat_version = '';
26         var $do_concat = false;
27         var $print_html = '';
28         var $print_code = '';
29         var $ext_handles = '';
30         var $ext_version = '';
31         var $default_dirs;
32
33         function __construct() {
34                 $this->init();
35                 add_action( 'init', array( $this, 'init' ), 0 );
36         }
37
38         function init() {
39                 do_action_ref_array( 'wp_default_scripts', array(&$this) );
40         }
41
42         /**
43          * Prints scripts
44          *
45          * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
46          *
47          * @param mixed $handles (optional) Scripts to be printed. (void) prints queue, (string) prints that script, (array of strings) prints those scripts.
48          * @param int $group (optional) If scripts were queued in groups prints this group number.
49          * @return array Scripts that have been printed
50          */
51         function print_scripts( $handles = false, $group = false ) {
52                 return $this->do_items( $handles, $group );
53         }
54
55         // Deprecated since 3.3, see print_extra_script()
56         function print_scripts_l10n( $handle, $echo = true ) {
57                 _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
58                 return $this->print_extra_script( $handle, $echo );
59         }
60
61         function print_extra_script( $handle, $echo = true ) {
62                 if ( !$output = $this->get_data( $handle, 'data' ) )
63                         return;
64
65                 if ( !$echo )
66                         return $output;
67
68                 echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5
69                 echo "/* <![CDATA[ */\n";
70                 echo "$output\n";
71                 echo "/* ]]> */\n";
72                 echo "</script>\n";
73
74                 return true;
75         }
76
77         function do_item( $handle, $group = false ) {
78                 if ( !parent::do_item($handle) )
79                         return false;
80
81                 if ( 0 === $group && $this->groups[$handle] > 0 ) {
82                         $this->in_footer[] = $handle;
83                         return false;
84                 }
85
86                 if ( false === $group && in_array($handle, $this->in_footer, true) )
87                         $this->in_footer = array_diff( $this->in_footer, (array) $handle );
88
89                 if ( null === $this->registered[$handle]->ver )
90                         $ver = '';
91                 else
92                         $ver = $this->registered[$handle]->ver ? $this->registered[$handle]->ver : $this->default_version;
93
94                 if ( isset($this->args[$handle]) )
95                         $ver = $ver ? $ver . '&amp;' . $this->args[$handle] : $this->args[$handle];
96
97                 $src = $this->registered[$handle]->src;
98
99                 if ( $this->do_concat ) {
100                         $srce = apply_filters( 'script_loader_src', $src, $handle );
101                         if ( $this->in_default_dir($srce) ) {
102                                 $this->print_code .= $this->print_extra_script( $handle, false );
103                                 $this->concat .= "$handle,";
104                                 $this->concat_version .= "$handle$ver";
105                                 return true;
106                         } else {
107                                 $this->ext_handles .= "$handle,";
108                                 $this->ext_version .= "$handle$ver";
109                         }
110                 }
111
112                 $this->print_extra_script( $handle );
113                 if ( !preg_match('|^(https?:)?//|', $src) && ! ( $this->content_url && 0 === strpos($src, $this->content_url) ) ) {
114                         $src = $this->base_url . $src;
115                 }
116
117                 if ( !empty($ver) )
118                         $src = add_query_arg('ver', $ver, $src);
119
120                 $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
121
122                 if ( $this->do_concat )
123                         $this->print_html .= "<script type='text/javascript' src='$src'></script>\n";
124                 else
125                         echo "<script type='text/javascript' src='$src'></script>\n";
126
127                 return true;
128         }
129
130         /**
131          * Localizes a script
132          *
133          * Localizes only if the script has already been added
134          */
135         function localize( $handle, $object_name, $l10n ) {
136                 if ( is_array($l10n) && isset($l10n['l10n_print_after']) ) { // back compat, preserve the code in 'l10n_print_after' if present
137                         $after = $l10n['l10n_print_after'];
138                         unset($l10n['l10n_print_after']);
139                 }
140
141                 foreach ( (array) $l10n as $key => $value ) {
142                         if ( !is_scalar($value) )
143                                 continue;
144
145                         $l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
146                 }
147
148                 $script = "var $object_name = " . json_encode($l10n) . ';';
149
150                 if ( !empty($after) )
151                         $script .= "\n$after;";
152
153                 $data = $this->get_data( $handle, 'data' );
154
155                 if ( !empty( $data ) )
156                         $script = "$data\n$script";
157
158                 return $this->add_data( $handle, 'data', $script );
159         }
160
161         function set_group( $handle, $recursion, $group = false ) {
162
163                 if ( $this->registered[$handle]->args === 1 )
164                         $grp = 1;
165                 else
166                         $grp = (int) $this->get_data( $handle, 'group' );
167
168                 if ( false !== $group && $grp > $group )
169                         $grp = $group;
170
171                 return parent::set_group( $handle, $recursion, $grp );
172         }
173
174         function all_deps( $handles, $recursion = false, $group = false ) {
175                 $r = parent::all_deps( $handles, $recursion );
176                 if ( !$recursion )
177                         $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
178                 return $r;
179         }
180
181         function do_head_items() {
182                 $this->do_items(false, 0);
183                 return $this->done;
184         }
185
186         function do_footer_items() {
187                 $this->do_items(false, 1);
188                 return $this->done;
189         }
190
191         function in_default_dir($src) {
192                 if ( ! $this->default_dirs )
193                         return true;
194
195                 if ( 0 === strpos( $src, '/wp-includes/js/l10n' ) )
196                         return false;
197
198                 foreach ( (array) $this->default_dirs as $test ) {
199                         if ( 0 === strpos($src, $test) )
200                                 return true;
201                 }
202                 return false;
203         }
204
205         function reset() {
206                 $this->do_concat = false;
207                 $this->print_code = '';
208                 $this->concat = '';
209                 $this->concat_version = '';
210                 $this->print_html = '';
211                 $this->ext_version = '';
212                 $this->ext_handles = '';
213         }
214 }