説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo：プラグイン作ってみました（2019年9月19日 更新）
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。