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



お勧め

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

5.3の新機能:JPEG画像の向きを自動調整(2019年10月17日 更新)

WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

投稿画面のウェジェットを2列にする(2013年4月17日 更新)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。