wp_list_bookmarks

説明

string wp_list_bookmarks( [ mixed $args = '' ] )
ブックマーク(管理画面の「リンク」)をパラメータ$argsのecho値が1ならば表示する。echo値が0ならばその文字列を取得する。

パラメータ

  • $args
    表示条件を指定する文字列(または連想配列)。文字列の場合はname=valueの形式で指定し、複数の条件はname1=value1&name2=value2のように'&'の後に続ける。キーワードは次の通り。
    キーワード省略時の値意味
    orderby'name'リンクのソート対象を指定('name'、'length'、'rand'など)
    order'ASC'リンクのソート順を示す'ASC'(昇順)か'DESC'(降順)
    limit-1表示件数(-1の場合はすべてを表示)
    category''カテゴリーを限定する場合に、それらのカテゴリーIDを指定
    exclude_category''特定のカテゴリーを除外する場合に、それらのカテゴリーIDを指定
    category_name''カテゴリーを限定する場合に、それらのカテゴリー名を指定
    hide_invisible1非表示指定のリンクを隠す場合は1、表示する場合は0
    show_updated0更新日時を表示する場合は1、表示しない場合は0
    echo1表示する場合は1、文字列として取得する場合は0
    categorize1カテゴリー別に表示する場合は1、すべてまとめて表示する場合は0
    title_li__('Bookmarks')見出し名
    title_before'<h2>'見出し名の前に連結する文字列
    title_after'</h2>'見出し名の後に連結する文字列
    category_orderby'name'カテゴリーのソート対象を指定('name'、'count'、'slug'など)
    category_order'ASC'カテゴリーのソート順を示す'ASC'(昇順)か'DESC'(降順)
    class'linkcat'カテゴリー名のタグに指定するクラス名
    category_before'<li id="%id" class="%class">'カテゴリー名の前に連結する文字列
    category_after'</li>'カテゴリー名の後に連結する文字列

返り値

パラメータ$argsにecho値が0の場合は、リンクの文字列を返す。echo値が1(デフォルト)の場合は何も返さない。

注意

特にありません。

使用例

  • すべてのブックマークを表示する。
    <?php wp_list_bookmarks( ); ?>
  • blogカテゴリーのブックマークのみを表示する。
    <?php wp_list_bookmarks( 'category_name=blog' ); ?>

最終更新 : 2018年05月27日 10:48



お勧め

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

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

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