WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_script_is()

wp_script_is( string $handle, string $status = ‘enqueued’ ): bool

In this article

Back to top

Determines whether a script has been added to the queue.

Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Parameters

$handlestringrequired
Name of the script.
$statusstringoptional
Status of the script to check. Default 'enqueued'.
Accepts 'enqueued', 'registered', 'queue', 'to_do', and 'done'.

Default:'enqueued'

Return

bool Whether the script is queued.

Source

function wp_script_is( $handle, $status = 'enqueued' ) {
	_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );

	return (bool) wp_scripts()->query( $handle, $status );
}

View all references View on Trac View on GitHub

UsesDescription
wp_scripts()wp-includes/functions.wp-scripts.php

Initializes $wp_scripts if it has not been set.

Used byDescription
register_block_script_handle()wp-includes/blocks.php

Finds a script handle for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.

the_block_editor_meta_boxes()wp-admin/includes/post.php

Renders the meta boxes forms.

wp_localize_community_events()wp-includes/script-loader.php

Localizes community events data that needs to be passed to dashboard.js.

wp_localize_jquery_ui_datepicker()wp-includes/script-loader.php

Localizes the jQuery UI datepicker.

Changelog

VersionDescription
3.5.0'enqueued' added as an alias of the 'queue' list.
2.8.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    Basic Example
    This would check if the script named ‘fluidVids.js’ is enqueued. If it is enqueued, it does nothing. If it is not enqueued, the files are then registered and enqueued. 

    $handle = 'fluidVids.js';
$list = 'enqueued';
if (wp_script_is( $handle, $list )) {
    return;
} else {
    wp_register_script( 'fluidVids.js', plugin_dir_url(__FILE__).'js/fluidvids.min.js');
    wp_enqueue_script( 'fluidVids.js' );
}

You must log in before being able to contribute a note or feedback.