概要
plugins_url関数は、WordPressのプラグイン内で使用される特定のURLを取得するための非常に便利な関数です。この関数は、プラグインのファイルやリソースへの正確なパスを取得するために広く使用されます。以下は、plugins_url関数がよく使われる機能の例です。
- プラグインのJavaScriptファイルを読み込む
- プラグインのスタイルシートを適用する
- 画像やその他のメディアファイルを表示する
- REST APIエンドポイントを定義する
- Ajaxリクエストのエンドポイントを提供する
- カスタムAPIリクエストを処理するためのURLを取得する
- プラグインの設定ページへのリンクを生成する
- プラグインによって生成されたリソースをページに含める
構文
plugins_url( $path, $plugin );
パラメータ
$path(string): 取得したいURLのパス。相対パスで指定します。$plugin(string): プラグイン名（プラグインのディレクトリ名およびファイル名を含む）。省略した場合、現在のプラグインを指します。
戻り値
- (string): 指定されたプラグインのURL。
関連する関数
使用可能なバージョン
- 1.5以降のバージョンで使用可能です。
コアファイルのパス
wp-includes/plugin.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 | 〇 |
サンプルコード
サンプルコード1: プラグインのCSSを読み込む
function my_plugin_enqueue_styles() {
wp_enqueue_style('my-plugin-style', plugins_url('css/style.css', __FILE__));
}
add_action('wp_enqueue_scripts', 'my_plugin_enqueue_styles');
このコードは、プラグインのCSSファイルを正しいURLから読み込むためにplugins_url関数を使用しています。
サンプルコード2: プラグインのJavaScriptを読み込む
function my_plugin_enqueue_scripts() {
wp_enqueue_script('my-plugin-script', plugins_url('js/script.js', __FILE__));
}
add_action('wp_enqueue_scripts', 'my_plugin_enqueue_scripts');
このコードでは、JavaScriptファイルのURLを取得し、ページに正しく追加します。
サンプルコード3: プラグインの画像を表示する
function my_plugin_image() {
$image_url = plugins_url('images/logo.png', __FILE__);
echo '<img src="' . esc_url($image_url) . '" alt="Plugin Logo">';
}
この関数は、プラグインの画像ファイルへのURLを取得し、HTMLに出力します。
サンプルコード4: Ajaxリクエスト用URLの取得
function my_plugin_ajax_url() {
?>
<script type="text/javascript">
var my_ajax_url = "<?php echo esc_url(plugins_url('ajax.php', __FILE__)); ?>";
</script>
<?php
}
add_action('wp_head', 'my_plugin_ajax_url');
このコードは、JavaScriptから使用するAjaxリクエストURLを取得してスクリプトに出力します。
サンプルコード5: プラグインの設定ページへのリンクを作成
function my_plugin_admin_link() {
$settings_url = plugins_url('settings.php', __FILE__);
echo '<a href="' . esc_url($settings_url) . '">設定ページに移動</a>';
}
この関数は、プラグインの設定ページへのリンクを生成します。