説明
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) name select要素のname属性値を指定(省略時は'cat') id select要素のid属性値を指定(省略時は'') class select要素のclass属性値を指定(省略時は'postform') tab_index select要素のtabindex属性値を指定(省略時は0) hide_if_empty 条件にマッチするカテゴリーがない場合にselect要素を出力しない場合はtrue、必ず出力する場合はfalseを指定(省略時はfalse) option_none_value (最初に表示される)未選択時のoption要素のvalue属性値を指定(省略時は-1) value_field option要素の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) hierarchical true(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
関連
お勧め
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」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。