wp_enqueue_script( string $handle, string $src = '', string[] $deps = array(), string|bool|null $ver = false, bool $in_footer = false )

Enqueues a script.

Description

Registers the script if $src provided (does NOT overwrite), and enqueues it.

Parameters

$handle

(Required) Name of the script. Should be unique.

$src

(Optional) Full URL of the script, or path of the script relative to the WordPress root directory.<br>

Default value: ''

$deps

(Optional) An array of registered script handles this script depends on.

Default value: array()

$ver

(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 WordPress version.<br> If set to null, no version is added.

Default value: false

$in_footer

(Optional) Whether to enqueue the script before </body> instead of in the <head>.<br> Default 'false'.

Default value: false

Source

File: wp-includes/functions.wp-scripts.php

function wp_enqueue_script( $handle, $src = '', $deps = array(), $ver = false, $in_footer = false ) {
	$wp_scripts = wp_scripts();

	_wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );


	if ( $src || $in_footer ) {
		$_handle = explode( '?', $handle );

		if ( $src ) {
			$wp_scripts->add( $_handle[0], $src, $deps, $ver );
		}

		if ( $in_footer ) {
			$wp_scripts->add_data( $_handle[0], 'group', 1 );
		}
	}

	$wp_scripts->enqueue( $handle );
}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/functions.wp-scripts.php: wp_scripts()	Initializes $wp_scripts if it has not been set.

Used By

Used By
Used By	Description
wp-admin/includes/meta-boxes.php: register_and_do_post_meta_boxes()	Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
wp-includes/embed.php: wp_maybe_enqueue_oembed_host_js()	Enqueue the wp-embed script if the provided oEmbed HTML contains a post embed.
wp-includes/customize/class-wp-customize-cropped-image-control.php: WP_Customize_Cropped_Image_Control::enqueue()	Enqueue control related scripts/styles.
wp-includes/customize/class-wp-customize-color-control.php: WP_Customize_Color_Control::enqueue()	Enqueue scripts/styles for the color picker.
wp-includes/customize/class-wp-customize-selective-refresh.php: WP_Customize_Selective_Refresh::enqueue_preview_scripts()	Enqueues preview scripts.
wp-includes/customize/class-wp-customize-header-image-control.php: WP_Customize_Header_Image_Control::enqueue()
wp-includes/general-template.php: add_thickbox()	Enqueues the default ThickBox js and css.
wp-includes/general-template.php: wp_enqueue_code_editor()	Enqueues assets needed by the code editor for the given settings.
wp-includes/widgets/class-wp-widget-media-audio.php: WP_Widget_Media_Audio::enqueue_preview_scripts()	Enqueue preview scripts.
wp-includes/widgets/class-wp-widget-media-audio.php: WP_Widget_Media_Audio::enqueue_admin_scripts()	Loads the required media files for the media manager and scripts for media widgets.
wp-includes/widgets/class-wp-widget-media-video.php: WP_Widget_Media_Video::enqueue_preview_scripts()	Enqueue preview scripts.
wp-includes/widgets/class-wp-widget-media-video.php: WP_Widget_Media_Video::enqueue_admin_scripts()	Loads the required scripts and styles for the widget control.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::enqueue_admin_scripts()	Loads the required scripts and styles for the widget control.
wp-includes/widgets/class-wp-widget-custom-html.php: WP_Widget_Custom_HTML::enqueue_admin_scripts()	Loads the required scripts and styles for the widget control.
wp-includes/widgets/class-wp-widget-media-gallery.php: WP_Widget_Media_Gallery::enqueue_admin_scripts()	Loads the required media files for the media manager and scripts for media widgets.
wp-includes/widgets/class-wp-widget-media-image.php: WP_Widget_Media_Image::enqueue_admin_scripts()	Loads the required media files for the media manager and scripts for media widgets.
wp-includes/widgets/class-wp-widget-media.php: WP_Widget_Media::enqueue_admin_scripts()	Loads the required scripts and styles for the widget control.
wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::enqueue_scripts()	Enqueues scripts and styles for Customizer panel and export data to JavaScript.
wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::customize_preview_enqueue()	Enqueues scripts for the Customizer preview.
wp-includes/class-wp-admin-bar.php: WP_Admin_Bar::initialize()	Initializes the admin bar.
wp-includes/theme.php: the_custom_header_markup()	Prints the markup for a custom header.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::enqueue_control_scripts()	Enqueues scripts for customize controls.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::customize_preview_init()	Prints JavaScript settings.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::customize_preview_enqueue_deps()	Enqueues scripts for the Customizer preview.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::enqueue_scripts()	Enqueues scripts and styles for Customizer pane.
wp-includes/class-wp-editor.php: _WP_Editors::enqueue_scripts()
wp-includes/functions.php: wp_auth_check_load()	Loads the auth check for monitoring whether the user is still logged in.
wp-admin/includes/class-custom-background.php: Custom_Background::admin_load()	Sets up the enqueue for the CSS & JavaScript files.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::js_includes()	Set up the enqueue for the JavaScript files.
wp-admin/includes/media.php: wp_media_upload_handler()	Handles the process of uploading media.
wp-admin/includes/media.php: media_upload_gallery()	Retrieves the legacy media uploader form in an iframe.
wp-admin/includes/comment.php: enqueue_comment_hotkeys_js()	Enqueues comment shortcuts jQuery script.
wp-admin/includes/class-wp-internal-pointers.php: WP_Internal_Pointers::enqueue_scripts()	Initializes the new feature pointers.
wp-admin/includes/dashboard.php: wp_dashboard_setup()	Registers dashboard widgets.

Show 29 more used by Hide more used by

Changelog

Changelog
Version	Description
2.1.0	Introduced.