X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..refs/tags/wordpress-4.3:/wp-includes/class.wp-scripts.php

diff --git a/wp-includes/class.wp-scripts.php b/wp-includes/class.wp-scripts.php
index 5e166321..2cca26c6 100644
--- a/wp-includes/class.wp-scripts.php
+++ b/wp-includes/class.wp-scripts.php
@@ -17,48 +17,72 @@
  * @since r16
  */
 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() {
+	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;
+
+	public function __construct() {
 		$this->init();
 		add_action( 'init', array( $this, 'init' ), 0 );
 	}
 
-	function init() {
+	/**
+	 * @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.
 	 *
-	 * @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
+	 * @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 );
 	}
 
-	// Deprecated since 3.3, see print_extra_script()
-	function print_scripts_l10n( $handle, $echo = true ) {
+	/**
+	 * @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 );
 	}
 
-	function print_extra_script( $handle, $echo = true ) {
+	/**
+	 * @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;
 
@@ -74,7 +98,12 @@ class WP_Scripts extends WP_Dependencies {
 		return true;
 	}
 
-	function do_item( $handle, $group = false ) {
+	/**
+	 * @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;
 
@@ -86,19 +115,37 @@ class WP_Scripts extends WP_Dependencies {
 		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";
+		}
 
 		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) ) {
+			if ( $this->in_default_dir( $srce ) && ! $conditional ) {
 				$this->print_code .= $this->print_extra_script( $handle, false );
 				$this->concat .= "$handle,";
 				$this->concat_version .= "$handle$ver";
@@ -109,33 +156,62 @@ class WP_Scripts extends WP_Dependencies {
 			}
 		}
 
+		$has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
+
+		if ( $has_conditional_data ) {
+			echo $cond_before;
+		}
+
 		$this->print_extra_script( $handle );
-		if ( !preg_match('|^(https?:)?//|', $src) && ! ( $this->content_url && 0 === strpos($src, $this->content_url) ) ) {
+
+		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;
 		}
 
-		if ( !empty($ver) )
-			$src = add_query_arg('ver', $ver, $src);
+		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;
 
-		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";
+		$tag = "{$cond_before}<script type='text/javascript' src='$src'></script>\n{$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
+	 * Localizes a script, only if the script has already been added
 	 *
-	 * Localizes only if the script has already been added
+	 * @param string $handle
+	 * @param string $object_name
+	 * @param array $l10n
+	 * @return bool
 	 */
-	function localize( $handle, $object_name, $l10n ) {
+	public function localize( $handle, $object_name, $l10n ) {
 		if ( $handle === 'jquery' )
 			$handle = 'jquery-core';
 
@@ -151,7 +227,7 @@ class WP_Scripts extends WP_Dependencies {
 			$l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
 		}
 
-		$script = "var $object_name = " . json_encode($l10n) . ';';
+		$script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
 
 		if ( !empty($after) )
 			$script .= "\n$after;";
@@ -164,8 +240,13 @@ class WP_Scripts extends WP_Dependencies {
 		return $this->add_data( $handle, 'data', $script );
 	}
 
-	function set_group( $handle, $recursion, $group = false ) {
-
+	/**
+	 * @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
@@ -177,38 +258,68 @@ class WP_Scripts extends WP_Dependencies {
 		return parent::set_group( $handle, $recursion, $grp );
 	}
 
-	function all_deps( $handles, $recursion = false, $group = 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 );
-		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 );
+		}
 		return $r;
 	}
 
-	function do_head_items() {
+	/**
+	 * @return array
+	 */
+	public function do_head_items() {
 		$this->do_items(false, 0);
 		return $this->done;
 	}
 
-	function do_footer_items() {
+	/**
+	 * @return array
+	 */
+	public function do_footer_items() {
 		$this->do_items(false, 1);
 		return $this->done;
 	}
 
-	function in_default_dir($src) {
-		if ( ! $this->default_dirs )
+	/**
+	 * @param string $src
+	 * @return bool
+	 */
+	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() {
+	/**
+	 * @access public
+	 */
+	public function reset() {
 		$this->do_concat = false;
 		$this->print_code = '';
 		$this->concat = '';