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



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。