]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class.wp-scripts.php
WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / class.wp-scripts.php
index 7652aecef75a594a16cff8bebc7d4d2b3dc2cfad..2cca26c691b4f4f680ef84871f11f6932fd76551 100644 (file)
 <?php
 <?php
+/**
+ * BackPress Scripts enqueue.
+ *
+ * These classes were refactored from the WordPress WP_Scripts and WordPress
+ * script enqueue API.
+ *
+ * @package BackPress
+ * @since r16
+ */
 
 
+/**
+ * BackPress Scripts enqueue class.
+ *
+ * @package BackPress
+ * @uses WP_Dependencies
+ * @since r16
+ */
 class WP_Scripts extends WP_Dependencies {
 class WP_Scripts extends WP_Dependencies {
-       var $base_url; // Full URL with trailing slash
-       var $default_version;
+       public $base_url; // Full URL with trailing slash
+       public $content_url;
+       public $default_version;
+       public $in_footer = array();
+       public $concat = '';
+       public $concat_version = '';
+       public $do_concat = false;
+       public $print_html = '';
+       public $print_code = '';
+       public $ext_handles = '';
+       public $ext_version = '';
+       public $default_dirs;
 
 
-       function __construct() {
+       public function __construct() {
+               $this->init();
+               add_action( 'init', array( $this, 'init' ), 0 );
+       }
+
+       /**
+        * @access public
+        */
+       public function init() {
+               /**
+                * Fires when the WP_Scripts instance is initialized.
+                *
+                * @since 2.6.0
+                *
+                * @param WP_Scripts &$this WP_Scripts instance, passed by reference.
+                */
                do_action_ref_array( 'wp_default_scripts', array(&$this) );
        }
 
        /**
                do_action_ref_array( 'wp_default_scripts', array(&$this) );
        }
 
        /**
-        * Prints scripts
+        * Prints scripts.
         *
         *
-        * Prints the scripts passed to it or the print queue.  Also prints all necessary dependencies.
+        * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
         *
         *
-        * @param mixed handles (optional) Scripts to be printed.  (void) prints queue, (string) prints that script, (array of strings) prints those scripts.
-        * @return array Scripts that have been printed
+        * @param mixed $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
+        *                       that script, (array of strings) prints those scripts. Default false.
+        * @param int   $group   Optional. If scripts were queued in groups prints this group number.
+        *                       Default false.
+        * @return array Scripts that have been printed.
         */
         */
-       function print_scripts( $handles = false ) {
-               return $this->do_items( $handles );
+       public function print_scripts( $handles = false, $group = false ) {
+               return $this->do_items( $handles, $group );
        }
 
        }
 
-       function print_scripts_l10n( $handle ) {
-               if ( empty($this->registered[$handle]->extra['l10n']) || empty($this->registered[$handle]->extra['l10n'][0]) || !is_array($this->registered[$handle]->extra['l10n'][1]) )
-                       return false;
+       /**
+        * @deprecated 3.3
+        * @see print_extra_script()
+        *
+        * @param string $handle
+        * @param bool   $echo
+        * @return bool|string|void
+        */
+       public function print_scripts_l10n( $handle, $echo = true ) {
+               _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
+               return $this->print_extra_script( $handle, $echo );
+       }
+
+       /**
+        * @param string $handle
+        * @param bool   $echo
+        * @return bool|string|void
+        */
+       public function print_extra_script( $handle, $echo = true ) {
+               if ( !$output = $this->get_data( $handle, 'data' ) )
+                       return;
 
 
-               $object_name = $this->registered[$handle]->extra['l10n'][0];
+               if ( !$echo )
+                       return $output;
 
 
-               echo "<script type='text/javascript'>\n";
+               echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5
                echo "/* <![CDATA[ */\n";
                echo "/* <![CDATA[ */\n";
-               echo "\t$object_name = {\n";
-               $eol = '';
-               foreach ( $this->registered[$handle]->extra['l10n'][1] as $var => $val ) {
-                       echo "$eol\t\t$var: \"" . js_escape( $val ) . '"';
-                       $eol = ",\n";
-               }
-               echo "\n\t}\n";
+               echo "$output\n";
                echo "/* ]]> */\n";
                echo "</script>\n";
 
                return true;
        }
 
                echo "/* ]]> */\n";
                echo "</script>\n";
 
                return true;
        }
 
-       function do_item( $handle ) {
+       /**
+        * @param string   $handle Name of the item. Should be unique.
+        * @param int|bool $group
+        * @return bool True on success, false if not set.
+        */
+       public function do_item( $handle, $group = false ) {
                if ( !parent::do_item($handle) )
                        return false;
 
                if ( !parent::do_item($handle) )
                        return false;
 
-               $ver = $this->registered[$handle]->ver ? $this->registered[$handle]->ver : $this->default_version;
+               if ( 0 === $group && $this->groups[$handle] > 0 ) {
+                       $this->in_footer[] = $handle;
+                       return false;
+               }
+
+               if ( false === $group && in_array($handle, $this->in_footer, true) )
+                       $this->in_footer = array_diff( $this->in_footer, (array) $handle );
+
+               $obj = $this->registered[$handle];
+
+               if ( null === $obj->ver ) {
+                       $ver = '';
+               } else {
+                       $ver = $obj->ver ? $obj->ver : $this->default_version;
+               }
+
                if ( isset($this->args[$handle]) )
                if ( isset($this->args[$handle]) )
-                       $ver .= '&amp;' . $this->args[$handle];
+                       $ver = $ver ? $ver . '&amp;' . $this->args[$handle] : $this->args[$handle];
+
+               $src = $obj->src;
+               $cond_before = $cond_after = '';
+               $conditional = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';
+
+               if ( $conditional ) {
+                       $cond_before = "<!--[if {$conditional}]>\n";
+                       $cond_after = "<![endif]-->\n";
+               }
+
+               if ( $this->do_concat ) {
+                       /**
+                        * Filter the script loader source.
+                        *
+                        * @since 2.2.0
+                        *
+                        * @param string $src    Script loader source path.
+                        * @param string $handle Script handle.
+                        */
+                       $srce = apply_filters( 'script_loader_src', $src, $handle );
+                       if ( $this->in_default_dir( $srce ) && ! $conditional ) {
+                               $this->print_code .= $this->print_extra_script( $handle, false );
+                               $this->concat .= "$handle,";
+                               $this->concat_version .= "$handle$ver";
+                               return true;
+                       } else {
+                               $this->ext_handles .= "$handle,";
+                               $this->ext_version .= "$handle$ver";
+                       }
+               }
+
+               $has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
+
+               if ( $has_conditional_data ) {
+                       echo $cond_before;
+               }
 
 
-               $src = $this->registered[$handle]->src;
-               if ( !preg_match('|^https?://|', $src) && !preg_match('|^' . preg_quote(WP_CONTENT_URL) . '|', $src) ) {
+               $this->print_extra_script( $handle );
+
+               if ( $has_conditional_data ) {
+                       echo $cond_after;
+               }
+
+               if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
                        $src = $this->base_url . $src;
                }
 
                        $src = $this->base_url . $src;
                }
 
-               $src = add_query_arg('ver', $ver, $src);
-               $src = clean_url(apply_filters( 'script_loader_src', $src, $handle ));
+               if ( ! empty( $ver ) )
+                       $src = add_query_arg( 'ver', $ver, $src );
+
+               /** This filter is documented in wp-includes/class.wp-scripts.php */
+               $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
+
+               if ( ! $src )
+                       return true;
 
 
-               $this->print_scripts_l10n( $handle );
+               $tag = "{$cond_before}<script type='text/javascript' src='$src'></script>\n{$cond_after}";
 
 
-               echo "<script type='text/javascript' src='$src'></script>\n";
+               /**
+                * Filter the HTML script tag of an enqueued script.
+                *
+                * @since 4.1.0
+                *
+                * @param string $tag    The `<script>` tag for the enqueued script.
+                * @param string $handle The script's registered handle.
+                * @param string $src    The script's source URL.
+                */
+               $tag = apply_filters( 'script_loader_tag', $tag, $handle, $src );
+
+               if ( $this->do_concat ) {
+                       $this->print_html .= $tag;
+               } else {
+                       echo $tag;
+               }
 
                return true;
        }
 
        /**
 
                return true;
        }
 
        /**
-        * Localizes a script
-        *
-        * Localizes only if script has already been added
+        * Localizes a script, only if the script has already been added
         *
         *
-        * @param string handle Script name
-        * @param string object_name Name of JS object to hold l10n info
-        * @param array l10n Array of JS var name => localized string
-        * @return bool Successful localization
+        * @param string $handle
+        * @param string $object_name
+        * @param array $l10n
+        * @return bool
         */
         */
-       function localize( $handle, $object_name, $l10n ) {
-               if ( !$object_name || !$l10n )
-                       return false;
-               return $this->add_data( $handle, 'l10n', array( $object_name, $l10n ) );
+       public function localize( $handle, $object_name, $l10n ) {
+               if ( $handle === 'jquery' )
+                       $handle = 'jquery-core';
+
+               if ( is_array($l10n) && isset($l10n['l10n_print_after']) ) { // back compat, preserve the code in 'l10n_print_after' if present
+                       $after = $l10n['l10n_print_after'];
+                       unset($l10n['l10n_print_after']);
+               }
+
+               foreach ( (array) $l10n as $key => $value ) {
+                       if ( !is_scalar($value) )
+                               continue;
+
+                       $l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
+               }
+
+               $script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
+
+               if ( !empty($after) )
+                       $script .= "\n$after;";
+
+               $data = $this->get_data( $handle, 'data' );
+
+               if ( !empty( $data ) )
+                       $script = "$data\n$script";
+
+               return $this->add_data( $handle, 'data', $script );
+       }
+
+       /**
+        * @param string $handle    Name of the item. Should be unique.
+        * @param bool   $recursion Internal flag that calling function was called recursively.
+        * @param mixed  $group     Group level.
+        * @return bool Not already in the group or a lower group
+        */
+       public function set_group( $handle, $recursion, $group = false ) {
+               if ( $this->registered[$handle]->args === 1 )
+                       $grp = 1;
+               else
+                       $grp = (int) $this->get_data( $handle, 'group' );
+
+               if ( false !== $group && $grp > $group )
+                       $grp = $group;
+
+               return parent::set_group( $handle, $recursion, $grp );
        }
 
        }
 
-       function all_deps( $handles, $recursion = false ) {
+       /**
+        * @param mixed $handles   Item handle and argument (string) or item handles and arguments (array of strings).
+        * @param bool  $recursion Internal flag that function is calling itself.
+        * @param mixed $group     Group level: (int) level, (false) no groups.
+        * @return bool True on success, false on failure.
+        */
+       public function all_deps( $handles, $recursion = false, $group = false ) {
                $r = parent::all_deps( $handles, $recursion );
                $r = parent::all_deps( $handles, $recursion );
-               if ( !$recursion )
+               if ( ! $recursion ) {
+                       /**
+                        * Filter the list of script dependencies left to print.
+                        *
+                        * @since 2.3.0
+                        *
+                        * @param array $to_do An array of script dependencies.
+                        */
                        $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
                        $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
+               }
                return $r;
        }
                return $r;
        }
+
+       /**
+        * @return array
+        */
+       public function do_head_items() {
+               $this->do_items(false, 0);
+               return $this->done;
+       }
+
+       /**
+        * @return array
+        */
+       public function do_footer_items() {
+               $this->do_items(false, 1);
+               return $this->done;
+       }
+
+       /**
+        * @param string $src
+        * @return bool
+        */
+       public function in_default_dir( $src ) {
+               if ( ! $this->default_dirs ) {
+                       return true;
+               }
+
+               if ( 0 === strpos( $src, '/' . WPINC . '/js/l10n' ) ) {
+                       return false;
+               }
+
+               foreach ( (array) $this->default_dirs as $test ) {
+                       if ( 0 === strpos( $src, $test ) ) {
+                               return true;
+                       }
+               }
+               return false;
+       }
+
+       /**
+        * @access public
+        */
+       public function reset() {
+               $this->do_concat = false;
+               $this->print_code = '';
+               $this->concat = '';
+               $this->concat_version = '';
+               $this->print_html = '';
+               $this->ext_version = '';
+               $this->ext_handles = '';
+       }
 }
 }