概要
plugin_dir_url関数は、特定のプラグインのURLを取得するために使用される関数です。この関数は、WordPressの開発者がプラグイン内でスタティックリソース（画像、CSS、JavaScriptファイルなど）のURLを簡単に参照できるようにするためによく使用されます。具体的には、以下のような機能を実装する際によく使われます。
- プラグインの設定ページへのリンクを生成する。
- カスタムスタイルシートやスクリプトをエンキューする際に使用する。
- プラグインの画像やアイコンを表示するためのパスを指定する。
- プラグインのフロントエンドインターフェースでのリソースの読み込み。
- 管理ダッシュボードでのプラグインの設定を行う際に必要なファイルパスを取得する。
- プラグインの翻訳ファイルのパスを明示する。
- 短縮コードを使用する際に関連するJavaScriptファイルへのリンクを取得する。
- 別のプラグインとの連携を行う際に必要なファイルパスを取得する。
構文
plugin_dir_url( string $file )
パラメータ
$file(string): プラグイン内のファイルのパスを指定します。このファイルのディレクトリURLが取得されます。
戻り値
- (string): 指定したファイルのディレクトリURLを返します。
関連する関数
この関数を使用可能なバージョン
- WordPress 2.0.0 以降
コアファイルのパス
wp-includes/functions.php
サンプルコード
サンプルコード1: スタイルシートの読み込み
function my_plugin_enqueue_styles() {
wp_enqueue_style('my-plugin-styles', plugin_dir_url(__FILE__) . 'css/styles.css');
}
add_action('wp_enqueue_scripts', 'my_plugin_enqueue_styles');
説明: プラグインのディレクトリからスタイルシートを読み込むために、plugin_dir_url関数を使用しています。
サンプルコード2: Adminメニューの追加
function my_plugin_add_admin_menu() {
add_menu_page(
'My Plugin',
'My Plugin',
'manage_options',
'my_plugin',
'my_plugin_options_page',
plugin_dir_url(__FILE__) . 'img/icon.png'
);
}
add_action('admin_menu', 'my_plugin_add_admin_menu');
説明: プラグインのアイコンとして、plugin_dir_url関数を使って画像のURLを指定しています。
サンプルコード3: JavaScriptファイルの読み込み
function my_plugin_enqueue_scripts() {
wp_enqueue_script('my-plugin-script', plugin_dir_url(__FILE__) . 'js/script.js', array('jquery'), null, true);
}
add_action('wp_enqueue_scripts', 'my_plugin_enqueue_scripts');
説明: プラグインのJavaScriptファイルを読み込む際にURLを取得するために、plugin_dir_urlを使用しています。
サンプルコード4: プラグイン設定ページへのリンク
function my_plugin_settings_page() {
echo '<a href="' . plugin_dir_url(__FILE__) . 'settings.php">Settings</a>';
}
説明: プラグインの設定ページへのリンクを生成するためにURLを取得しています。
サンプルコード5: 画像の表示
function my_plugin_display_image() {
$image_url = plugin_dir_url(__FILE__) . 'images/my-image.jpg';
echo '<img src="' . esc_url($image_url) . '" alt="My Image">';
}
説明: プラグインの画像を表示するために、plugin_dir_url関数でURLを取得しています。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 | 〇 |
非推奨または削除されたバージョン
- この関数は特定のバージョンで非推奨または削除されたことはありません。