wp_register_script

説明

bool wp_register_script( string $handle, string | false $src [ , string[] $deps = array() [ , string | bool $ver = false [ , array | bool $args = array() ] ] ] )
スクリプトを登録する。

パラメータ

  • $handle
    スクリプト名を指定。
  • $src
    スクリプトのパス名またはURLを指定。
  • $deps
    依存するスクリプト名の配列を指定(省略時はarray())。
  • $ver
    バージョン番号を指定(省略時はfalse)。
  • $args
    フッターに出力する場合はtrueを指定。[6.3.0]'strategy'、'in_footer'キーを持つ連想配列を指定(省略時はarray())。

返り値

スクリプトを登録できた場合はtrueを、登録できなかった場合はfalseを返す。


注意

テーマまたはプラグインでJavaScriptファイルを登録する(実際に使用する場合は wp_enqueue_script関数でエンキューする必要がある)。

[4.3.0]スクリプトの登録結果を返り値で返すようになった。

[6.3.0]第5パラメータがbool型から連想配列に変更になった。連想配列は'strategy'と'in_footer'が有効であり、'strategy'の値は'defer'または'async'が、'in_footer'はtrueまたはfalseを指定できる。第5パラメータが配列以外の場合、その値はboolでキャストされ、キー'in_footer'の値となり、互換性が維持されている。


使用例

  • スクリプトを登録する
    wp_register_script( 'my-script', get_theme_file_uri( 'js/my-script.js' ) );
  • スクリプトを登録する
    wp_register_script( 'my-script', get_theme_file_uri( 'js/my-script.js' ), array(), false, array( 'strategy' => 'defer', 'in_footer' => true ) );

フィルター

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

アクション

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

ソースファイル

/wp-includes/functions.wp-scripts.php

最終更新 : 2023年08月09日 14:15



お勧め

ショートコードを使ってテーマ内の画像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日 更新)

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