• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get archives link

提供: WordPress Codex 日本語版
移動先: 案内検索

アーカイブへのリンク文字列を、所定のフォーマットまたはカスタムコードに基づいて取得します。

フォーマットは 4 種類あります。'link'head 要素向け、'option'select 要素向け、'html' はリスト(HTML の ol または ul 要素)向けです。この 3 種類のどれでもないフォーマットはカスタムになります。

  • 'link' フォーマットは HTML の link 要素を使います。関係性(rel 属性)は archives になります。$before$after パラメータは使われません。text パラメータはリンクテキストとして使われます。
  • 'option' フォーマットは HTML の option 要素(select 要素の中に入れる)を使います。値(value 属性)は $url パラメータになります。テキスト部分は $before$after パラメータで $text パラメータを囲んだものになります。
  • 'html' フォーマットはデフォルトです。HTML の li 要素(リスト要素の中に入れる)を使います。$before がリンクの前に、$after パラメータがリンクを閉じた後に付きます。
  • カスタムフォーマットは $before パラメータをリンク(HTML の 'a' 要素)の前に付け、リンクタグを閉じた後に $after パラメータを付けます。上記の 3 種類のどれでもない値が $format に指定されるとカスタムフォーマットになります。

使い方

<?php get_archives_link( $url, $text, $format, $before, $after ); ?>

パラメータ

$url
文字列) (必須) アーカイブページの URL
初期値: なし
$text
文字列) (必須) アーカイブの説明テキスト。
初期値: なし
$format
文字列) (オプション) 有効な値は 'link', 'option', 'html' またはカスタム。
初期値: 'html'
$before
文字列) (オプション) 前に付けるテキスト。
初期値: 空文字列
$after
文字列) (オプション) 後に付けるテキスト。
初期値: 空文字列

戻り値

(文字列) 
アーカイブへのリンクを表す HTML コンテンツ。

参考

  • apply_filters() を使用して、HTML リンクコンテンツを返す前に 'get_archives_link' フィルターフックを呼び出します。

変更履歴

  • 1.0.0 : 新規導入。

ソースファイル

get_archives_link()wp-includes/general-template.php にあります。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/get_archives_link最新版との差分