ワードプレスのthe_posts_navigation関数の使用方法・解説

概要

the_posts_navigation関数は、アーカイブページ向けのナビゲーションを表示するための便利な関数です。この関数を使用することで、ユーザーは投稿のページ送りを簡単に行うことができ、より快適なウェブサイトのナビゲーション体験を提供できます。

この関数がよく使われるシナリオは以下の通りです。

1. カテゴリーページでのページナビゲーション
2. タグページでの投稿間移動
3. 日付アーカイブページの追加ナビゲーション
4. 検索結果ページでのページ送り
5. カスタム投稿タイプのアーカイブページ
6. 投稿一覧ページのユーザー体験向上
7. サイト全体での一貫したナビゲーション
8. ブログの遷移性を向上させる

構文

the_posts_navigation( $args );

パラメータ

• $args (配列) : ナビゲーションの設定を定義するオプションの引数。

戻り値

• なし: 出力は直接画面に表示されます。

関連する関数

• the_posts_pagination

バージョン

• WordPress 4.3.0 以降

コアファイルのパス

• wp-includes/template.php

サンプルコード

サンプル1: 基本的な使用例

if ( have_posts() ) {
    while ( have_posts() ) {
        the_post();
        // 投稿の内容を表示
    }
    the_posts_navigation();
}

説明: 投稿が存在する場合、各投稿を表示し、最後にナビゲーションを追加します。

サンプル2: カスタムナビゲーション文字列

the_posts_navigation( array(
    'prev_text' => '<span class="screen-reader-text">' . __( 'Previous' ) . '</span>',
    'next_text' => '<span class="screen-reader-text">' . __( 'Next' ) . '</span>',
) );

説明: 前後のナビゲーションボタンのテキストをカスタム設定で指定します。

サンプル3: 無限スクロールと一緒に使用

if ( have_posts() ) {
    while ( have_posts() ) {
        the_post();
        // 投稿の内容を表示
    }
}
if ( is_singular() ) {
    the_posts_navigation();
}

説明: 著作権のないサンプルでは、シングルポストのページですべてのナビゲーションを表示します。

サンプル4: ナビゲーションのスタイリング

the_posts_navigation( array(
    'class' => 'custom-navigation',
) );

説明: ナビゲーションにカスタムCSSクラスを追加し、スタイルを適用します。

サンプル5: ナビゲーションボタンのカスタムアイコンを追加

the_posts_navigation( array(
    'prev_text' => '<i class="fa fa-chevron-left"></i> ' . __( 'Previous', 'textdomain' ),
    'next_text' => __( 'Next', 'textdomain' ) . ' <i class="fa fa-chevron-right"></i>',
) );

説明: Font Awesomeアイコンを使用して、ナビゲーションボタンにアイコンを追加します。

この関数のアクションでの使用可能性

アクション名	使用可能性
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

非推奨情報

the_posts_navigationは特定のWordPressバージョンで非推奨または削除されていません。