wp/wp-includes/functions.wp-scripts.php
author ymh <ymh.work@gmail.com>
Wed, 06 Nov 2013 03:21:17 +0000
changeset 0 d970ebf37754
child 5 5e2f62d02dcd
permissions -rw-r--r--
first import
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * BackPress Scripts Procedural API
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * @since 2.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 * @package WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 * @subpackage BackPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
 * Print scripts in document head that are in the $handles queue.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
 * Called by admin-header.php and wp_head hook. Since it is called by wp_head on every page load,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
 * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
 * Makes use of already-instantiated $wp_scripts global if present. Use provided wp_print_scripts
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
 * hook to register/enqueue new scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
 * @see WP_Scripts::do_items()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
 * @since 2.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
 * @param array|bool $handles Optional. Scripts to be printed. Default 'false'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
 * @return array On success, a processed array of WP_Dependencies items; otherwise, an empty array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
function wp_print_scripts( $handles = false ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
	do_action( 'wp_print_scripts' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
	if ( '' === $handles ) // for wp_head
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
		$handles = false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
		if ( !$handles )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
			return array(); // No need to instantiate if nothing is there.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
		else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
			$wp_scripts = new WP_Scripts();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
	return $wp_scripts->do_items( $handles );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
 * Register a new script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
 * Registers a script to be linked later using the wp_enqueue_script() function.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
 * @see WP_Dependencies::add(), WP_Dependencies::add_data()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
 * @since 2.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
 * @param string      $handle    Name of the script. Should be unique.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
 * @param string      $src       Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
 * @param array       $deps      Optional. An array of registered script handles this script depends on. Set to false if there
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
 *                               are no dependencies. Default empty array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
 * @param string|bool $ver       Optional. String specifying script version number, if it has one, which is concatenated
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
 *                               to end of path as a query string. If no version is specified or set to false, a version
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
 *                               number is automatically added equal to current installed WordPress version.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
 *                               If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
 * @param bool        $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
 *                               Default 'false'. Accepts 'false' or 'true'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
		$wp_scripts = new WP_Scripts();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
	$wp_scripts->add( $handle, $src, $deps, $ver );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
	if ( $in_footer )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
		$wp_scripts->add_data( $handle, 'group', 1 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
 * Localize a script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
 * Works only if the script has already been added.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
 * Accepts an associative array $l10n and creates a JavaScript object:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
 * <code>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
 * "$object_name" = {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
 *       key: value,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
 *       key: value,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
 *       ...
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
 * }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
 * </code>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
 * @see WP_Dependencies::localize()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
 * @link http://core.trac.wordpress.org/ticket/11520
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
 * @since 2.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
 * @param string $handle      Script handle the data will be attached to.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
 * @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
 *                            Example: '/[a-zA-Z0-9_]+/'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
 * @param array $l10n         The data itself. The data can be either a single or multi-dimensional array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
 * @return bool True if the script was successfully localized, false otherwise.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
function wp_localize_script( $handle, $object_name, $l10n ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
		return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
	return $wp_scripts->localize( $handle, $object_name, $l10n );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
 * Remove a registered script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
 * Note: there are intentional safeguards in place to prevent critical admin scripts,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
 * such as jQuery core, from being unregistered.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
 * @see WP_Dependencies::remove()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
 * @since 2.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
 * @param string $handle Name of the script to be removed.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
function wp_deregister_script( $handle ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
		$wp_scripts = new WP_Scripts();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
	 * Do not allow accidental or negligent de-registering of critical scripts in the admin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
	 * Show minimal remorse if the correct hook is used.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
	$current_filter = current_filter();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
	if ( ( is_admin() && 'admin_enqueue_scripts' !== $current_filter ) ||
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
		( 'wp-login.php' === $GLOBALS['pagenow'] && 'login_enqueue_scripts' !== $current_filter )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
	) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
		$no = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
			'jquery', 'jquery-core', 'jquery-migrate', 'jquery-ui-core', 'jquery-ui-accordion',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
			'jquery-ui-autocomplete', 'jquery-ui-button', 'jquery-ui-datepicker', 'jquery-ui-dialog',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
			'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-menu', 'jquery-ui-mouse',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   155
			'jquery-ui-position', 'jquery-ui-progressbar', 'jquery-ui-resizable', 'jquery-ui-selectable',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   156
			'jquery-ui-slider', 'jquery-ui-sortable', 'jquery-ui-spinner', 'jquery-ui-tabs',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   157
			'jquery-ui-tooltip', 'jquery-ui-widget', 'underscore', 'backbone',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   158
		);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   159
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   160
		if ( in_array( $handle, $no ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   161
			$message = sprintf( __( 'Do not deregister the %1$s script in the administration area. To target the frontend theme, use the %2$s hook.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   162
				"<code>$handle</code>", '<code>wp_enqueue_scripts</code>' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   163
			_doing_it_wrong( __FUNCTION__, $message, '3.6' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   164
			return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   165
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   166
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   167
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   168
	$wp_scripts->remove( $handle );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   169
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   170
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   171
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   172
 * Enqueue a script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   173
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   174
 * Registers the script if $src provided (does NOT overwrite), and enqueues it.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   175
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   176
 * @see WP_Dependencies::add(), WP_Dependencies::add_data(), WP_Dependencies::enqueue()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   177
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   178
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   179
 * @since 2.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   180
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   181
 * @param string      $handle    Name of the script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   182
 * @param string|bool $src       Path to the script from the root directory of WordPress. Example: '/js/myscript.js'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   183
 * @param array       $deps      An array of registered handles this script depends on. Default empty array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   184
 * @param string|bool $ver       Optional. String specifying the script version number, if it has one. This parameter
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   185
 *                               is used to ensure that the correct version is sent to the client regardless of caching,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   186
 *                               and so should be included if a version number is available and makes sense for the script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   187
 * @param bool        $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   188
 *                               Default 'false'. Accepts 'false' or 'true'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   189
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   190
function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   191
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   192
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   193
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   194
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   195
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   196
		$wp_scripts = new WP_Scripts();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   197
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   198
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   199
	if ( $src ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   200
		$_handle = explode('?', $handle);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   201
		$wp_scripts->add( $_handle[0], $src, $deps, $ver );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   202
		if ( $in_footer )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   203
			$wp_scripts->add_data( $_handle[0], 'group', 1 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   204
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   205
	$wp_scripts->enqueue( $handle );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   206
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   207
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   208
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   209
 * Remove a previously enqueued script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   210
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   211
 * @see WP_Dependencies::dequeue()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   212
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   213
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   214
 * @since 3.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   215
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   216
 * @param string $handle Name of the script to be removed.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   217
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   218
function wp_dequeue_script( $handle ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   219
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   220
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   221
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   222
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   223
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   224
		$wp_scripts = new WP_Scripts();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   225
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   226
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   227
	$wp_scripts->dequeue( $handle );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   228
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   229
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   230
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   231
 * Check whether a script has been added to the queue.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   232
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   233
 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   234
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   235
 * @since 2.8.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   236
 * @since 3.5.0 'enqueued' added as an alias of the 'queue' list.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   237
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   238
 * @param string $handle Name of the script.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   239
 * @param string $list   Optional. Status of the script to check. Default 'enqueued'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   240
 *                       Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   241
 * @return bool Whether the script script is queued.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   242
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   243
function wp_script_is( $handle, $list = 'enqueued' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   244
	global $wp_scripts;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   245
	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   246
		if ( ! did_action( 'init' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   247
			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   248
				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>login_enqueue_scripts</code>' ), '3.3' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   249
		$wp_scripts = new WP_Scripts();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   250
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   251
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   252
	return (bool) $wp_scripts->query( $handle, $list );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   253
}