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



お勧め

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

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

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

続テーマを変更せずにWebフォントを使ってみた(2022年2月8日 更新)

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。