AI要約
説明
wpforms_field_propertiesフィルターは、フォームの読み込み時に、ラベル、サブラベル、説明などのフィールドプロパティをフォームフィールドの上に表示するために実行されます。
パラメーター
- $プロパティ
- (配列) ラベル、サブラベル、説明などのフィールドプロパティの配列。
- $field
- (配列) サニタイズされたフィールドデータ。
- $form_data
- (配列) 後で使用するために処理および準備されたフォーム設定/データ。
ソース
wpforms/includes/fields/class-base.php
詳細情報
このフィルターは、特定のフォームフィールドプロパティの配列に適用されます。このフィルターを使用すると、すべてのフォームフィールドが変更されます。
各フォームフィールドには、独自のフィルター名があります。文書化された例の完全なリストについては、以下のセクションを参照してください。たとえば、メールフォームフィールドのみを変更したい場合は、wpforms_field_properties_emailを使用します。
例
以下の例では、この関数は、フォームID225の場合にのみ、フィールド自体のの上にフィールド説明を表示します。
/**
* Move the field description above the form field.
*
* @link https://wpforms.com/developers/wpforms_field_properties/
*
* @param array $properties Field properties.
* @param array $field Field settings.
* @param array $form_data Form data and settings.
*
* @return array
*/
function wpf_dev_field_properties( $properties, $field, $form_data ) {
// Only process this snippet on the form ID 225
if ( absint( $form_data[ 'id' ] ) !== 225 ) {
return $properties;
}
// move the field description from under the form field to above the form field
$properties[ 'description' ][ 'position' ] = 'before';
return $properties;
}
add_filter( 'wpforms_field_properties', 'wpf_dev_field_properties', 10, 3 );