この記事は最後に更新してから1年以上経過しています。

各種リンクを取得する関数一覧

説明

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

サイトを構成する各種ページは、トップページ、アーカイブページ、シングルページに分類できる(かなりざっくり気味)。それらを軸に(ページ内に表示するための)リンクを取得する関数を整理すると、次のような一覧になる。

分類関数内容
トップページ site_urlトップページのリンクを取得する。
アーカイブ
ページ
タームアーカイブ get_term_linkカテゴリ、投稿タグ、カスタムタクソノミーのアーカイブページのリンクを取得する。
年アーカイブ get_year_link年アーカイブのリンクを取得する。
月アーカイブ get_month_link月アーカイブのリンクを取得する。
日アーカイブ get_day_link日アーカイブのリンクを取得する。
投稿タイプアーカイブ get_post_type_archive_linkカスタム投稿タイプアーカイブのリンクを取得する。
著者ページ(アーカイブ) get_author_posts_url著者ページのリンクを取得する。
シングル
ページ
汎用 get_permalink内部でページ属性に応じて以下の関連関数を呼び出すので、各種シングルページのリンクはこれ1つで取得できる。
固定ページ get_page_link固定ページのリンクを取得する。
添付ファイル get_attachment_link添付ファイルページのリンクを取得する。
カスタム投稿タイプ get_post_permalinkカスタム投稿タイプの投稿ページのリンクを取得する。
検索結果ページget_search_link検索結果ページのリンクを取得する。

get_term_link関数とget_permalink関数は、きっちり押さえておきたいところ。カスタム投稿タイプを利用するならget_post_type_archive_link関数も重要だろう。なお、ここに挙げた関数はすべてURLのみを取得するものであり、表示したりはしない。内部的にこれらの関数を使用してリンクを表示する関数もいくつか用意されているが、長くなるのでここでは割愛する。


最終更新 : 2014年06月12日 09:18


お勧め

wp_set_script_translations(2019年2月26日 更新)

bool wp_set_script_translations( string $handle [ , string $domain = 'default' [ , string $path = null ] ] )
JavaScript向け翻訳ファイル情報を設定する。

wp_sanitize_redirect(2012年4月25日 更新)

string wp_sanitize_redirect( string $locaution )
URLの文字列をサニタイズする。

wp_set_post_categories(2012年7月5日 更新)

mixed wp_set_post_categories( [ int $post_ID = 0 [ , array $post_categories = array() ] ] )
投稿情報にカテゴリーを設定する。

wp_get_attachment_link(2018年5月27日 更新)

string wp_get_attachment_link( [ int $id = 0 [ , mixed $size = 'thumbnail' [ , bool $permalink = false [ , bool $icon = false [ , mixed $text = false ] ] ] ] ] )
添付ファイルへのリンクを示すHTMLテキストを取得する。

get_post_ancestors(2014年12月26日 更新)

array get_post_ancestors( mixed $post )
先祖の投稿IDを取得する。