wp_add_inline_script

説明

bool wp_add_inline_script( string $handle, string $data [ , string $position = 'after' ] )
インラインスクリプトを追加する。

パラメータ

  • $handle
    インラインスクリプトを追加位置を示すハンドル名を指定。
  • $data
    インラインスクリプトを指定。
  • $position
    $handleで示されたスクリプトの後に追加する場合は'after'を、前に追加する場合は'after'以外を指定(省略時は'after')。

返り値

インラインスクリプトが追加できた場合はtrueを、追加できなかった場合はfalseを返す。

注意

この関数を使用する場合、wp_enqueue_scriptsアクションなどの特定のアクション内で呼び出す必要がある。

パラメータ$handleに指定するハンドル名は、キューに追加されているものでなけばならない(このインラインスクリプトのハンドル名のつもりで適当な名前をつけてもスクリプトは表示されない)。jquery.jsの後にインラインスクリプトを追加する場合、ハンドル名は'jquery'ではなく'jquery-core'を指定する必要がある('jquery'だと表示されない)。


使用例

  • jquery.jsの後にインラインスクリプトを追加する。
    <?php
    function test_add_scripts() {
    	$data = <<<EOT
    var _text = 'hello';
    console.log( _text );
    EOT;
    	wp_add_inline_script( 'jquery-core', $data );
    }
    add_action( 'wp_enqueue_scripts', 'test_add_scripts' );
    ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/wp-scripts.php

最終更新 : 2018年05月27日 10:44



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。