説明
パラメータ
- $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には本関数が受け取った内容が格納されている。
アクション
実行するアクションはありません。ソースファイル
/wp-includes/general-template.php最終更新 : 2019年05月09日 14:48
関連
お勧め
wp_titleからwp_get_document_titleへ(2018年5月27日 更新)
先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
ツイート引用が簡単になる仕組み(2012年6月8日 更新)
WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
サイトヘルス機能を使ってみた(2019年4月12日 更新)
先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。
ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)
ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。