wp_register_script( string $handle, string $src, array $deps = array(), string|bool|null $ver = false, bool $in_footer = false )
Register a new script.
Description
Registers a script to be enqueued later using the wp_enqueue_script() function.
See also
Parameters
- $handle
-
(string) (Required) Name of the script. Should be unique.
- $src
-
(string) (Required) Full URL of the script, or path of the script relative to the ClassicPress root directory.
- $deps
-
(array) (Optional) An array of registered script handles this script depends on.
Default value: array()
- $ver
-
(string|bool|null) (Optional) String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed ClassicPress version. If set to null, no version is added.
Default value: false
- $in_footer
-
(bool) (Optional) Whether to enqueue the script before </body> instead of in the <head>. Default 'false'.
Default value: false
Return
(bool) Whether the script has been registered. True on success, false on failure.
Source
File: wp-includes/functions.wp-scripts.php
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
$wp_scripts = wp_scripts();
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
$registered = $wp_scripts->add( $handle, $src, $deps, $ver );
if ( $in_footer ) {
$wp_scripts->add_data( $handle, 'group', 1 );
}
return $registered;
}
Changelog
| Version | Description |
|---|---|
| WP-4.3.0 | A return value was added. |
| WP-2.1.0 | Introduced. |