get_admin_url

(3.0.0以降)
get_admin_url - 管理者ページのURLを取得する(マルチサイト対応)

説明

string get_admin_url( [ int $blog_id = null [ , string $path = '' [ , string $scheme = 'admin' ] ] ] )
管理者ページのURLを取得する(マルチサイト対応)。

パラメータ

  • $blog_id
    ブログIDを指定(省略時はnull)。
  • $path
    管理者ページのパス名を指定(省略時は'')。
  • $scheme
    スキーマとして'admin'、'http'、'https'を指定(省略時は'admin')。

返り値

管理者ページのURLを返す。

注意

admin_url関数のマルチサイト対応版。パラメータ$blog_idがnullの場合は、現在のサイトが管理者ページのURLとなる。

使用例

  • 現サイトのダッシュボードページのURLを取得する。
    <?php $url = get_admin_url(); ?>
  • ブログIDが1の新規投稿を追加(投稿-新規追加)ページのURLを取得する。
    <?php $url = get_admin_url( 1, 'post-new.php' ); ?>

フィルター

URLを返す直前にadmin_urlフィルターを呼び出す。$urlには管理者ページのURLが、$pathおよび$blog_idには、本関数が受け取った各パラメータの値が格納される。
return apply_filters( 'admin_url', $url, $path, $blog_id );

アクション

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

ソースファイル

/wp-includes/link-template.php

関連

  • admin_url - 管理者ページのURLを取得する
  • get_site_url - 任意のブログのサイトURLを取得する

お勧めコンテンツ

タイトルが一致する投稿を検索する(2014年2月20日 登録)

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 登録)

投稿記事ごとに設定されているカスタムフィールドの値はget_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。

囲み型ショートコードとwpautop(2014年10月22日 登録)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

投稿日の検索が自由自在に(2013年10月30日 登録)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろんquery_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 登録)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

最終更新日時 : 2012-05-06 11:49