説明
パラメータ
- $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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。