get_previous_post_link:WordPress私的マニュアル

get_previous_post_link

(3.7.0以降)
get_previous_post_link - 直前の投稿ページのリンクを取得する

説明

string get_previous_post_link( [ string $format = '« %link' [ , string $link = '%title' [ , bool ~~$in_same_cat~~$in_same_term = false [ , mixed ~~$excluded_categories~~$excluded_terms = '' [ , string $taxonomy = 'category' ] ] ] ] ] )

直前の投稿ページのリンクを取得する。

パラメータ

$format
フォーマットを指定（省略時は'« %link'）。
$link
リンクタイトルを指定（省略時は'%title'）。
~~$in_same_cat~~$in_same_term
同じターム（[3.8.0]より前のバージョンはカテゴリー、[3.8.0]以降のバージョンは$taxonomyで指定されたタクソノミー）内の投稿ページに限定する場合はtrue、限定しない場合はfalseを指定。省略時はfalseが適用される。
~~$excluded_categories~~$excluded_terms
除外するターム（[3.8.0]より前のバージョンはカテゴリー、[3.8.0]以降のバージョンは$taxonomyで指定されたタクソノミー）を指定する場合は、そのタームIDを文字列または配列で指定。
$taxonomy
[3.8.0]$in_same_termがtrueの場合に同一判定するタクソノミー名を指定（省略時は'category'）。

返り値

直前の投稿ページのリンク（aタグ）を返す。

注意

previous_post_link関数で出力されるリンクを取得する。
・パラメータ$formatは、'%link'を含まなければならない。
・パラメータ$linkは、投稿タイトルの'%title'、投稿日の'%date'を含めることができる。

使用例

直前の投稿ページのリンクを取得する。
<?php $url = get_previous_post_link(); ?>
直前の投稿ページのリンクをフォーマットを指定して取得する。
<?php $url = get_previous_post_link( '[%link]' ); ?>
直前の投稿ページのリンクをリンクタイトルを指定して取得する。
<?php $url = get_previous_post_link( '[%link]', '前の記事へ' ); ?>
同カテゴリー直前の投稿ページのリンクを取得する。
<?php $url = get_previous_post_link( '[%link]', '前の記事へ', true ); ?>
カテゴリーIDが1のカテゴリーを除外して直前の投稿ページのリンクを取得する。
<?php $url = get_previous_post_link( '[%link]', '前の記事へ', false, '1' ); ?>
同タグが付いた直前の投稿ページのリンクを取得する。
<?php $url = get_previous_post_link( '[%link]', '前の記事へ', true, '', 'post_tag' ); ?>

フィルター

直接実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/link-template.php

参考

Code Reference: get_previous_post_link