get_page_link

説明

string get_page_link( [ mixed $post = false [ , bool $leavename = false [ , bool $sample = false ] ] ] )
固定ページのパーマリンクURLを取得する。

パラメータ

  • $post
    固定ページまたはその投稿情報ID(省略時はfalseとなり、現在の投稿情報を調べる)。
  • $leavename
    投稿名およびページ名を除外する場合はfalse、有効にする場合はtrueを指定(省略時はfalseとなり、投稿名およびページ名を有効にする)。
  • $sample
    サンプル用パーマリンクの場合はtrue、通常のパーマリンクの場合はfalseを指定(省略時はfalse)。

返り値

固定ページのパーマリンクURLを返す。

注意

対象の固定ページが「フロントページ」に指定されている( get_option( 'show_on_front' )が'page'でget_option( 'page_on_front' )が対象の固定ページのID)場合、パーマリンクURLは home_url( '/' )になる。

使用例

  • $pageで指定した固定ページのパーマリンクURLを取得する。
    <?php $url = get_page_link( $page ); ?>

フィルター

パーマリンクURLを返す直前に'page_link'フィルターを呼び出す。$linkにはパーマリンクURL、$post_idには固定ページのID、$sampleは同名パラメータの値が格納される。
return apply_filters( 'page_link', $link, $post_id, $sample );

アクション

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

ソースファイル

/wp-includes/link-template.php

最終更新 : 2014年06月17日 15:36



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。