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

diff --git a/wp-includes/functions.wp-scripts.php b/wp-includes/functions.wp-scripts.php
index 0a60c968..32778ab5 100644
--- a/wp-includes/functions.wp-scripts.php
+++ b/wp-includes/functions.wp-scripts.php
@@ -24,9 +24,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 +39,24 @@ function wp_print_scripts( $handles = false ) {
 }
 
 /**
- * Register new JavaScript file.
+ * Register new Javascript file.
  *
  * @since r16
- * @see WP_Dependencies::add() For parameter information.
+ * @param string $handle Script name
+ * @param string $src Script url
+ * @param array $deps (optional) Array of script names on which this script depends
+ * @param string|bool $ver (optional) Script version (used for cache busting), set to null to disable
+ * @param bool $in_footer (optional) Whether to enqueue the script before </head> or before </body>
+ * @return null
  */
 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 +64,34 @@ function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_f
 }
 
 /**
- * Localizes a script.
+ * Wrapper for $wp_scripts->localize().
  *
- * Localizes only if script has already been added.
+ * Used to localize a script.
+ * Works only if the script has already been added.
+ * Accepts an associative array $l10n and creates JS object:
+ * "$object_name" = {
+ *   key: value,
+ *   key: value,
+ *   ...
+ * }
+ * See http://core.trac.wordpress.org/ticket/11520 for more information.
  *
  * @since r16
- * @see WP_Script::localize()
+ *
+ * @param string $handle The script handle that was registered or used in script-loader
+ * @param string $object_name Name for the created JS object. This is passed directly so it should be qualified JS variable /[a-zA-Z0-9_]+/
+ * @param array $l10n Associative PHP array containing the translated strings. HTML entities will be converted and the array will be JSON encoded.
+ * @return bool Whether the localization was added successfully.
  */
 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 );
 }
@@ -74,8 +104,32 @@ function wp_localize_script( $handle, $object_name, $l10n ) {
  */
 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 deregistering of critical scripts in the admin. Show minimal remorse if the correct hook is used.
+	if ( is_admin() && 'admin_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 );
 }
@@ -86,12 +140,16 @@ function wp_deregister_script( $handle ) {
  * Registers the script if src provided (does NOT overwrite) and enqueues.
  *
  * @since r16
- * @see WP_Script::add(), WP_Script::enqueue()
-*/
+ * @see wp_register_script() For parameter information.
+ */
 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);
@@ -102,27 +160,46 @@ function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false
 	$wp_scripts->enqueue( $handle );
 }
 
+/**
+ * Remove an enqueued script.
+ *
+ * @since WP 3.1
+ * @see WP_Scripts::dequeue() For parameter information.
+ */
+function wp_dequeue_script( $handle ) {
+	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();
+	}
+
+	$wp_scripts->dequeue( $handle );
+}
+
 /**
  * Check whether script has been added to WordPress Scripts.
  *
- * The values for list defaults to 'queue', which is the same as enqueue for
- * scripts.
+ * By default, checks if the script has been enqueued. You can also
+ * pass 'registered' to $list, to see if the script is registered,
+ * and you can check processing statuses with 'to_do' and 'done'.
  *
  * @since WP unknown; BP unknown
  *
- * @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.
+ * @param string $list Optional. Defaults to 'enqueued'. Values are
+ * 	'registered', 'enqueued' (or 'queue'), 'to_do', and 'done'.
+ * @return bool Whether script is in the list.
  */
-function wp_script_is( $handle, $list = 'queue' ) {
+function wp_script_is( $handle, $list = 'enqueued' ) {
 	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 );
-
-	if ( is_object( $query ) )
-		return true;
-
-	return $query;
+	return (bool) $wp_scripts->query( $handle, $list );
 }