概要
wp_get_script_tag関数は、内容が空の<script>要素を生成するためのWordPressの関数です。この関数は、テーマやプラグインの開発者がJavaScriptファイルを簡単に読み込むために利用することが多く、以下のような場面でよく使われます。
- スクリプトを条件付きで読み込む際
- マルチバージョンのスクリプトを読み込む際
- 特定のページや投稿タイプのみでスクリプトを表示する際
- CDNからスクリプトを読み込む場合
- スクリプトの依存関係を考慮して出力する場合
- 開発中のテーマにおいてスクリプトのテストを行う際
- スクリプトのバージョン管理を行う際
- Ajaxリクエスト用のスクリプトを読み込む際
構文
wp_get_script_tag( $src, $dependencies, $version, $in_footer, $attributes );
パラメータ
- $src (string) – スクリプトのURL。必須。
- $dependencies (array) – スクリプトの依存関係の配列。オプション。
- $version (string|bool) – スクリプトのバージョン。オプション。
- $in_footer (bool) – フッターに表示するかどうか。デフォルトは
false。 - $attributes (array) – スクリプト要素の追加属性。オプション。
戻り値
- (string) – 生成された
<script>タグのHTML。
関連する関数
使用可能なバージョン
- 4.5.0以上で使用可能。
コアファイルのパス
wp-includes/script-loader.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
非推奨または削除されたバージョン
- 特に非推奨または削除されたバージョンはありません。