get_post_permalink

説明

string | false get_post_permalink( [ int | WP_Post $id$post = 0 [ , bool $leavename = false [ , bool $sample = false ] ] ] )
カスタム投稿タイプの投稿ページのパーマリンクを取得する。

パラメータ

  • $id$post
    投稿IDまたは投稿情報を指定(省略時は0)。
  • $leavename
    投稿名を保持する場合はtrueを指定(省略時はfalse)。
  • $sample
    サンプルパーマリンクの場合はtrueを指定(省略時はfalse)。

返り値

カスタム投稿タイプのパーマリンクを返す。投稿IDが無効の場合はfalseを返す。

注意

通常シングルページのパーマリンクは get_permalink関数で取得でき、この関数も内部で呼び出されている。固定ページのパーマリンクを取得する get_page_linkと同様のパラメータを持ち、使い方も似ている。

[6.1.0]パラメータ$postで指定された投稿が存在しない場合、falseを返すようになった。


使用例

  • 現在のカスタム投稿タイプの投稿ページのパーマリングを取得する。
    <?php $url = get_post_permalink(); ?>
  • カスタム投稿タイプの投稿IDが101のパーマリングを取得する。
    <?php $url = get_post_permalink( 101 ); ?>

フィルター

[3.0.0]パーマリンクを返す直前に'post_type_link'フィルターを呼び出す。パラメータ$linkにはパーマリンクが、その他のパラメータには本関数が受け取った値が格納されている。
return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample );

アクション

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

ソースファイル

/wp-includes/link-template.php

最終更新 : 2022年11月06日 14:12



お勧め

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。