get_the_post_navigation()


WordPressの関数get_the_post_navigation()は、前後の投稿へのナビゲーションリンクを表示するために使用されます。

シンタックス

get_the_post_navigation( array $args = array() );

引数の説明:

  • $args (array) — ナビゲーションリンクをカスタマイズするための引数。

引数の配列に含まれるキー:

  • prev_text (string) — 前の投稿リンクのテキスト。
  • next_text (string) — 次の投稿リンクのテキスト。
  • screen_reader_text (string) — スクリーンリーダー向けのテキスト。
  • in_same_term (bool) — 同じターム内の投稿のみを表示するかどうか。
  • taxonomy (string) — in_same_termがtrueの場合に使用されるタクソノミー。

例1: シンプルな投稿ナビゲーションリンク

前後の投稿へのリンクをデフォルト設定で表示します。

<?php echo get_the_post_navigation(); ?>

例2: カスタムテキスト付きナビゲーションリンク

前後のリンクにカスタムテキストを設定します。

<?php 
echo get_the_post_navigation( array(
    'prev_text' => '前の記事: %title',
    'next_text' => '次の記事: %title'
) );
?>

例3: 同じカテゴリ内の投稿リンクを表示

同じカテゴリ内の前後の投稿へのリンクを表示します。

<?php 
echo get_the_post_navigation( array(
    'in_same_term' => true,
    'taxonomy' => 'category',
    'prev_text' => '同じカテゴリの前の記事: %title',
    'next_text' => '同じカテゴリの次の記事: %title'
) );
?>

例4: スクリーンリーダーテキストの変更

スクリーンリーダー用のテキストをカスタマイズします。

<?php 
echo get_the_post_navigation( array(
    'screen_reader_text' => 'ナビゲーションリンク'
) );
?>

例5: ナビゲーションリンクを条件付きで表示

前後の投稿が存在する場合のみリンクを表示します。

<?php 
if ( get_previous_post() || get_next_post() ) {
    echo get_the_post_navigation();
}
?>

注意点:

  • get_the_post_navigation()はエコーせずにHTMLを返します。リンクを直接出力したい場合はthe_post_navigation()を使用してください。
  • 引数のテキスト内の%titleは、投稿のタイトルに置き換えられます。

関連機能：