wp_get_archives

(1.2.0以降)
wp_get_archives - アーカイブリンクを表示する

説明

string wp_get_archives( [ mixed $args = '' ] )
投稿記事のアーカイブリンクをパラメータ$argsのecho値が1ならば表示する。echo値が0ならばその文字列を取得する。

パラメータ

  • $args
    表示条件を指定する文字列(または連想配列)。文字列の場合はname=valueの形式で指定し、複数の条件はname1=value1&name2=value2のように'&'の後に続ける。主なキーワードは次の通り。
    キーワード省略時の値意味
    type'monthly'アーカイブ種別を指定('daily'、'weekly'、'monthly'、'yearly'、'postbypost'、'alpha'など)
    limit''表示件数(正数)
    format'html'表示形式を指定('html'、'link'、'option'など)
    before''リンク名の前に連結する文字列
    after''リンク名の後に連結する文字列
    show_post_countfalse投稿件数を表示する場合はtrue、表示しない場合はfalse
    echo1表示する場合は1、文字列として取得する場合は0
    order'DESC'降順は'DESC'、昇順は'ASC'を指定
    post_type'post'[4.4.0]投稿タイプを指定

返り値

パラメータ$argsにecho値が0の場合は、リンクの文字列を返す。echo値が1(デフォルト)の場合は何も返さない。

注意

4.4.0で'post_type'パラメータが追加され、任意の投稿タイプのアーカイブ情報を取得できるようになった。

使用例

  • アーカイブリンクを表示する。
    <?php wp_get_archives( ); ?>

フィルター

[2.2.0]検索を行う直前にgetarchives_whereフィルターが実行される。このフィルターを利用することで、アーカイブの取得条件を変更できる。フィルター関数には$where$r(本関数呼び出し時のパラメータが展開されたもの)が渡り、$whereにはデフォルトとして "WHERE post_type = 'post' AND post_status = 'publish'" が格納されている。
$where = apply_filters( 'getarchives_where', $where, $r );
[2.2.0]getarchives_whereフィルターの実行直後にgetarchives_joinフィルターが実行される。アーカイブの取得条件で投稿情報以外のテーブルを使用する場合にこのフィルターを利用する。フィルター関数には$join$rが渡り、$whereにはデフォルトとして '' が格納されている。
$join = apply_filters( 'getarchives_join', $join, $r );
指定された条件で取得された投稿情報に投稿タイトルがある場合は'the_title'フィルターを呼び出す。パラメータ$post_titleには投稿タイトルが、$post_idには投稿IDが格納される。
$text = strip_tags( apply_filters( 'the_title', $post_title, $post_id ) );

アクション

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

ソースファイル

/wp-includes/general-template.php

関連

  • get_archives_link - アーカイブページのリンクテキストを取得する
  • get_header - テーマ内のheader.phpを読み込む
  • get_sidebar - テーマ内のsidebar.phpを読み込む

お勧めコンテンツ

決まった値を返すだけの関数群(2015年7月15日 登録)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

テーマから投稿画像のサイズを指定する(2012年3月15日 登録)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2011年5月2日 登録)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

Blacklist keys manager:プラグイン作ってみました(2013年9月13日 登録)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 登録)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

最終更新日時 : 2015-12-14 17:39