wp_register_script( string $handle, string|false $src, string[] $deps = array(), string|bool|null $ver = false, array|bool $args = array() ): bool

Description

Parameters

$handlestring

Name of the script. Should be unique.

$srcstring|false

Full URL of the script, or path of the script relative to the WordPress root directory. If source is set to false, script is an alias of other scripts it depends on.

$depsstring[]optional

An array of registered script handles this script depends on. Default empty array.Default: array()

$verstring|bool|nulloptional

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 WordPress version. If set to null, no version is added.Default: false

$argsarray|booloptional

An array of extra args for the script. Default empty array. Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.Default: array()

• $strategystring

  Optional. If provided, may be either 'defer' or 'async'.

• $in_footerbooldefault: 'false'

  Optional. Whether to print the script in the footer.

• $fetchprioritystringdefault: 'auto'

  Optional. The fetch priority for the script.

• $module_dependenciesarray

  Optional. IDs for module dependencies loaded via dynamic import. Default empty array. For the full data format, see the $deps param of wp_register_script_module(). When provided, the script must either be printed in the footer (with in_footer set to true) or use a deferred loading strategy (defer), so that the script modules import map is printed before the script is evaluated. Otherwise dynamic imports may fail to resolve.

Return

bool

Whether the script has been registered. True on success, false on failure.

Uses · 3

• _wp_scripts_maybe_doing_it_wrong()Helper function to output a _doing_it_wrong message when applicable.
• wp_scripts()Initializes $wp_scripts if it has not been set.
• _wp_scripts_add_args_data()Adds the data for the recognized args and warns for unrecognized args.

Used by · 10

• enqueue_editor_block_styles_assets()Function responsible for enqueuing the assets required for block styles functionality on the editor.
• register_block_script_handle()Finds a script handle for the selected block metadata field.
• twenty_twenty_one_scripts()Enqueues scripts and styles.
• twentyfifteen_scripts()Enqueues scripts and styles.
• twentyseventeen_scripts()Enqueues scripts and styles.
• twentysixteen_scripts()Enqueues scripts and styles.
• wp_font_library_render_page()Render the font-library page.
• wp_font_library_wp_admin_enqueue_scripts()Enqueue scripts and styles for the font-library-wp-admin page.
• wp_options_connectors_render_page()Render the options-connectors page.
• wp_options_connectors_wp_admin_enqueue_scripts()Enqueue scripts and styles for the options-connectors-wp-admin page.

Source

View on Trac ↗View on GitHub ↗

278function wp_register_script( $handle, $src, $deps = array(), $ver = false, $args = array() ) {279	if ( ! is_array( $args ) ) {280		$args = array(281			'in_footer' => (bool) $args,282		);283	}284	_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );285 286	$wp_scripts = wp_scripts();287 288	$registered = $wp_scripts->add( $handle, $src, $deps, $ver );289	_wp_scripts_add_args_data( $wp_scripts, $handle, $args );290 291	return $registered;292}

History

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.wp-scripts.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.