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



お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。