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



お勧め

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。