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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。