wp_add_inline_script:WordPress私的マニュアル

wp_add_inline_script

(4.5.0以降)
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

参考

Code Reference: wp_add_inline_script