wp_script_is

説明

bool wp_script_is( string $handle [ , string $list = 'enqueued' ] )
スクリプトの状態を調べる。

パラメータ

  • $handle
    スクリプトのハンドル名を指定。
  • $list
    [3.5.0]スクリプトの状態を示す'enqueued'(または'queue')、'registered'、'to_do'、'done'のいずれかを指定(省略時は'enqueued')。

返り値

スクリプトが指定された状態であればtrueを、状態でなければfalseを返す。

注意

標準的なスクリプトの出力は次のような流れとなる。

  1. テーマやプラグインでwp_register_script関数で「登録配列(registered配列)」に追加
  2. テーマやプラグインで wp_enqueue_script関数で「出力待ち配列(queue配列)」に追加
  3. wp_headアクションで実行されるwp_print_head_scripts関数でhead要素内の分をまとめて出力
  4. wp_footerアクションで実行されるwp_print_footer_scripts関数で残り分をまとめて出力
  5. 上記のほか、一部のプラグインではwp_print_scripts関数を使用して個別に出力

スクリプトの出力時、まず出力対象の依存関係を調べ、依存関係があるスクリプトを含めて「実行対象配列(to_do配列)」に格納する。すべて実行対象配列に格納したら、スクリプトを出力→「実行済み配列(done配列)」に格納→実行対象配列から削除までの流れを、実行対象配列が空になるまで繰り返し行う。通常、実行されたスクリプトはその段階で出力待ち配列から削除されない。

本関数はパラメータ$listで指定された配列内にパラメータ$handleで指定されたスクリプトが格納されているかを調べ、その有無を返している。


使用例

  • スクリプト'myscript'が出力待ちか調べる。
    <?php if ( wp_script_is( 'myscript' ) ) : ?>
  • スクリプト'myscript'が出力済みか調べる。
    <?php if ( wp_script_is( 'myscript', 'done' ) ) : ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

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

最終更新 : 2019年05月29日 14:37



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。