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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。