ワードプレスのself_admin_url関数の使用方法・解説

概要

self_admin_url関数は、WordPressの管理者ページのURLを取得するために使用されます。この関数は、特にマルチサイト環境での動作や、特定の管理タスクを行うためのURLを構築する際に便利です。以下は、self_admin_url関数がよく使われる機能の例です：

1. 管理者向けの設定ページへのリンクを生成
2. プラグインの管理ページを表示するためのURLの取得
3. ユーザープロファイル編集ページへのリンクの作成
4. 投稿やページの編集ページを表示するためのURLを生成
5. テーマ設定ページへのアクセスURLの取得
6. マルチサイトダッシュボードへのリンクの生成
7. プラグインのオプションページへのURLの取得
8. 管理エリアでのリダイレクトURLの生成

構文

self_admin_url( $path = '', $scheme = 'admin' );

パラメータ

• $path (string, optional): 追加するパス。デフォルトは空文字列。
• $scheme (string, optional): URLのスキーム。デフォルトは’admin’。

戻り値

• (string): 指定されたパスを含む管理者ページのURL。

関連する関数

• admin_url
• network_admin_url

使用可能なバージョン

self_admin_url関数は、WordPress 3.0以降で使用可能です。

コアファイルのパス

wp-includes/functions.php

サンプルコード

1. 管理者ページへのリンクを生成する

   $url = self_admin_url( 'options-general.php' );
   echo '<a href="' . esc_url( $url ) . '">設定ページ</a>';
   

   このコードは、管理者が設定ページにアクセスするためのリンクを生成します。

2. 特定のプラグイン設定ページへのURL取得

   $url = self_admin_url( 'options.php?page=my_plugin_settings' );
   wp_redirect( $url );
   exit;
   

   このコードでは、特定のプラグインの設定ページへのリダイレクトを実行します。

3. ユーザーのプロファイル編集ページのURLを取得

   $url = self_admin_url( 'profile.php' );
   echo 'プロファイルを編集するには、' . esc_url( $url ) . 'をクリックしてください。';
   

   このコードは、ユーザーのプロファイル編集ページへのリンクテキストを表示します。

4. 管理ダッシュボードへのリンクを生成

   $url = self_admin_url();
   echo 'ダッシュボードへは <a href="' . esc_url( $url ) . '">こちら</a> から。';
   

   このコードは、管理ダッシュボードのURLを取得し、リンクを作成します。

5. マルチサイトの管理ページへのリンクを作成

   $url = self_admin_url( 'network/settings.php' );
   echo '<a href="' . esc_url( $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

非推奨または削除されたワードプレスバージョン

現在、self_admin_url関数は非推奨または削除されたバージョンはありません。