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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

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

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

購読者は管理者ページのアクセス禁止(2013年11月12日 更新)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。