• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get the posts pagination

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/get the posts pagination」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

前と次の投稿セット(存在するとき)へリンクするページ番号を並べたページ送りを返します。投稿リスト(index.php など)やアーカイブ(archive.php など)で使われます。

この関数はマークアップを返すだけです。表示するには echo するか、または the_posts_pagination() を使う必要があります。

1ページしかないときは空文字列を返します。

使い方

<?php $pagination = get_the_posts_pagination(); ?>

パラメータ

$args
配列) (オプション) 省略可能な引数の配列。
初期値: 以下を参照。
  • mid_size (整数) - 現在のページの左右にそれぞれ表示するページ番号の数。デフォルトは1。
  • prev_text (文字列) - 投稿の前のセットへのリンクテキスト。デフォルトは「Previous」。
  • next_text (文字列) - 投稿の次のセットへのリンクテキスト。デフォルトは「Next」。
  • screen_reader_text (文字列) - スクリーンリーダー用テキスト。デフォルトは「Posts navigation」。

用例

次の例は現在のページの前後に2ページ分ずつリンクをつけたページ送りを返します。

<?php
$pagination = get_the_posts_pagination( array( 'mid_size' => 2 ) );
?>

前と次のリンクテキストを変えてページ送りを返す

次の例は Next を Older に、Previous を Newer に置き換えたページ送りを返します。

<?php
$pagination = get_the_posts_pagination( array(
	'mid_size' => 2,
	'prev_text' => __( 'Newer', 'textdomain' ),
	'next_text' => __( 'Older', 'textdomain' ),
) );
?>

変更履歴

ページネーション: posts_nav_link(), next_posts_link(), previous_posts_link(), get_next_posts_link(), get_previous_posts_link(), paginate_links(), wp_link_pages(), next_post_link(), previous_post_link(), next_image_link(), previous_image_link(), the_posts_pagination(), get_the_posts_pagination()

最新英語版: WordPress Codex » Function Reference/get_the_posts_pagination最新版との差分