get_archives_link

（1.0.0以降）
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

関連

参考

Code Reference: get_archives_link

お勧め

さくらのVPSでKUSANAGI#2（2018年5月27日 更新）

今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

カレンダーウィジェットをAjaxで切り替える（2011年8月22日 更新）

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

Somewhere search box：プラグイン作ってみました（2021年4月26日 更新）

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容（本文、カテゴリーや投稿タグ、カスタムフィールド）を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

5.3.1: サイト管理者のメールアドレス確認に関するアップデート（2020年4月2日 更新）

セキュリティ＆メンテナンスアップデートの5.3.1がリリースされ、その中に以前投稿した「5.3の新機能：サイト管理者のメールアドレスを定期的に確認する」に関連したアップデートがあったので紹介する。