get_archives_link:WordPress私的マニュアル

get_archives_link

(1.0.0以降)
get_archives_link - アーカイブページのリンクテキストを取得する

説明

string get_archives_link( string $url, string $text [ , string $format = 'html' [ , string $before = '' [ , string $after = '' ] ] ] )

アーカイブページのリンクテキストを取得する。

パラメータ

$url
URLを指定。
$text
カテゴリー名などのリンク名を指定。
$format
'html'、'link'、'option'などを指定（省略時は'html'）。
$before
リンク名の前に連結されるテキストを指定（省略時は''）。
$after
リンク名の後に連結されるテキストを指定（省略時は''）。

返り値

パラメータ$formatで指定されたリンクテキストを返す。

注意

パラメータ$formatと返されるリンクテキストの書式は次の通り。'html'を指定した場合はliタグで囲まれたものになる。

$formatの値	リンクテキスト
'html'	"\t<li>$before<a href='$url' title='$title_text'>$text</a>$after</li>\n"
'link'	"\t<link rel='archives' title='$title_text' href='$url' />\n"
'option'	"\t<option value='$url'>$before $text $after</option>\n"
上記以外	"\t$before<a href='$url' title='$title_text'>$text</a>$after\n"

※$title_textの内容はesc_attr( $text )。

使用例

カテゴリ1のアーカイブページのリンクテキストを取得する。
<?php $out = get_archives_link( 'http://localhost/category/category1', 'カテゴリ1' ); ?>
カテゴリ1のプルダウメニューテキストを取得する。
<?php $out = get_archives_link( 'http://localhost/category/category1', 'カテゴリ1', 'option' ); ?>

フィルター

[2.6.0]リンクテキストを返す直前にget_archives_linkフィルターが実行される。$link_htmlには、生成されたリンクテキストの内容が格納されている。
[4.5.0]$url、$text、$format、$before、$afterが追加され、それぞれ本関数が受け取った内容が格納されている。

return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after );

アクション

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

ソースファイル

/wp-includes/general-template.php

参考

Code Reference: get_archives_link

お勧めコンテンツ

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日登録）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

もうquery_postsは呼ばない（2011年9月27日登録）

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭でquery_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

4.4では投稿ページも専用テンプレートが適用できる（2015年11月7日登録）

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

初期化に関連するアクションのおさらい（2012年8月7日登録）

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

add_actionを使って管理ページで独自cssを使う（2011年2月25日登録）

テーマやプラグインで専用の管理ページを作る場合、そのページ向けのcssやjavascriptが必要になることがある。どちらもページ内に直接記述できるが、特にcssは別ファイルに分けたいほうが便利だ。ここではその方法を紹介しよう。