diff -r 2f6f6f7551ca -r 32102edaa81b web/wp-includes/functions.wp-scripts.php --- a/web/wp-includes/functions.wp-scripts.php Thu Sep 16 15:45:36 2010 +0000 +++ b/web/wp-includes/functions.wp-scripts.php Mon Nov 19 18:26:13 2012 +0100 @@ -24,9 +24,13 @@ $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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '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 @@ } /** - * 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 or before + * @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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '3.3' ); $wp_scripts = new WP_Scripts(); + } $wp_scripts->add( $handle, $src, $deps, $ver ); if ( $in_footer ) @@ -51,17 +64,34 @@ } /** - * 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_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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '3.3' ); + return false; + } return $wp_scripts->localize( $handle, $object_name, $l10n ); } @@ -74,8 +104,12 @@ */ 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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '3.3' ); $wp_scripts = new WP_Scripts(); + } $wp_scripts->remove( $handle ); } @@ -86,12 +120,16 @@ * 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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '3.3' ); $wp_scripts = new WP_Scripts(); + } if ( $src ) { $_handle = explode('?', $handle); @@ -103,6 +141,24 @@ } /** + * 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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '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 @@ -116,8 +172,12 @@ */ 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.' ), + 'wp_enqueue_scripts', 'admin_enqueue_scripts', 'init' ), '3.3' ); $wp_scripts = new WP_Scripts(); + } $query = $wp_scripts->query( $handle, $list );