wp_dropdown_categories

説明

string wp_dropdown_categories( [ mixed $args = '' ] )
ドロップダウン形式のカテゴリーリストを表示または取得する。

パラメータ

  • $args
    検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
    キーワード意味
    show_option_allトップページURLのテキストを指定(省略時は'')
    show_option_noneカテゴリーがない場合のテキストを指定(省略時は__('No categories'))
    show_last_update最終更新日を出力する場合はtrue、出力しない場合はfalseを指定(省略時はfalse)
    show_count投稿数を表示する場合はtrue、表示しない場合はfalseを指定(省略時はfalse)
    echo表示する場合はtrue、取得する場合はfalseを指定(省略時はtrue)
    depth階層付きの場合はtrue、階層なし(フラット)の場合はfalseを指定(省略時はfalse)
    nameselect要素のname属性値を指定(省略時は'cat')
    idselect要素のid属性値を指定(省略時は'')
    classselect要素のclass属性値を指定(省略時は'postform')
    tab_indexselect要素のtabindex属性値を指定(省略時は0)
    hide_if_empty条件にマッチするカテゴリーがない場合にselect要素を出力しない場合はtrue、必ず出力する場合はfalseを指定(省略時はfalse)
    option_none_value(最初に表示される)未選択時のoption要素のvalue属性値を指定(省略時は-1)
    value_fieldoption要素のvalue属性値を指定(省略時は'term_id')
    required[4.6.0]select要素にrequired属性を指定(省略時はfalse)

    内部で呼び出される get_termsと共通するパラメータは次の通り。
    キーワード意味
    orderbyソート対象を示すcount、name、slug、term_group、none、idなど(省略時は'name')
    orderソート順を示すASCかDESC(省略時はASC)
    hide_empty投稿記事がないカテゴリーを取得しない場合はtrue(1)、投稿記事がないカテゴリーも取得する場合はfalse(0)を指定(省略時はtrue)
    exclude取得したくないカテゴリーのID(複数指定する場合は,で区切る。省略時は'')
    child_ofカテゴリーのIDを指定(そのIDのカテゴリーの子孫がすべて対象となる。省略時はfalse)
    hierarchicaltrue(1)またはfalse(0)を指定(省略時はtrue)
    taxonomyタクソノミーのスラッグを指定(省略時は'category')

返り値

パラメータ$argsで'echo'の値に0を指定した場合はカテゴリーリストのHTMLテキストを返す。'echo'の値が1の場合は何も返さない。

注意

デフォルトでは'hide_empty'が1(true)のため、投稿のないカテゴリーは含まれない。投稿数に関係なくすべてのカテゴリーを表示(取得)する場合は、'hide_empty=0'を指定する。
パラメータ$argsには'selected'があり、カテゴリーアーカイブページの場合には現在のカテゴリーのIDが設定されるようになっている。 [4.2.0]'value_field'が追加され、option要素のvalue属性値にタームID以外(例:カテゴリー名)を表示できるようになった。

使用例

  • ドロップダウン形式のカテゴリーリストを表示する。
    <?php wp_dropdown_categories(); ?>
  • ドロップダウン形式の全カテゴリーリストを取得する。
    <?php $dropdown = wp_dropdown_categories( array( 'echo'=>0, 'hide_empty'=>0, 'hierarchical'=>1 ) ); ?>

フィルター

HTMLテキストを表示または返す直前にwp_dropdown_catsフィルターを実行する。$outputにはHTMLテキストが入る。
$output = apply_filters( 'wp_dropdown_cats', $output );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/category-template.php

最終更新 : 2016年08月22日 11:38



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。