get_archives_link

説明

string get_archives_link( string $url, string $text [ , string $format = 'html' [ , string $before = '' [ , string $after = '' [ , bool $selected = false ] ] ] ] )
アーカイブページのリンクテキストを取得する。

パラメータ

  • $url
    URLを指定。
  • $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"
$title_textの内容は esc_attr( $text )。

バージョンによって本関数のパラメータと'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



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。