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