get_the_posts_pagination

（4.1.0以降）
get_the_posts_pagination - アーカイブページ向けのページ番号ナビゲーションを取得する

説明

string get_the_posts_pagination( [ array $args = array() ] )
アーカイブページ向けのページ番号ナビゲーションを取得する。

パラメータ

  • $args
    パラメータを連想配列で指定（省略時はarray()）。主なキーは次の通り。
    キー意味省略時の値
    'mid_size'現在のページ部の表示件数1
    'prev_text'前ページリンクの表記__( 'Previous' )
    'next_text'次ページリンクの表記__( 'Next' )
    'screen_reader_text'ナビゲーションの見出し（h2タグの中身）__( 'Posts navigation' )
    'class'[5.5.0]nav要素のclass属性値'pagination'

返り値

アーカイブページ向けのページ番号ナビゲーション（HTML）を返す。

注意

パラメータ$argsは paginate_links関数に引き継がれるが、$args['type']で'array'が指定された場合のみ'plain'に書き換えられている。

新テーマのTwenty Fifteenのスタイルでは、'prev_text'と'next_text'で指定した表記は非表示となっている。

単純に前ページおよび次ページのナビゲーションを取得する get_the_posts_navigation関数もある。

使用例

  • アーカイブページ向けのページ番号ナビゲーションを取得する。
    <?php $nav = get_the_posts_pagination(); ?>
  • アーカイブページ向けのページ番号ナビゲーションを'mid_size'を3として取得する。
    <?php $nav = get_the_posts_pagination( array( 'mid_size' => 3 ) ); ?>

フィルター

[6.1.0]ナビゲーションを生成する前に'the_posts_pagination_args'フィルターを呼び出す。パラメータ$argsには本関数が受け取った内容にデフォルト設定がマージされた内容が格納されている。 
$args = apply_filters( 'the_posts_pagination_args', $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/link-template.php

最終更新 : 2022年11月06日 15:59

関連

参考

Code Reference: get_the_posts_pagination

お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。