説明
string get_archives_link( string $url, string $text [ , string $format = 'html' [ , string $before = '' [ , string $after = '' [ , bool $selected = false ] ] ] ] )
アーカイブページのリンクテキストを取得する。
パラメータ
- $urlURLを指定。
- $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" |
バージョンによって本関数のパラメータと'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
関連
お勧め
5.7の新機能：AJAXでパスワードを取得（2021年2月17日 更新）
日本時間の今朝「WordPress 5.7 Beta 3（以降Beta 3）」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。
5.4.1でパーマリンクの仕様が一部変更された件（2020年5月12日 更新）
先月末にリリースされたバージョン5.4.1のアップデートにより、一部のサイトで投稿ページが従来通りに表示されなくなる不具合が発生し、サポートサイトにレポートが上がりました。この件について、ちょっとモヤモヤしたので自分なりに考えてみました。
使っていないか確認しないとね！（2022年6月7日 更新）
2003年に誕生したWordPress。その歴史の中には、廃止予定（deprecated）となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここではHTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。テーブルの1列目をth要素にしてみる（2021年12月21日 更新）
標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。