get_dashboard_url

説明

string get_dashboard_url( [ int $user_id = 0 [ , string $path = '' [ , string $scheme = 'admin' ] ] ] )
ダッシュボートページのURLを取得する。

パラメータ

  • $user_id
    ユーザーIDを指定(省略時は0)。
  • $path
    管理者ページのパス名を指定(省略時は'')。
  • $scheme
    スキーマとして'admin'、'http'、'https'を指定(省略時は'admin')。

返り値

ユーザーのロールに応じたダッシュボードページのURLを返す。


注意

基本的にはマルチサイト向けの関数で、通常のシングルサイトではパラメータ$user_idは使用されず、 admin_url関数が適用される。ユーザーとサイトの状況に応じて異なるダッシュボードのURLを取得できる。

  1. ユーザーがどのサイトにも属していない場合、ユーザーダッシュボードが適用される。
  2. ユーザーが現在のサイトに属している場合、現在のサイトのダッシュボードが適用される。
  3. ユーザーが現在のサイトを編集できない場合、ユーザーのプライマリサイトのダッシュボードが適用される。

使用例

  • 現在のユーザーのダッシュボートページのURLを取得する。
    <?php $url = get_dashboard_url( ); ?>
  • ユーザーIDを指定してそのダッシュボートページのURLを取得する。
    <?php $url = get_dashboard_url( $user->ID ); ?>

フィルター

[3.1.0]URLを返す前に'user_dashboard_url'フィルターを呼び出す。パラメータ$urlにはダッシュボードページのURLが、そのほかのパラメータには本関数が受け取った内容が格納されている。
return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/link-template.php

最終更新 : 2022年01月31日 13:10



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

5.3の機能強化:ナビゲーションにaria-label属性が追加される(2019年9月26日 更新)

先日「WordPress 5.3 Beta 1」が投稿され、アップデート内容は多い感じ。さっそく開発環境にインストールしてみると、管理画面全体の見た目が変わり、ブロックエディターが進化した印象である。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

Login rebuilderで第2ログインページのURLを取得する(2018年5月27日 更新)

先週のこと、「Login rebuilder」のユーザから「 wp_login_url関数のように第2ログインページのURLを取得できないか」という問い合わせがありました。その時点ではそのような関数やメソッドを用意していなかったのですが、まあニーズがあるなら作ってみようと思い、対応するメソッドを追加したLogin rebuilderバージョン1.4.3をリリースしました。