WordPress 3.4

[autoinstalls/wordpress.git] / wp-includes / functions.wp-scripts.php

diff --git a/wp-includes/functions.wp-scripts.php b/wp-includes/functions.wp-scripts.php
index af2055d37b6a9082b21071f9d28f0d656ab6bf38..a8dac35c257b88344ee1ceddbfbe24b597d30f80 100644 (file)
--- 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>init</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,20 +39,24 @@ function wp_print_scripts( $handles = false ) {
 }
 
 /**
- * Register new JavaScript file.
+ * Register new Javascript file.
  *
  * @since r16
  * @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 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>init</code>' ), '3.3' );
                $wp_scripts = new WP_Scripts();
+       }
 
        $wp_scripts->add( $handle, $src, $deps, $ver );
        if ( $in_footer )
@@ -56,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 localizes 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_Scripts::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>init</code>' ), '3.3' );
+
                return false;
+       }
 
        return $wp_scripts->localize( $handle, $object_name, $l10n );
 }
@@ -79,8 +104,12 @@ 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>init</code>' ), '3.3' );
                $wp_scripts = new WP_Scripts();
+       }
 
        $wp_scripts->remove( $handle );
 }
@@ -95,8 +124,12 @@ function wp_deregister_script( $handle ) {
  */
 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>init</code>' ), '3.3' );
                $wp_scripts = new WP_Scripts();
+       }
 
        if ( $src ) {
                $_handle = explode('?', $handle);
@@ -115,8 +148,12 @@ function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false
  */
 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>init</code>' ), '3.3' );
                $wp_scripts = new WP_Scripts();
+       }
 
        $wp_scripts->dequeue( $handle );
 }
@@ -135,8 +172,12 @@ function wp_dequeue_script( $handle ) {
  */
 function wp_script_is( $handle, $list = 'queue' ) {
        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>init</code>' ), '3.3' );
                $wp_scripts = new WP_Scripts();
+       }
 
        $query = $wp_scripts->query( $handle, $list );