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

お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。