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



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。