概要
admin_url関数は、WordPressの管理者ページのURLを取得するために使用される関数です。この関数は、プラグインやテーマ開発の際に管理者向けの機能を実装するためによく使用されます。具体的には、次のような機能を実装する際に役立ちます。
- プラグイン設定ページへのリンクを作成
- カスタム管理画面を作成
- 特定の管理者操作を誘導するためのリダイレクト
- 管理者用のカスタムスクリプトの読み込み
- 管理者ページでの情報表示
- 画像やファイルのアップロード処理
- テーマ管理ページのリンク作成
- ユーザー管理に関する機能実装
構文
admin_url( string $path = '' , string $scheme = 'admin' )
パラメータ
$path(string, optional): URLのパス部分。デフォルトは空文字列。$scheme(string, optional): 使用するURLスキーム。’http’ や ‘https’ が指定可能。デフォルトは ‘admin’。
戻り値
- (string): 管理者ページの完全なURL。
関連する関数
使用可能なバージョン
- WordPress 2.0以降から利用可能。
コアファイルのパス
/wp-includes/functions.php
サンプルコード
サンプル1: プラグイン設定ページへのリンクを取得
$settings_page = admin_url('options-general.php?page=my-plugin-settings');
このコードは、プラグインの設定ページへのリンクを取得するサンプルです。
サンプル2: カスタム管理画面リダイレクト
function my_custom_redirect() {
if (!current_user_can('manage_options')) {
wp_redirect(admin_url());
exit;
}
}
add_action('admin_init', 'my_custom_redirect');
このコードは、権限がないユーザーを管理者ページにリダイレクトするサンプルです。
サンプル3: スクリプトの読み込み
function my_enqueue_admin_scripts() {
wp_enqueue_script('my-script', admin_url('js/my-script.js'));
}
add_action('admin_enqueue_scripts', 'my_enqueue_admin_scripts');
このコードは、管理者ページでカスタムJavaScriptスクリプトを読み込むサンプルです。
サンプル4: 管理者へのメッセージ表示
function my_admin_notice() {
echo '<div class="notice notice-success"><p>Plugin activated! Go to ' . admin_url('options-general.php?page=my-plugin-settings') . ' to configure.</p></div>';
}
add_action('admin_notices', 'my_admin_notice');
このコードは、プラグインが有効化された後に管理者ページにメッセージを表示するサンプルです。
サンプル5: 管理者用のカスタムエンドポイントを作成
function my_custom_menu_page() {
add_menu_page('My Custom Page', 'Custom Page', 'manage_options', 'my-custom-page', 'my_custom_page_callback', '', 6);
}
add_action('admin_menu', 'my_custom_menu_page');
このコードは、管理者メニューにカスタムページを追加するサンプルです。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
非推奨または削除されたバージョン
- 特定のワードプレスバージョンでこの関数は非推奨または削除されていません。