WordPressでフォームのHTMLタグなどを出力したいことがありますね。そういった場合に便利な関数が用意されているので、いくつか紹介します。
checked() 関数
二つの値を比較し、一致した場合に 「 checked=‘checked’」 (一致しない場合は空)を出力または返します。※先頭に半角空白があることに注意してください。
checked($checked, $current, $display);
- $checked は、[文字列等]で、比較したい値の片方を入れます。
- $current は、[文字列等]で、比較したい値のもう一方を入れます。未指定の場合は true
- $display は、[真偽値]で、出力する場合はtrue、値を返す場合はfalseを指定します。未指定の場合は true
selected() 関数
二つの値を比較し、一致した場合に 「 selected=‘selected’」 (一致しない場合は空)を出力または返します。※先頭に半角空白があることに注意してください。
selected($selected, $current, $display);
- $selected は、[文字列等]で、比較したい値の片方を入れます。
- $current は、[文字列等]で、比較したい値のもう一方を入れます。未指定の場合は true
- $display は、[真偽値]で、出力する場合はtrue、値を返す場合はfalseを指定します。未指定の場合は true
disabled() 関数
二つの値を比較し、一致した場合に 「 disabled=‘disabled’」 (一致しない場合は空)を出力または返します。※先頭に半角空白があることに注意してください。
disabled($disabled, $current, $display);
- $disabled は、[文字列等]で、比較したい値の片方を入れます。
- $current は、[文字列等]で、比較したい値のもう一方を入れます。未指定の場合は true
- $display は、[真偽値]で、出力する場合はtrue、値を返す場合はfalseを指定します。未指定の場合は true
wp_readonly() 関数
二つの値を比較し、一致した場合に 「 readonly=‘readonly’」 (一致しない場合は空)を出力または返します。※先頭に半角空白があることに注意してください。
wp_readonly($readonly_value, $current, $display);
- $readonly_value は、[文字列等]で、比較したい値の片方を入れます。
- $current は、[文字列等]で、比較したい値のもう一方を入れます。未指定の場合は true
- $display は、[真偽値]で、出力する場合はtrue、値を返す場合はfalseを指定します。未指定の場合は true
wp_readonly()関数は、旧来はreadonly()でしたが、PHP8.1以降で readonly が予約語となったため、現在(WP5.9以降)はwp_readonly()を使うようになっています。
wp_required_field_indicator() 関数
この関数は、 <span class="required">*</span> を返します。 * の部分は、言語設定によっては別の記号や文字に翻訳されることがあります。
wp_required_field_indicator(); // <span class="required">*</span> を返す
表示内容を変更したい場合は、wp_required_field_indicator フィルターフックを活用できます。
wp_required_field_message() 関数
この関数は、 <span class="required-field-message">Required fields are marked <span class="required">*</span></span> を返します。 <span class="required">*</span>の部分は、wp_required_field_indicator() が返す文字列です。
wp_required_field_message(); // <span class="required-field-message">Required fields are marked <span class="required">*</span></span> を返す
表示内容を変更したい場合は、wp_required_field_message フィルターフックを活用できます。
更新日:
