WEB制作のための情報サイト / unazuki Library

get_previous_posts_link()

基本構文と使い方(引数・実行結果)

基本構文

アーカイブページにおいて前のページリンクのHTMLを取得します。

get_previous_posts_link($label);

引数

引数必須/任意引数に指定するもの
第1引数
$label
任意リンクテキストの文字列
初期値null (« 前ページへ)

実行結果

戻り値(返す値):アーカイブページの前のページリンクのHTML
※表示するにはechoします。

次のページリンクを表示するにはget_next_posts_link()が使えます。

例1.アーカイブページにおいてページングがある場合に前のページへのリンクを表示する

下記のコード例では「前へ」というリンクテキストを表示します。

<?php echo get_previous_posts_link('前へ'); ?>

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
body_class() body要素に関するclass名を表示する。
do_shortcode() ショートコードが実行された文字列を返す。
add_shortcode() 任意のショートコードを作成して追加する。
wp_body_open() アクションフックwp_body_openに登録されている関数を実行する。
wp_footer() アクションフックwp_footerに登録されている関数を実行する。
wp_head() アクションフックwp_headに登録されている関数を実行する。
get_previous_post() 現在の投稿の前の投稿情報を取得する。
get_next_post() 現在の投稿の次の投稿情報を取得する。
previous_posts_link() アーカイブページにおいて次のページリンクを表示する。
next_posts_link() アーカイブページにおいて次のページリンクを表示する。
get_next_posts_link() アーカイブページにおいて次のページリンクのHTMLを取得する。
get_template_part() テンプレートファイルにテンプレートパーツを呼び出して実行します。