get_archives_link

説明

string get_archives_link( string $url, string $text [ , string $format = 'html' [ , string $before = '' [ , string $after = '' [ , bool $selected = false ] ] ] ] )
アーカイブページのリンクテキストを取得する。

パラメータ

  • $url
    URLを指定。
  • $text
    カテゴリー名などのリンク名を指定。
  • $format
    'html'、'link'、'option'などを指定(省略時は'html')。
  • $before
    リンク名の前に連結されるテキストを指定(省略時は'')。
  • $after
    リンク名の後に連結されるテキストを指定(省略時は'')。
  • $selected
    [5.2.0]option要素にselected属性を付与するかどうかを指定(省略時はfalse、$formatが'option'の場合のみ有効)。

返り値

パラメータ$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 )。

バージョンによって本関数のパラメータと'get_archives_link'フィルターのパラメータ数が異なる。


使用例

  • カテゴリ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が追加され、それぞれ本関数が受け取った内容が格納されている。
[5.2.0]$selectedには本関数が受け取った内容が格納されている。
return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after, $selected );

アクション

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

ソースファイル

/wp-includes/general-template.php

最終更新 : 2019年05月09日 14:48



お勧め

囲み型ショートコードとwpautop(2018年5月27日 更新)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。