説明
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を取得できる。
- ユーザーがどのサイトにも属していない場合、ユーザーダッシュボードが適用される。
- ユーザーが現在のサイトに属している場合、現在のサイトのダッシュボードが適用される。
- ユーザーが現在のサイトを編集できない場合、ユーザーのプライマリサイトのダッシュボードが適用される。
使用例
- 現在のユーザーのダッシュボートページの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
関連
お勧め
Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿ページにキーワード検索ウィジェットを追加する(2012年6月2日 更新)
「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)
少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)
ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。
タイトルのみをキーワード検索する(2014年4月3日 更新)
WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。