説明
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
関連
お勧め
カスタムフィールド関連関数のおさらい（2012年6月22日 更新）
カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。「順序」をtextからnumberに変更してみた（2018年5月27日 更新）
固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。
Login rebuilderのログ表示機能を紹介（2018年5月27日 更新）
プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。
query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）
先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。メタボックスをクラシックエディターのみで表示する（2019年1月15日 更新）
投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。