2018.05.14
WordPress
wordpressの過去記事一覧を表示するwp_get_archivesの設定方法
wordpressの過去記事一覧を表示するタグにwp_get_archives
があります。デフォルトの設定では月別アーカイブのリンクを表示するタグですが、設定項目を活用することによって表示内容を年別アーカイブにすることや、表示順の変更、投稿タイプの指定などを行うことができます。
今回はそのwordpressタグ、wp_get_archives
について紹介します。
wp_get_archivesのサンプルコード
<?php $args = array( 'type' => 'monthly', 'limit' => '', 'format' => 'html', 'before' => '', 'after' => '', 'show_post_count' => false, 'echo' => 1, 'order' => 'DESC', 'post_type' => 'post' ); ?> <ul> <?php wp_get_archives( $args ); ?> </ul>
上記のパラメータはデフォルト設定の内容です。パラメータを編集することで表示順や出力する投稿タイプを指定することができます。パラメータの詳細は以下になります。
wp_get_archivesのパラメータ
type
表示するアーカイブリストの種類。初期値は月別アーカイブ。
yearly
年別アーカイブを出力
monthly
月別アーカイブを出力(初期値)
weekly
週別アーカイブを出力
postbypost
公開日時順に出力
alpha
アルファベット順に出力
limit
取得するアーカイブ数を整数で指定できます。初期値は制限なし。
format
アーカイブリストの形式を指定します。
html
HTML (<li>)で囲む。
option
セレクトボックスまたはドロップダウンメニュー用のセレクトタグ(<select>)内で使用するために、オプションタグ(<option>)で囲む。
link
リンクタグ(<link>)に入れる。
custom
後述の before と after を使って編集できるカスタムリスト。
before
format オプションが html または custom のとき、リンクの前に付けるテキスト。デフォルトは空文字列。
after
format オプションが html または custom のとき、リンクの後に付けるテキスト。デフォルトは空文字列。
show_post_count
投稿数を表示するかどうか。type オプションが ‘postbypost’ のときは無視される。
1 (True)
表示する
0 (False)
表示しない
echo
表示するか、値として返すかを指定します。
1 (True)
表示する(初期値)
0 (False)
表示せず値として返す
order
リンクリストの順序を指定します。
ASC
昇順(A から Z へ)
DESC
降順(Z から A へ)(デフォルト)
post_type
表示する投稿タイプを指定します。
まとめ
wp_get_archives
を使った過去記事一覧表示の、各種設定について紹介しました。wp_get_archives
はループ外でも動作するタグですので、ページのサイドナビなどに便利機能として過去記事一覧を表示したいときに、とても簡単で有用です。カスタム投稿の過去記事一覧も簡単に指定できるので、wordpressサイト制作時に活用してみてください。