<?php
/**
- * BackPress Scripts enqueue.
+ * Dependencies API: WP_Scripts class
*
- * These classes were refactored from the WordPress WP_Scripts and WordPress
- * script enqueue API.
+ * @since 2.6.0
*
- * @package BackPress
- * @since r16
+ * @package WordPress
+ * @subpackage Dependencies
*/
/**
- * BackPress Scripts enqueue class.
+ * Core class used to register scripts.
*
- * @package BackPress
+ * @package WordPress
* @uses WP_Dependencies
- * @since r16
+ * @since 2.1.0
*/
class WP_Scripts extends WP_Dependencies {
- var $base_url; // Full URL with trailing slash
- var $content_url;
- var $default_version;
- var $in_footer = array();
- var $concat = '';
- var $concat_version = '';
- var $do_concat = false;
- var $print_html = '';
- var $print_code = '';
- var $ext_handles = '';
- var $ext_version = '';
- var $default_dirs;
-
- function __construct() {
+ /**
+ * Base URL for scripts.
+ *
+ * Full URL with trailing slash.
+ *
+ * @since 2.6.0
+ * @access public
+ * @var string
+ */
+ public $base_url;
+
+ /**
+ * URL of the content directory.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
+ public $content_url;
+
+ /**
+ * Default version string for stylesheets.
+ *
+ * @since 2.6.0
+ * @access public
+ * @var string
+ */
+ public $default_version;
+
+ /**
+ * Holds handles of scripts which are enqueued in footer.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var array
+ */
+ public $in_footer = array();
+
+ /**
+ * Holds a list of script handles which will be concatenated.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
+ public $concat = '';
+
+ /**
+ * Holds a string which contains script handles and their version.
+ *
+ * @since 2.8.0
+ * @deprecated 3.4.0
+ * @access public
+ * @var string
+ */
+ public $concat_version = '';
+
+ /**
+ * Whether to perform concatenation.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var bool
+ */
+ public $do_concat = false;
+
+ /**
+ * Holds HTML markup of scripts and additional data if concatenation
+ * is enabled.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
+ public $print_html = '';
+
+ /**
+ * Holds inline code if concatenation is enabled.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
+ public $print_code = '';
+
+ /**
+ * Holds a list of script handles which are not in the default directory
+ * if concatenation is enabled.
+ *
+ * Unused in core.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
+ public $ext_handles = '';
+
+ /**
+ * Holds a string which contains handles and versions of scripts which
+ * are not in the default directory if concatenation is enabled.
+ *
+ * Unused in core.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var string
+ */
+ public $ext_version = '';
+
+ /**
+ * List of default directories.
+ *
+ * @since 2.8.0
+ * @access public
+ * @var array
+ */
+ public $default_dirs;
+
+ /**
+ * Constructor.
+ *
+ * @since 2.6.0
+ * @access public
+ */
+ public function __construct() {
+ $this->init();
+ add_action( 'init', array( $this, 'init' ), 0 );
+ }
+
+ /**
+ * Initialize the class.
+ *
+ * @since 3.4.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) );
}
/**
- * 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.
- * @param int $group (optional) If scripts were queued in groups prints this group number.
- * @return array Scripts that have been printed
+ * @since 2.1.0
+ * @since 2.8.0 Added the `$group` parameter.
+ * @access public
+ *
+ * @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, $group = false ) {
+ public function print_scripts( $handles = false, $group = false ) {
return $this->do_items( $handles, $group );
}
- function print_scripts_l10n( $handle, $echo = true ) {
- if ( empty($this->registered[$handle]->extra['l10n']) || empty($this->registered[$handle]->extra['l10n'][0]) || !is_array($this->registered[$handle]->extra['l10n'][1]) )
- return false;
+ /**
+ * Prints extra scripts of a registered script.
+ *
+ * @since 2.1.0
+ * @since 2.8.0 Added the `$echo` parameter.
+ * @deprecated 3.3.0
+ * @access public
+ *
+ * @see print_extra_script()
+ *
+ * @param string $handle The script's registered handle.
+ * @param bool $echo Optional. Whether to echo the extra script instead of just returning it.
+ * Default true.
+ * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true, true otherwise.
+ */
+ public function print_scripts_l10n( $handle, $echo = true ) {
+ _deprecated_function( __FUNCTION__, '3.3', 'print_extra_script()' );
+ return $this->print_extra_script( $handle, $echo );
+ }
+
+ /**
+ * Prints extra scripts of a registered script.
+ *
+ * @since 3.3.0
+ * @access public
+ *
+ * @param string $handle The script's registered handle.
+ * @param bool $echo Optional. Whether to echo the extra script instead of just returning it.
+ * Default true.
+ * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true, true otherwise.
+ */
+ 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;
- $data = "var $object_name = {\n";
- $eol = '';
- foreach ( $this->registered[$handle]->extra['l10n'][1] as $var => $val ) {
- if ( 'l10n_print_after' == $var ) {
- $after = $val;
- continue;
- }
- $data .= "$eol\t$var: \"" . esc_js( $val ) . '"';
- $eol = ",\n";
- }
- $data .= "\n};\n";
- $data .= isset($after) ? "$after\n" : '';
+ echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5
+ echo "/* <![CDATA[ */\n";
+ echo "$output\n";
+ echo "/* ]]> */\n";
+ echo "</script>\n";
- if ( $echo ) {
- echo "<script type='text/javascript'>\n";
- echo "/* <![CDATA[ */\n";
- echo $data;
- echo "/* ]]> */\n";
- echo "</script>\n";
- return true;
- } else {
- return $data;
- }
+ return true;
}
- function do_item( $handle, $group = false ) {
+ /**
+ * Processes a script dependency.
+ *
+ * @since 2.6.0
+ * @since 2.8.0 Added the `$group` parameter.
+ * @access public
+ *
+ * @see WP_Dependencies::do_item()
+ *
+ * @param string $handle The script's registered handle.
+ * @param int|false $group Optional. Group level: (int) level, (false) no groups. Default false.
+ * @return bool True on success, false on failure.
+ */
+ public function do_item( $handle, $group = false ) {
if ( !parent::do_item($handle) )
return false;
if ( false === $group && in_array($handle, $this->in_footer, true) )
$this->in_footer = array_diff( $this->in_footer, (array) $handle );
- if ( null === $this->registered[$handle]->ver )
+ $obj = $this->registered[$handle];
+
+ if ( null === $obj->ver ) {
$ver = '';
- else
- $ver = $this->registered[$handle]->ver ? $this->registered[$handle]->ver : $this->default_version;
+ } else {
+ $ver = $obj->ver ? $obj->ver : $this->default_version;
+ }
if ( isset($this->args[$handle]) )
$ver = $ver ? $ver . '&' . $this->args[$handle] : $this->args[$handle];
- $src = $this->registered[$handle]->src;
+ $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";
+ }
+
+ $before_handle = $this->print_inline_script( $handle, 'before', false );
+ $after_handle = $this->print_inline_script( $handle, 'after', false );
+
+ if ( $before_handle ) {
+ $before_handle = sprintf( "<script type='text/javascript'>\n%s\n</script>\n", $before_handle );
+ }
+
+ if ( $after_handle ) {
+ $after_handle = sprintf( "<script type='text/javascript'>\n%s\n</script>\n", $after_handle );
+ }
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) ) {
- $this->print_code .= $this->print_scripts_l10n( $handle, false );
+
+ if ( $this->in_default_dir( $srce ) && ( $before_handle || $after_handle ) ) {
+ $this->do_concat = false;
+
+ // Have to print the so-far concatenated scripts right away to maintain the right order.
+ _print_scripts();
+ $this->reset();
+ } elseif ( $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;
}
}
- $this->print_scripts_l10n( $handle );
- if ( !preg_match('|^https?://|', $src) && ! ( $this->content_url && 0 === strpos($src, $this->content_url) ) ) {
+ $has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
+
+ if ( $has_conditional_data ) {
+ echo $cond_before;
+ }
+
+ $this->print_extra_script( $handle );
+
+ if ( $has_conditional_data ) {
+ echo $cond_after;
+ }
+
+ // A single item may alias a set of items, by having dependencies, but no source.
+ if ( ! $obj->src ) {
+ return true;
+ }
+
+ if ( ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) {
$src = $this->base_url . $src;
}
- if ( !empty($ver) )
- $src = add_query_arg('ver', $ver, $src);
- $src = esc_url(apply_filters( 'script_loader_src', $src, $handle ));
+ if ( ! empty( $ver ) )
+ $src = add_query_arg( 'ver', $ver, $src );
- if ( $this->do_concat )
- $this->print_html .= "<script type='text/javascript' src='$src'></script>\n";
- else
- echo "<script type='text/javascript' src='$src'></script>\n";
+ /** 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;
+
+ $tag = "{$cond_before}{$before_handle}<script type='text/javascript' src='$src'></script>\n{$after_handle}{$cond_after}";
+
+ /**
+ * 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;
}
/**
- * Localizes a script
+ * Adds extra code to a registered script.
*
- * Localizes only if script has already been added
+ * @since 4.5.0
+ * @access public
*
- * @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 Name of the script to add the inline script to. Must be lowercase.
+ * @param string $data String containing the javascript to be added.
+ * @param string $position Optional. Whether to add the inline script before the handle
+ * or after. Default 'after'.
+ * @return bool True on success, false on failure.
*/
- function localize( $handle, $object_name, $l10n ) {
- if ( !$object_name || !$l10n )
+ public function add_inline_script( $handle, $data, $position = 'after' ) {
+ if ( ! $data ) {
return false;
- return $this->add_data( $handle, 'l10n', array( $object_name, $l10n ) );
+ }
+
+ if ( 'after' !== $position ) {
+ $position = 'before';
+ }
+
+ $script = (array) $this->get_data( $handle, $position );
+ $script[] = $data;
+
+ return $this->add_data( $handle, $position, $script );
}
- function set_group( $handle, $recursion, $group = false ) {
- $grp = isset($this->registered[$handle]->extra['group']) ? (int) $this->registered[$handle]->extra['group'] : 0;
+ /**
+ * Prints inline scripts registered for a specific handle.
+ *
+ * @since 4.5.0
+ * @access public
+ *
+ * @param string $handle Name of the script to add the inline script to. Must be lowercase.
+ * @param string $position Optional. Whether to add the inline script before the handle
+ * or after. Default 'after'.
+ * @param bool $echo Optional. Whether to echo the script instead of just returning it.
+ * Default true.
+ * @return string|false Script on success, false otherwise.
+ */
+ public function print_inline_script( $handle, $position = 'after', $echo = true ) {
+ $output = $this->get_data( $handle, $position );
+
+ if ( empty( $output ) ) {
+ return false;
+ }
+
+ $output = trim( implode( "\n", $output ), "\n" );
+
+ if ( $echo ) {
+ printf( "<script type='text/javascript'>\n%s\n</script>\n", $output );
+ }
+
+ return $output;
+ }
+
+ /**
+ * Localizes a script, only if the script has already been added.
+ *
+ * @since 2.1.0
+ * @access public
+ *
+ * @param string $handle
+ * @param string $object_name
+ * @param array $l10n
+ * @return bool
+ */
+ 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 );
+ }
+
+ /**
+ * Sets handle group.
+ *
+ * @since 2.8.0
+ * @access public
+ *
+ * @see WP_Dependencies::set_group()
+ *
+ * @param string $handle Name of the item. Should be unique.
+ * @param bool $recursion Internal flag that calling function was called recursively.
+ * @param int|false $group Optional. Group level: (int) level, (false) no groups. Default false.
+ * @return bool Not already in the group or a lower group
+ */
+ public function set_group( $handle, $recursion, $group = false ) {
+ if ( isset( $this->registered[$handle]->args ) && $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, $group = false ) {
- $r = parent::all_deps( $handles, $recursion );
- if ( !$recursion )
+ /**
+ * Determines script dependencies.
+ *
+ * @since 2.1.0
+ * @access public
+ *
+ * @see WP_Dependencies::all_deps()
+ *
+ * @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 int|false $group Optional. Group level: (int) level, (false) no groups. Default false.
+ * @return bool True on success, false on failure.
+ */
+ public function all_deps( $handles, $recursion = false, $group = false ) {
+ $r = parent::all_deps( $handles, $recursion, $group );
+ 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 );
+ }
return $r;
}
- function do_head_items() {
+ /**
+ * Processes items and dependencies for the head group.
+ *
+ * @since 2.8.0
+ * @access public
+ *
+ * @see WP_Dependencies::do_items()
+ *
+ * @return array Handles of items that have been processed.
+ */
+ public function do_head_items() {
$this->do_items(false, 0);
return $this->done;
}
- function do_footer_items() {
- if ( !empty($this->in_footer) ) {
- foreach( $this->in_footer as $key => $handle ) {
- if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) {
- $this->do_item($handle);
- $this->done[] = $handle;
- unset( $this->in_footer[$key] );
- }
- }
- }
+ /**
+ * Processes items and dependencies for the footer group.
+ *
+ * @since 2.8.0
+ * @access public
+ *
+ * @see WP_Dependencies::do_items()
+ *
+ * @return array Handles of items that have been processed.
+ */
+ public function do_footer_items() {
+ $this->do_items(false, 1);
return $this->done;
}
- function in_default_dir($src) {
- if ( ! $this->default_dirs )
+ /**
+ * Whether a handle's source is in a default directory.
+ *
+ * @since 2.8.0
+ * @access public
+ *
+ * @param string $src The source of the enqueued script.
+ * @return bool True if found, false if not.
+ */
+ public function in_default_dir( $src ) {
+ if ( ! $this->default_dirs ) {
return true;
+ }
- if ( 0 === strpos( $src, '/wp-includes/js/l10n' ) )
+ if ( 0 === strpos( $src, '/' . WPINC . '/js/l10n' ) ) {
return false;
+ }
foreach ( (array) $this->default_dirs as $test ) {
- if ( 0 === strpos($src, $test) )
+ if ( 0 === strpos( $src, $test ) ) {
return true;
+ }
}
return false;
}
- function reset() {
+ /**
+ * Resets class properties.
+ *
+ * @since 2.8.0
+ * @access public
+ */
+ public function reset() {
$this->do_concat = false;
$this->print_code = '';
$this->concat = '';
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff