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

最終更新 : 2019年10月17日 13:56



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。