X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/d3b1ea255664edd2deef17f900a655613d20820d..refs/tags/wordpress-3.7:/wp-includes/functions.wp-scripts.php

diff --git a/wp-includes/functions.wp-scripts.php b/wp-includes/functions.wp-scripts.php
index 0a60c968..e89553b1 100644
--- a/wp-includes/functions.wp-scripts.php
+++ b/wp-includes/functions.wp-scripts.php
@@ -1,22 +1,28 @@
 <?php
 /**
- * BackPress script procedural API.
+ * BackPress Scripts Procedural API
  *
- * @package BackPress
- * @since r16
+ * @since 2.6.0
+ *
+ * @package WordPress
+ * @subpackage BackPress
  */
 
 /**
- * Prints script tags in document head.
+ * Print scripts in document head that are in the $handles queue.
+ *
+ * Called by admin-header.php and wp_head hook. Since it is called by wp_head on every page load,
+ * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
+ * Makes use of already-instantiated $wp_scripts global if present. Use provided wp_print_scripts
+ * hook to register/enqueue new scripts.
+ *
+ * @see WP_Scripts::do_items()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  *
- * Called by admin-header.php and by wp_head hook. Since it is called by wp_head
- * on every page load, the function does not instantiate the WP_Scripts object
- * unless script names are explicitly passed. Does make use of already
- * instantiated $wp_scripts if present. Use provided wp_print_scripts hook to
- * register/enqueue new scripts.
+ * @since 2.6.0
  *
- * @since r16
- * @see WP_Dependencies::print_scripts()
+ * @param array|bool $handles Optional. Scripts to be printed. Default 'false'.
+ * @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array.
  */
 function wp_print_scripts( $handles = false ) {
 	do_action( 'wp_print_scripts' );
@@ -24,9 +30,13 @@ function wp_print_scripts( $handles = false ) {
 		$handles = false;
 
 	global $wp_scripts;
-	if ( !is_a($wp_scripts, 'WP_Scripts') ) {
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
+
 		if ( !$handles )
-			return array(); // No need to instantiate if nothing's there.
+			return array(); // No need to instantiate if nothing is there.
 		else
 			$wp_scripts = new WP_Scripts();
 	}
@@ -35,15 +45,34 @@ function wp_print_scripts( $handles = false ) {
 }
 
 /**
- * Register new JavaScript file.
+ * Register a new script.
+ *
+ * Registers a script to be linked later using the wp_enqueue_script() function.
  *
- * @since r16
- * @see WP_Dependencies::add() For parameter information.
+ * @see WP_Dependencies::add(), WP_Dependencies::add_data()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.6.0
+ *
+ * @param string      $handle    Name of the script. Should be unique.
+ * @param string      $src       Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
+ * @param array       $deps      Optional. An array of registered script handles this script depends on. Set to false if there
+ *                               are no dependencies. Default empty array.
+ * @param string|bool $ver       Optional. String specifying script version number, if it has one, which is concatenated
+ *                               to end of path as a query string. If no version is specified or set to false, a version
+ *                               number is automatically added equal to current installed WordPress version.
+ *                               If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
+ * @param bool        $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
+ *                               Default 'false'. Accepts 'false' or 'true'.
  */
 function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
 	global $wp_scripts;
-	if ( !is_a($wp_scripts, 'WP_Scripts') )
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
 		$wp_scripts = new WP_Scripts();
+	}
 
 	$wp_scripts->add( $handle, $src, $deps, $ver );
 	if ( $in_footer )
@@ -51,17 +80,40 @@ function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_f
 }
 
 /**
- * Localizes a script.
+ * Localize a script.
+ *
+ * Works only if the script has already been added.
  *
- * Localizes only if script has already been added.
+ * Accepts an associative array $l10n and creates a JavaScript object:
+ * <code>
+ * "$object_name" = {
+ *       key: value,
+ *       key: value,
+ *       ...
+ * }
+ * </code>
  *
- * @since r16
- * @see WP_Script::localize()
+ * @see WP_Dependencies::localize()
+ * @link http://core.trac.wordpress.org/ticket/11520
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.6.0
+ *
+ * @param string $handle      Script handle the data will be attached to.
+ * @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
+ *                            Example: '/[a-zA-Z0-9_]+/'.
+ * @param array $l10n         The data itself. The data can be either a single or multi-dimensional array.
+ * @return bool True if the script was successfully localized, false otherwise.
  */
 function wp_localize_script( $handle, $object_name, $l10n ) {
 	global $wp_scripts;
-	if ( !is_a($wp_scripts, 'WP_Scripts') )
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
+
 		return false;
+	}
 
 	return $wp_scripts->localize( $handle, $object_name, $l10n );
 }
