get_post_type_archive_link()

関数の概要

get_post_type_archive_link()は、WordPressで特定の投稿タイプアーカイブページのURLを取得するための関数です。アーカイブページは、特定の投稿タイプに属する投稿を一覧表示するページです。この関数は、カスタム投稿タイプのアーカイブページへのリンクを生成する際に非常に便利です。

パラメータの説明

get_post_type_archive_link()関数は1つのパラメータを受け取ります。

  1. $post_type (string, 必須): アーカイブリンクを取得する投稿タイプのスラッグ。

使用例

以下は、get_post_type_archive_link()関数を使用して特定の投稿タイプのアーカイブページリンクを取得し表示する例です。

<?php
// カスタム投稿タイプ 'books' のアーカイブページリンクを取得する
$post_type = 'books';
$archive_link = get_post_type_archive_link($post_type);

if ($archive_link) {
    echo '<p>The archive link for the "books" post type is: <a href="' . esc_url($archive_link) . '">' . esc_html($archive_link) . '</a></p>';
} else {
    echo '<p>Archive link for the "books" post type not found.</p>';
}
?>

関連する関数

  • get_post_type(): 特定の投稿の投稿タイプを取得します。
  • get_post_type_archive_template(): 投稿タイプアーカイブページのテンプレートファイルを取得します。
  • is_post_type_archive(): 現在表示されているアーカイブページが特定の投稿タイプのものであるかどうかを確認します。
  • register_post_type(): カスタム投稿タイプを登録します。
  • get_permalink(): 投稿のパーマリンクを取得します。