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



お勧め

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

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

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

もうquery_postsは呼ばない(2011年9月27日 更新)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭で query_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。