WEB制作のための情報サイト / unazuki Library

get_permalink()

基本構文と使い方(引数・実行結果)

基本構文

記事のパーマリンク(URL)を取得します。

get_permalink($post,$leavename);

引数

引数必須/任意引数に指定するもの
第1引数
$post
任意判定したい記事のID / オブジェクト
初期値:現在の記事オブジェクト
第2引数
$leavename
任意パーマリンクのリライトルールをそのまま表示する場合はtrue、リライトルールを適用した後のパーマリンクを表示する場合はfalse
初期値false
※パーマリンクのリライトルール:管理画面の設定→パーマリンク→パーマリンク構造でカスタマイズできるURLのことを指しています。
※基本的に使いません(falseのまま)。開発者がリライトルールを画面上で確認するための機能と思われます。

実行結果

戻り値(返す値):記事のURL
※表示するにはechoします。

例1.任意の記事IDのパーマリンクを取得する

下記の例では、IDが30の記事のパーマリンクを取得します。

echo get_permalink(20);

例2.リライトルールをそのまま表示する

下記の例は通常使いませんが、理解の参考までに、リライトルールをそのまま表示する方法としてご紹介します。

echo get_permalink(get_the_ID(), true);

結果例:https://example.com/%postname%/
※「%postname%」は本来は記事名に置換されますが、リライトルールの設定がそのまま表示されています。(ユーザーにとっては意味がありません。)

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

【オブジェクトとは?】
オブジェクトとはデータの集合体です。例えば1つの記事には、記事の公開日、タイトル、本文など様々なデータがあります。それらを1つのデータにまとめたものがオブジェクトです。WordPressに関わらず、オブジェクトはプログラミングで一般的に使われるデータの集合体を示す言葉です。

【現在の投稿/記事オブジェクトとは?】
現在処理対象となっている投稿/記事オブジェクト(各投稿や各固定ページのオブジェクト)のことを指します。WordPressはリクエストされたページを表示するために、必要なデータをデータベースから取得した後、該当するデータを処理対象としてセットします。その現在セットされている投稿/記事オブジェクトのことを指しますが、詳しい理解には、「WordPressのループ」(+メインクエリ、サブクエリ)を理解する必要があります。

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
post_class() 投稿に関するclass名を表示する。
the_author() 現在の記事の投稿者の名前を表示します。
get_the_author() 現在の記事の投稿者の名前を返します。
the_ID() 現在の記事のIDを表示します。
get_the_ID() 現在の記事のIDを取得します。
get_post_meta() カスタムフィールドの値を取得します。
the_permalink() 記事のパーマリンク(URL)を表示します。
the_post_thumbnail() 記事にアイキャッチ画像がある場合は、アイキャッチ画像を表示する。
get_the_post_thumbnail() 記事にアイキャッチ画像がある場合は、アイキャッチ画像を含むimg要素を返す。
has_post_thumbnail() 投稿にアイキャッチ画像があるかないかを判定した結果、真偽値(true / false)を返す。
the_content() 記事本文を表示します。moreタグ(続きを読むタグ)を使っている場合は、引数の指定次第で記事の一部を表示します。
get_the_content() 記事本文のHTMLを取得します。moreタグ(続きを読むタグ)を使っている場合は、引数の指定次第で記事の一部を取得します。
the_excerpt() 記事の抜粋分を表示します。抜粋の長さはデフォルトで110文字(日本語)。
get_the_excerpt() 記事の抜粋分を取得します。抜粋の長さはデフォルトで110文字(日本語)。
the_time() 記事の公開時刻を表示します。
get_the_time() 記事の公開時刻を取得します。
the_date() 現在の記事(投稿や固定ページ)の公開日を表示します。
get_the_date() 記事(投稿や固定ページ)の公開日を取得する。
the_title() 記事のタイトルを表示します。
get_the_title() 記事のタイトルを取得します。