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



お勧め

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

投稿画面のウェジェットを2列にする(2013年4月17日 更新)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。