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



お勧め

5.3の新機能:JPEG画像の向きを自動調整(2019年10月17日 更新)

WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

テーブルの1列目をth要素にしてみる(2021年12月21日 更新)

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。