概要
get_the_post_navigation 関数は、投稿ページ向けのナビゲーションを取得するために使用されます。この関数は、特に次のような機能を実装する際に便利です。
- 投稿の前後リンクを表示する
- シングルポストテンプレートでのナビゲーションの整備
- 記事間の関連性を示すことで読者の滞在時間を延ばす
- SEOの向上に寄与するための内部リンク設計
- 投稿シリーズや連載記事のナビゲーションを作成する
- フロントエンドでのユーザビリティ向上
- カスタム投稿タイプにおけるナビゲーションの実装
- 特定の条件に合わせたナビゲーションのカスタマイズ
構文
get_the_post_navigation( $args );
パラメータ
$args(array) : ナビゲーションを作成する際のオプションを含む配列。デフォルトは空の配列です。
戻り値
- (string) : ナビゲーションリンクのHTML。
関連する関数
使用可能なバージョン
- WordPress 4.3.0以降で利用可能です。
コアファイルのパス
wp-includes/general-template.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプル1: 基本的な投稿ナビゲーションの表示
このサンプルコードは、シンプルに前後の投稿へのリンクを表示します。
<?php
if ( have_posts() ) :
while ( have_posts() ) : the_post();
// 投稿コンテンツを表示
the_content();
endwhile;
// 投稿ナビゲーションを表示
get_the_post_navigation();
endif;
?>
引用元: https://developer.wordpress.org/reference/functions/get_the_post_navigation/
サンプル2: カスタムクラスを使ったナビゲーション
このサンプルコードでは、ナビゲーションにカスタムクラスを追加しています。
<?php
$args = array(
'prev_text' => '<span class="nav-prev">前の投稿</span>',
'next_text' => '<span class="nav-next">次の投稿</span>',
);
get_the_post_navigation( $args );
?>
引用元: https://developer.wordpress.org/reference/functions/get_the_post_navigation/
サンプル3: 複数のナビゲーションタイプをカスタマイズ
このサンプルは、前後の投稿ナビゲーションに加えて、その他の投稿種類にも対応しています。
$args = array(
'prev_text' => __( '前の投稿', 'textdomain' ),
'next_text' => __( '次の投稿', 'textdomain' ),
);
if ( get_previous_post() || get_next_post() ) {
get_the_post_navigation( $args );
}
?>
引用元: https://developer.wordpress.org/reference/functions/get_the_post_navigation/
サンプル4: ナビゲーションを条件付きで表示
このサンプルコードでは、特定の投稿タイプのときのみナビゲーションを表示します。
if ( 'post' == get_post_type() ) {
get_the_post_navigation();
}
?>
引用元: https://developer.wordpress.org/reference/functions/get_the_post_navigation/
サンプル5: 投稿ナビゲーションを直接出力
このサンプルでは、ナビゲーションを直接出力する方法を示します。
<?php
echo get_the_post_navigation();
?>
引用元: https://developer.wordpress.org/reference/functions/get_the_post_navigation/