関数リファレンス/wp script is

この項目「関数リファレンス/wp script is」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

あるスクリプトが登録済み、キューイング済み、出力済み、または出力待ちであるか判定します。プラグイン内でスクリプトを登録またはキューイングするとき、他のプラグインのスクリプトとの衝突を避けるのにとても便利です。

使い方

<?php wp_script_is( $handle, $list ); ?>

パラメータ

$handle

（文字列） （必須） スクリプトの名前。小文字だけの文字列。

初期値： なし

$list

（文字列） （オプション） クエリのリスト。

• registered - wp_register_script() で登録済み
• enqueued / queue - キューイング済み
• done - 出力済み
• to_do - 出力待ち

初期値： 'enqueued'

戻り値

(真偽値) 

True（クエリに該当する）または false（該当しない）。

用例

$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' );
}

これは 'fluidVids.js' という名前のスクリプトがキューイングされているかチェックします。されていれば何もしません。キューイングされていなければファイルを登録およびキューイングします。

変更履歴

• 3.5.0: 'enqueued' を 'queue' のエイリアスとしてリストに追加。ticket #21741 を見てください。
• 新規導入: 2.8.0

ソースファイル

wp_script_is() は wp-includes/functions.wp-scripts.php にあります。

関連項目

• エンキュー関数:
  • スクリプト:wp_register_script(),wp_deregister_script(), wp_enqueue_script(), wp_dequeue_script() /en, wp_script_is() /en, wp_localize_script(), wp_enqueue_media()
  • スタイル: wp_register_style(),wp_deregister_style() /en,wp_enqueue_style(),wp_dequeue_style(), wp_style_is() /en

• エンキューアクション:
  • フロントエンド: wp_enqueue_scripts /en, wp_print_scripts /en, wp_print_styles /en
  • 管理画面: admin_enqueue_scripts /en, admin_print_scripts / en, admin_print_styles /en
  • ログイン: login_enqueue_scripts /en

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/wp script is （最新版との差分）