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



お勧め

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。

5.4.1でパーマリンクの仕様が一部変更された件(2020年5月12日 更新)

先月末にリリースされたバージョン5.4.1のアップデートにより、一部のサイトで投稿ページが従来通りに表示されなくなる不具合が発生し、サポートサイトにレポートが上がりました。この件について、ちょっとモヤモヤしたので自分なりに考えてみました。

使っていないか確認しないとね!(2022年6月7日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.25.9.0現在、廃止予定となっている関数をまとめて紹介する。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

テーブルの1列目をth要素にしてみる(2021年12月21日 更新)

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。