@@ -69,29 +121,80 @@ function wp_localize_script( $handle, $object_name, $l10n ) {
 /**
  * Remove a registered script.
  *
- * @since r16
- * @see WP_Scripts::remove() For parameter information.
+ * Note: there are intentional safeguards in place to prevent critical admin scripts,
+ * such as jQuery core, from being unregistered.
+ *
+ * @see WP_Dependencies::remove()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.6.0
+ *
+ * @param string $handle Name of the script to be removed.
  */
 function wp_deregister_script( $handle ) {
 	global $wp_scripts;
-	if ( !is_a($wp_scripts, 'WP_Scripts') )
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
 		$wp_scripts = new WP_Scripts();
+	}
+
+	/**
+	 * Do not allow accidental or negligent de-registering of critical scripts in the admin.
+	 * Show minimal remorse if the correct hook is used.
+	 */
+	$current_filter = current_filter();
+	if ( ( is_admin() && 'admin_enqueue_scripts' !== $current_filter ) ||
+		( 'wp-login.php' === $GLOBALS['pagenow'] && 'login_enqueue_scripts' !== $current_filter )
+	) {
+		$no = array(
+			'jquery', 'jquery-core', 'jquery-migrate', 'jquery-ui-core', 'jquery-ui-accordion',
+			'jquery-ui-autocomplete', 'jquery-ui-button', 'jquery-ui-datepicker', 'jquery-ui-dialog',
+			'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-menu', 'jquery-ui-mouse',
+			'jquery-ui-position', 'jquery-ui-progressbar', 'jquery-ui-resizable', 'jquery-ui-selectable',
+			'jquery-ui-slider', 'jquery-ui-sortable', 'jquery-ui-spinner', 'jquery-ui-tabs',
+			'jquery-ui-tooltip', 'jquery-ui-widget', 'underscore', 'backbone',
+		);
+
+		if ( in_array( $handle, $no ) ) {
+			$message = sprintf( __( 'Do not deregister the %1$s script in the administration area. To target the frontend theme, use the %2$s hook.' ),
+				"<code>$handle</code>", '<code>wp_enqueue_scripts</code>' );
+			_doing_it_wrong( __FUNCTION__, $message, '3.6' );
+			return;
+		}
+	}
 
 	$wp_scripts->remove( $handle );
 }
 
 /**
- * Enqueues script.
+ * Enqueue a script.
  *
- * Registers the script if src provided (does NOT overwrite) and enqueues.
+ * Registers the script if $src provided (does NOT overwrite), and enqueues it.
  *
- * @since r16
- * @see WP_Script::add(), WP_Script::enqueue()
-*/
+ * @see WP_Dependencies::add(), WP_Dependencies::add_data(), WP_Dependencies::enqueue()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.6.0
+
+ * @param string      $handle    Name of the script.
+ * @param string|bool $src       Path to the script from the root directory of WordPress. Example: '/js/myscript.js'.
+ * @param array       $deps      An array of registered handles this script depends on. Default empty array.
+ * @param string|bool $ver       Optional. String specifying the script version number, if it has one. This parameter
+ *                               is used to ensure that the correct version is sent to the client regardless of caching,
+ *                               and so should be included if a version number is available and makes sense for the script.
+ * @param bool        $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
+ *                               Default 'false'. Accepts 'false' or 'true'.
+ */
 function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) {
 	global $wp_scripts;
-	if ( !is_a($wp_scripts, 'WP_Scripts') )
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
 		$wp_scripts = new WP_Scripts();
+	}
 
 	if ( $src ) {
 		$_handle = explode('?', $handle);
@@ -103,26 +206,48 @@ function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false
 }
 
 /**
- * Check whether script has been added to WordPress Scripts.
+ * Remove a previously enqueued script.
  *
- * The values for list defaults to 'queue', which is the same as enqueue for
- * scripts.
+ * @see WP_Dependencies::dequeue()
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  *
- * @since WP unknown; BP unknown
+ * @since 3.1.0
  *
- * @param string $handle Handle used to add script.
- * @param string $list Optional, defaults to 'queue'. Others values are 'registered', 'queue', 'done', 'to_do'
- * @return bool
+ * @param string $handle Name of the script to be removed.
  */
-function wp_script_is( $handle, $list = 'queue' ) {
+function wp_dequeue_script( $handle ) {
 	global $wp_scripts;
-	if ( !is_a($wp_scripts, 'WP_Scripts') )
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
 		$wp_scripts = new WP_Scripts();
+	}
 
-	$query = $wp_scripts->query( $handle, $list );
+	$wp_scripts->dequeue( $handle );
+}
 
-	if ( is_object( $query ) )
-		return true;
+/**
+ * Check whether a script has been added to the queue.
+ *
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 2.8.0
+ * @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
+ *
+ * @param string $handle Name of the script.
+ * @param string $list   Optional. Status of the script to check. Default 'enqueued'.
+ *                       Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.
+ * @return bool Whether the script script is queued.
+ */
+function wp_script_is( $handle, $list = 'enqueued' ) {
+	global $wp_scripts;
+	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
+		if ( ! did_action( 'init' ) )
+			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
+				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
+		$wp_scripts = new WP_Scripts();
+	}
 
-	return $query;
+	return (bool) $wp_scripts->query( $handle, $list );
 }