概要
get_admin_url 関数は、ワードプレスの管理者ページのURLを取得するために使用される関数です。この関数は、特にマルチサイト環境で効果的に動作し、特定のサイトの管理画面のURLを正確に取得することができます。以下は、この関数がよく使われる状況です。
- 管理者用のカスタムメニューを追加するとき
- プラグイン設定ページへのリンクを生成するとき
- カスタムダッシュボードウィジェットを作成する際
- ユーザーに管理者ページへのショートカットを提供する際
- マルチサイトのサイト管理用ツールを構築するとき
- 特定のサイトの設定ページにリダイレクトする際
- 他のプラグインとの連携で管理者ページを参照する際
- サイトの設定やオプションを管理するためのページを表示する際
構文
string get_admin_url( int $blog_id = null, string $path = '' )
パラメータ
$blog_id(int, optional): 管理者URLを取得するサイトのID。デフォルトは現在のサイトのID。$path(string, optional): URLの後に追加するパス。
戻り値
- (string): 指定されたサイトの管理者ページのURL。
関連する関数
使用可能なバージョン
- ワードプレス 3.0.0 以降で利用可能。
コアファイルのパス
wp-includes/ms.php
サンプルコード
サンプル1: デフォルトの管理者ページのURLを取得
$admin_url = get_admin_url();
echo $admin_url; // 現在のサイトの管理者ページURLを出力
このサンプルは、デフォルトの管理者ページのURLを取得し、そのURLを表示します。
サンプル2: 指定したサイトの管理者ページのURLを取得
$blog_id = 2; // 取得したいサイトのID
$admin_url = get_admin_url($blog_id);
echo $admin_url; // 指定したサイトの管理者ページURLを出力
このサンプルは、特定のサイト（ID 2）の管理者ページのURLを取得し、表示します。
サンプル3: 管理者ページの自カスタムパスを追加
$admin_url = get_admin_url(null, 'options-general.php');
echo $admin_url; // 管理者の「設定」ページのURLを出力
このサンプルは、管理者ページの設定セクションのURLを取得し、表示します。
サンプル4: マルチサイトでのリダイレクト
if (is_multisite()) {
$admin_url = get_admin_url(get_current_blog_id());
wp_redirect($admin_url);
exit;
}
このサンプルは、マルチサイト環境でユーザーを現在のサイトの管理者ページにリダイレクトします。
サンプル5: サイトの管理者ページへのリンクを作成
$admin_url = get_admin_url();
echo '<a href="' . esc_url($admin_url) . '">管理画面に移動</a>';
このサンプルは、管理者ページへのリンクを作成し、ユーザーに表示します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
非推奨または削除されたバージョン
- 特定のバージョンでの非推奨または削除は報告されていません。