%PDF- %PDF-
Direktori : /home/tradesc/www/relax/wp-content/plugins/wpforms-lite/includes/fields/ |
Current File : /home/tradesc/www/relax/wp-content/plugins/wpforms-lite/includes/fields/class-name.php |
<?php if ( ! defined( 'ABSPATH' ) ) { exit; } /** * Name text field. * * @since 1.0.0 */ class WPForms_Field_Name extends WPForms_Field { /** * Primary class constructor. * * @since 1.0.0 */ public function init() { // Define field type information. $this->name = esc_html__( 'Name', 'wpforms-lite' ); $this->keywords = esc_html__( 'user, first, last', 'wpforms-lite' ); $this->type = 'name'; $this->icon = 'fa-user'; $this->order = 150; $this->hooks(); } /** * Hooks. * * @since 1.8.1 */ private function hooks() { // Define additional field properties. add_filter( 'wpforms_field_properties_name', [ $this, 'field_properties' ], 5, 3 ); // Set field to default to required. add_filter( 'wpforms_field_new_required', [ $this, 'default_required' ], 10, 2 ); // This field requires fieldset+legend instead of the field label. add_filter( "wpforms_frontend_modern_is_field_requires_fieldset_{$this->type}", [ $this, 'is_field_requires_fieldset' ], PHP_INT_MAX, 2 ); } /** * Define additional field properties. * * @since 1.3.7 * * @param array $properties Field properties. * @param array $field Field data and settings. * @param array $form_data Form data and settings. * * @return array */ public function field_properties( $properties, $field, $form_data ) { $format = ! empty( $field['format'] ) ? esc_attr( $field['format'] ) : 'first-last'; // Simple format. if ( 'simple' === $format ) { $properties['inputs']['primary']['attr']['placeholder'] = ! empty( $field['simple_placeholder'] ) ? $field['simple_placeholder'] : ''; $properties['inputs']['primary']['attr']['value'] = ! empty( $field['simple_default'] ) ? wpforms_process_smart_tags( $field['simple_default'], $form_data ) : ''; return $properties; } // Expanded formats. // Remove primary for expanded formats since we have first, middle, last. unset( $properties['inputs']['primary'] ); // Remove reference to an input element to prevent duplication. if ( empty( $field['sublabel_hide'] ) ) { unset( $properties['label']['attr']['for'] ); } $form_id = absint( $form_data['id'] ); $field_id = wpforms_validate_field_id( $field['id'] ); $props = [ 'inputs' => [ 'first' => [ 'attr' => [ 'name' => "wpforms[fields][{$field_id}][first]", 'value' => ! empty( $field['first_default'] ) ? wpforms_process_smart_tags( $field['first_default'], $form_data ) : '', 'placeholder' => ! empty( $field['first_placeholder'] ) ? $field['first_placeholder'] : '', ], 'block' => [ 'wpforms-field-row-block', 'wpforms-first', ], 'class' => [ 'wpforms-field-name-first', ], 'data' => [], 'id' => "wpforms-{$form_id}-field_{$field_id}", 'required' => ! empty( $field['required'] ) ? 'required' : '', 'sublabel' => [ 'hidden' => ! empty( $field['sublabel_hide'] ), 'value' => esc_html__( 'First', 'wpforms-lite' ), ], ], 'middle' => [ 'attr' => [ 'name' => "wpforms[fields][{$field_id}][middle]", 'value' => ! empty( $field['middle_default'] ) ? wpforms_process_smart_tags( $field['middle_default'], $form_data ) : '', 'placeholder' => ! empty( $field['middle_placeholder'] ) ? $field['middle_placeholder'] : '', ], 'block' => [ 'wpforms-field-row-block', 'wpforms-one-fifth', ], 'class' => [ 'wpforms-field-name-middle', ], 'data' => [], 'id' => "wpforms-{$form_id}-field_{$field_id}-middle", 'required' => '', 'sublabel' => [ 'hidden' => ! empty( $field['sublabel_hide'] ), 'value' => esc_html__( 'Middle', 'wpforms-lite' ), ], ], 'last' => [ 'attr' => [ 'name' => "wpforms[fields][{$field_id}][last]", 'value' => ! empty( $field['last_default'] ) ? wpforms_process_smart_tags( $field['last_default'], $form_data ) : '', 'placeholder' => ! empty( $field['last_placeholder'] ) ? $field['last_placeholder'] : '', ], 'block' => [ 'wpforms-field-row-block', ], 'class' => [ 'wpforms-field-name-last', ], 'data' => [], 'id' => "wpforms-{$form_id}-field_{$field_id}-last", 'required' => ! empty( $field['required'] ) ? 'required' : '', 'sublabel' => [ 'hidden' => ! empty( $field['sublabel_hide'] ), 'value' => esc_html__( 'Last', 'wpforms-lite' ), ], ], ], ]; $properties = array_merge_recursive( $properties, $props ); $has_common_error = ! empty( $properties['error']['value'] ) && is_string( $properties['error']['value'] ); // Input First: add error class if needed. if ( ! empty( $properties['error']['value']['first'] ) || $has_common_error ) { $properties['inputs']['first']['class'][] = 'wpforms-error'; } // Input First: add required class if needed. if ( ! empty( $field['required'] ) ) { $properties['inputs']['first']['class'][] = 'wpforms-field-required'; } // Input First: add column class. $properties['inputs']['first']['block'][] = 'first-last' === $format ? 'wpforms-one-half' : 'wpforms-two-fifths'; // Input Middle: add error class if needed. if ( $has_common_error ) { $properties['inputs']['middle']['class'][] = 'wpforms-error'; } // Input Last: add error class if needed. if ( ! empty( $properties['error']['value']['last'] ) || $has_common_error ) { $properties['inputs']['last']['class'][] = 'wpforms-error'; } // Input Last: add required class if needed. if ( ! empty( $field['required'] ) ) { $properties['inputs']['last']['class'][] = 'wpforms-field-required'; } // Input Last: add column class. $properties['inputs']['last']['block'][] = 'first-last' === $format ? 'wpforms-one-half' : 'wpforms-two-fifths'; return $properties; } /** * Name fields should default to being required. * * @since 1.0.8 * * @param bool $required * @param array $field * * @return bool */ public function default_required( $required, $field ) { if ( 'name' === $field['type'] ) { return true; } return $required; } /** * Field options panel inside the builder. * * @since 1.0.0 * * @param array $field */ public function field_options( $field ) { // Define data. $format = ! empty( $field['format'] ) ? esc_attr( $field['format'] ) : 'first-last'; /* * Basic field options. */ // Options open markup. $args = [ 'markup' => 'open', ]; $this->field_option( 'basic-options', $field, $args ); // Label. $this->field_option( 'label', $field ); // Format. $lbl = $this->field_element( 'label', $field, [ 'slug' => 'format', 'value' => esc_html__( 'Format', 'wpforms-lite' ), 'tooltip' => esc_html__( 'Select format to use for the name form field', 'wpforms-lite' ), ], false ); $fld = $this->field_element( 'select', $field, [ 'slug' => 'format', 'value' => $format, 'options' => [ 'simple' => esc_html__( 'Simple', 'wpforms-lite' ), 'first-last' => esc_html__( 'First Last', 'wpforms-lite' ), 'first-middle-last' => esc_html__( 'First Middle Last', 'wpforms-lite' ), ], ], false ); $args = [ 'slug' => 'format', 'content' => $lbl . $fld, ]; $this->field_element( 'row', $field, $args ); // Description. $this->field_option( 'description', $field ); // Required toggle. $this->field_option( 'required', $field ); // Options close markup. $args = [ 'markup' => 'close', ]; $this->field_option( 'basic-options', $field, $args ); /* * Advanced field options. */ // Options open markup. $args = [ 'markup' => 'open', ]; $this->field_option( 'advanced-options', $field, $args ); // Size. $this->field_option( 'size', $field ); echo '<div class="format-selected-' . esc_attr( $format ) . ' format-selected">'; // Simple. $simple_placeholder = ! empty( $field['simple_placeholder'] ) ? esc_attr( $field['simple_placeholder'] ) : ''; $simple_default = ! empty( $field['simple_default'] ) ? esc_attr( $field['simple_default'] ) : ''; printf( '<div class="wpforms-clear wpforms-field-option-row wpforms-field-option-row-simple" id="wpforms-field-option-row-%d-simple" data-subfield="simple" data-field-id="%d">', esc_attr( $field['id'] ), esc_attr( $field['id'] ) ); $this->field_element( 'label', $field, [ 'slug' => 'simple_placeholder', 'value' => esc_html__( 'Name', 'wpforms-lite' ), 'tooltip' => esc_html__( 'Name field advanced options.', 'wpforms-lite' ), ] ); echo '<div class="wpforms-field-options-columns-2 wpforms-field-options-columns">'; echo '<div class="placeholder wpforms-field-options-column">'; printf( '<input type="text" class="placeholder" id="wpforms-field-option-%d-simple_placeholder" name="fields[%d][simple_placeholder]" value="%s">', (int) $field['id'], (int) $field['id'], esc_attr( $simple_placeholder ) ); printf( '<label for="wpforms-field-option-%d-simple_placeholder" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Placeholder', 'wpforms-lite' ) ); echo '</div>'; echo '<div class="default wpforms-field-options-column">'; printf( '<input type="text" class="default" id="wpforms-field-option-%d-simple_default" name="fields[%d][simple_default]" value="%s">', (int) $field['id'], (int) $field['id'], esc_attr( $simple_default ) ); printf( '<label for="wpforms-field-option-%d-simple_default" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Default Value', 'wpforms-lite' ) ); echo '</div>'; echo '</div>'; echo '</div>'; // First. $first_placeholder = ! empty( $field['first_placeholder'] ) ? esc_attr( $field['first_placeholder'] ) : ''; $first_default = ! empty( $field['first_default'] ) ? esc_attr( $field['first_default'] ) : ''; printf( '<div class="wpforms-clear wpforms-field-option-row wpforms-field-option-row-first" id="wpforms-field-option-row-%d-first" data-subfield="first-name" data-field-id="%d">', esc_attr( $field['id'] ), esc_attr( $field['id'] ) ); $this->field_element( 'label', $field, [ 'slug' => 'first_placeholder', 'value' => esc_html__( 'First Name', 'wpforms-lite' ), 'tooltip' => esc_html__( 'First name field advanced options.', 'wpforms-lite' ), ] ); echo '<div class="wpforms-field-options-columns-2 wpforms-field-options-columns">'; echo '<div class="placeholder wpforms-field-options-column">'; printf( '<input type="text" class="placeholder" id="wpforms-field-option-%1$d-first_placeholder" name="fields[%1$d][first_placeholder]" value="%2$s">', (int) $field['id'], esc_attr( $first_placeholder ) ); printf( '<label for="wpforms-field-option-%d-first_placeholder" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Placeholder', 'wpforms-lite' ) ); echo '</div>'; echo '<div class="default wpforms-field-options-column">'; printf( '<input type="text" class="default" id="wpforms-field-option-%1$d-first_default" name="fields[%1$d][first_default]" value="%2$s">', (int) $field['id'], esc_attr( $first_default ) ); printf( '<label for="wpforms-field-option-%d-first_default" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Default Value', 'wpforms-lite' ) ); echo '</div>'; echo '</div>'; echo '</div>'; // Middle. $middle_placeholder = ! empty( $field['middle_placeholder'] ) ? esc_attr( $field['middle_placeholder'] ) : ''; $middle_default = ! empty( $field['middle_default'] ) ? esc_attr( $field['middle_default'] ) : ''; printf( '<div class="wpforms-clear wpforms-field-option-row wpforms-field-option-row-middle" id="wpforms-field-option-row-%d-middle" data-subfield="middle-name" data-field-id="%d">', esc_attr( $field['id'] ), esc_attr( $field['id'] ) ); $this->field_element( 'label', $field, [ 'slug' => 'middle_placeholder', 'value' => esc_html__( 'Middle Name', 'wpforms-lite' ), 'tooltip' => esc_html__( 'Middle name field advanced options.', 'wpforms-lite' ), ] ); echo '<div class="wpforms-field-options-columns-2 wpforms-field-options-columns">'; echo '<div class="placeholder wpforms-field-options-column">'; printf( '<input type="text" class="placeholder" id="wpforms-field-option-%1$d-middle_placeholder" name="fields[%1$d][middle_placeholder]" value="%2$s">', (int) $field['id'], esc_attr( $middle_placeholder ) ); printf( '<label for="wpforms-field-option-%d-middle_placeholder" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Placeholder', 'wpforms-lite' ) ); echo '</div>'; echo '<div class="default wpforms-field-options-column">'; printf( '<input type="text" class="default" id="wpforms-field-option-%1$d-middle_default" name="fields[%1$d][middle_default]" value="%2$s">', (int) $field['id'], esc_attr( $middle_default ) ); printf( '<label for="wpforms-field-option-%d-middle_default" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Default Value', 'wpforms-lite' ) ); echo '</div>'; echo '</div>'; echo '</div>'; // Last. $last_placeholder = ! empty( $field['last_placeholder'] ) ? esc_attr( $field['last_placeholder'] ) : ''; $last_default = ! empty( $field['last_default'] ) ? esc_attr( $field['last_default'] ) : ''; printf( '<div class="wpforms-clear wpforms-field-option-row wpforms-field-option-row-last" id="wpforms-field-option-row-%d-last" data-subfield="last-name" data-field-id="%d">', esc_attr( $field['id'] ), esc_attr( $field['id'] ) ); $this->field_element( 'label', $field, [ 'slug' => 'last_placeholder', 'value' => esc_html__( 'Last Name', 'wpforms-lite' ), 'tooltip' => esc_html__( 'Last name field advanced options.', 'wpforms-lite' ), ] ); echo '<div class="wpforms-field-options-columns-2 wpforms-field-options-columns">'; echo '<div class="placeholder wpforms-field-options-column">'; printf( '<input type="text" class="placeholder" id="wpforms-field-option-%1$d-last_placeholder" name="fields[%1$d][last_placeholder]" value="%2$s">', (int) $field['id'], esc_attr( $last_placeholder ) ); printf( '<label for="wpforms-field-option-%d-last_placeholder" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Placeholder', 'wpforms-lite' ) ); echo '</div>'; echo '<div class="default wpforms-field-options-column">'; printf( '<input type="text" class="default" id="wpforms-field-option-%1$d-last_default" name="fields[%1$d][last_default]" value="%2$s">', (int) $field['id'], esc_attr( $last_default ) ); printf( '<label for="wpforms-field-option-%d-last_default" class="sub-label">%s</label>', (int) $field['id'], esc_html__( 'Default Value', 'wpforms-lite' ) ); echo '</div>'; echo '</div>'; echo '</div>'; echo '</div>'; // Custom CSS classes. $this->field_option( 'css', $field ); // Hide Label. $this->field_option( 'label_hide', $field ); // Hide sublabels. $sublabel_class = isset( $field['format'] ) && ! in_array( $field['format'], [ 'first-last', 'first-middle-last' ], true ) ? 'wpforms-hidden' : ''; $this->field_option( 'sublabel_hide', $field, [ 'class' => $sublabel_class ] ); // Options close markup. $args = [ 'markup' => 'close', ]; $this->field_option( 'advanced-options', $field, $args ); } /** * Field preview inside the builder. * * @since 1.0.0 * * @param array $field Field information. */ public function field_preview( $field ) { // Define data. $simple_placeholder = ! empty( $field['simple_placeholder'] ) ? $field['simple_placeholder'] : ''; $first_placeholder = ! empty( $field['first_placeholder'] ) ? $field['first_placeholder'] : ''; $middle_placeholder = ! empty( $field['middle_placeholder'] ) ? $field['middle_placeholder'] : ''; $last_placeholder = ! empty( $field['last_placeholder'] ) ? $field['last_placeholder'] : ''; $simple_default = ! empty( $field['simple_default'] ) ? $field['simple_default'] : ''; $first_default = ! empty( $field['first_default'] ) ? $field['first_default'] : ''; $middle_default = ! empty( $field['middle_default'] ) ? $field['middle_default'] : ''; $last_default = ! empty( $field['last_default'] ) ? $field['last_default'] : ''; $format = ! empty( $field['format'] ) ? $field['format'] : 'first-last'; // Label. $this->field_preview_option( 'label', $field ); ?> <div class="format-selected-<?php echo sanitize_html_class( $format ); ?> format-selected wpforms-clear"> <div class="wpforms-simple"> <input type="text" placeholder="<?php echo esc_attr( $simple_placeholder ); ?>" value="<?php echo esc_attr( $simple_default ); ?>" class="primary-input" readonly> </div> <div class="wpforms-first-name"> <input type="text" placeholder="<?php echo esc_attr( $first_placeholder ); ?>" value="<?php echo esc_attr( $first_default ); ?>" class="primary-input" readonly> <label class="wpforms-sub-label"><?php esc_html_e( 'First', 'wpforms-lite' ); ?></label> </div> <div class="wpforms-middle-name"> <input type="text" placeholder="<?php echo esc_attr( $middle_placeholder ); ?>" value="<?php echo esc_attr( $middle_default ); ?>" class="primary-input" readonly> <label class="wpforms-sub-label"><?php esc_html_e( 'Middle', 'wpforms-lite' ); ?></label> </div> <div class="wpforms-last-name"> <input type="text" placeholder="<?php echo esc_attr( $last_placeholder ); ?>" value="<?php echo esc_attr( $last_default ); ?>" class="primary-input" readonly> <label class="wpforms-sub-label"><?php esc_html_e( 'Last', 'wpforms-lite' ); ?></label> </div> </div> <?php // Description. $this->field_preview_option( 'description', $field ); } /** * Field display on the form front-end. * * @since 1.0.0 * * @param array $field Field information. * @param array $deprecated Deprecated parameter, not used anymore. * @param array $form_data Form data and settings. */ public function field_display( $field, $deprecated, $form_data ) { // Define data. $format = ! empty( $field['format'] ) ? esc_attr( $field['format'] ) : 'first-last'; $primary = ! empty( $field['properties']['inputs']['primary'] ) ? $field['properties']['inputs']['primary'] : ''; $first = ! empty( $field['properties']['inputs']['first'] ) ? $field['properties']['inputs']['first'] : ''; $middle = ! empty( $field['properties']['inputs']['middle'] ) ? $field['properties']['inputs']['middle'] : ''; $last = ! empty( $field['properties']['inputs']['last'] ) ? $field['properties']['inputs']['last'] : ''; // Simple format. if ( 'simple' === $format ) { // Primary field (Simple). printf( '<input type="text" %s %s>', wpforms_html_attributes( $primary['id'], $primary['class'], $primary['data'], $primary['attr'] ), esc_attr( $primary['required'] ) ); // Expanded formats. } else { // Row wrapper. echo '<div class="wpforms-field-row wpforms-field-' . sanitize_html_class( $field['size'] ) . '">'; // First name. echo '<div ' . wpforms_html_attributes( false, $first['block'] ) . '>'; $this->field_display_sublabel( 'first', 'before', $field ); printf( '<input type="text" %s %s>', wpforms_html_attributes( $first['id'], $first['class'], $first['data'], $first['attr'] ), esc_attr( $first['required'] ) ); $this->field_display_sublabel( 'first', 'after', $field ); $this->field_display_error( 'first', $field ); echo '</div>'; // Middle name. if ( 'first-middle-last' === $format ) { echo '<div ' . wpforms_html_attributes( false, $middle['block'] ) . '>'; $this->field_display_sublabel( 'middle', 'before', $field ); printf( '<input type="text" %s %s>', wpforms_html_attributes( $middle['id'], $middle['class'], $middle['data'], $middle['attr'] ), esc_attr( $middle['required'] ) ); $this->field_display_sublabel( 'middle', 'after', $field ); $this->field_display_error( 'middle', $field ); echo '</div>'; } // Last name. echo '<div ' . wpforms_html_attributes( false, $last['block'] ) . '>'; $this->field_display_sublabel( 'last', 'before', $field ); printf( '<input type="text" %s %s>', wpforms_html_attributes( $last['id'], $last['class'], $last['data'], $last['attr'] ), esc_attr( $last['required'] ) ); $this->field_display_sublabel( 'last', 'after', $field ); $this->field_display_error( 'last', $field ); echo '</div>'; echo '</div>'; } } /** * Validate field on form submit. * * @since 1.0.0 * * @param int $field_id Field id. * @param array|string $field_submit Submitted field value (raw data). * @param array $form_data Form data. */ public function validate( $field_id, $field_submit, $form_data ) { if ( empty( $form_data['fields'][ $field_id ]['required'] ) ) { return; } // Extended validation needed for the different name fields. $form_id = $form_data['id']; $format = $form_data['fields'][ $field_id ]['format']; $required = wpforms_get_required_label(); $process = wpforms()->obj( 'process' ); if ( $format === 'simple' && wpforms_is_empty_string( $field_submit ) ) { $process->errors[ $form_id ][ $field_id ] = $required; return; } if ( ! ( $format === 'first-last' || $format === 'first-middle-last' ) ) { return; } $this->validate_complicated_formats( $process, $form_id, $field_id, $field_submit, $required ); } /** * Format and sanitize field. * * @since 1.0.0 * * @param int $field_id Field ID. * @param mixed $field_submit Field value that was submitted. * @param array $form_data Form data and settings. */ public function format( $field_id, $field_submit, $form_data ) { // Define data. $name = isset( $form_data['fields'][ $field_id ]['label'] ) && ! wpforms_is_empty_string( $form_data['fields'][ $field_id ]['label'] ) ? $form_data['fields'][ $field_id ]['label'] : ''; $first = isset( $field_submit['first'] ) && ! wpforms_is_empty_string( $field_submit['first'] ) ? $field_submit['first'] : ''; $middle = isset( $field_submit['middle'] ) && ! wpforms_is_empty_string( $field_submit['middle'] ) ? $field_submit['middle'] : ''; $last = isset( $field_submit['last'] ) && ! wpforms_is_empty_string( $field_submit['last'] ) ? $field_submit['last'] : ''; if ( is_array( $field_submit ) ) { $value = implode( ' ', array_filter( [ $first, $middle, $last ] ) ); } else { $value = $field_submit; } // Set final field details. wpforms()->obj( 'process' )->fields[ $field_id ] = [ 'name' => sanitize_text_field( $name ), 'value' => sanitize_text_field( $value ), 'id' => wpforms_validate_field_id( $field_id ), 'type' => $this->type, 'first' => sanitize_text_field( $first ), 'middle' => sanitize_text_field( $middle ), 'last' => sanitize_text_field( $last ), ]; } /** * Determine if the field requires fieldset+legend instead of the regular field label. * * @since 1.8.1 * * @param bool $requires_fieldset True if requires fieldset. * @param array $field Field data. * * @return bool * * @noinspection PhpUnusedParameterInspection */ public function is_field_requires_fieldset( $requires_fieldset, $field ) { return isset( $field['format'] ) && $field['format'] !== 'simple'; } /** * Validate complicated formats. * * @since 1.8.2.3 * * @param WPForms_Process $process Process class instance. * @param int|string $form_id Form id. * @param int|string $field_id Field id. * @param array $field_submit Field submit. * @param string $required Required message text. */ private function validate_complicated_formats( $process, $form_id, $field_id, $field_submit, $required ) { // Prevent PHP Warning: Illegal string offset ‘first’ or 'last'. if ( isset( $process->errors[ $form_id ][ $field_id ] ) ) { $process->errors[ $form_id ][ $field_id ] = (array) $process->errors[ $form_id ][ $field_id ]; } if ( isset( $field_submit['first'] ) && wpforms_is_empty_string( $field_submit['first'] ) ) { $process->errors[ $form_id ][ $field_id ]['first'] = $required; } if ( isset( $field_submit['last'] ) && wpforms_is_empty_string( $field_submit['last'] ) ) { $process->errors[ $form_id ][ $field_id ]['last'] = $required; } } } new WPForms_Field_Name();