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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

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

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

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

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

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

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。