get_archives_link

（1.0.0以降）
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

関連

参考

Code Reference: get_archives_link

お勧め

ブロックエディターの色設定を変えてみる（2019年12月11日 更新）

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を（2013年11月6日 更新）

WordPressのユーザー情報設定ページでは、「名（First name）」の後に「姓（Last name）」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介（2021年3月8日 更新）

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。