checked_indicator_url = apply_filters( 'gform_consent_checked_indicator', GFCommon::get_base_url() . '/images/tick.png' );
/**
* Filters the consent checked indicator (image) element.
*
* @since 2.4
*
* @param string $tag Image tag.
*/
$this->checked_indicator_markup = apply_filters( 'gform_consent_checked_indicator_markup', '' );
}
/**
* Returns the field title.
*
* @since 2.4
*
* @return string
*/
public function get_form_editor_field_title() {
return esc_attr__( 'Consent', 'gravityforms' );
}
/**
* Returns the field's form editor description.
*
* @since 2.5
*
* @return string
*/
public function get_form_editor_field_description() {
return esc_attr__( 'Offers a “yes/no” consent checkbox and a detailed description of what is being consented to.', 'gravityforms' );
}
/**
* Returns the field's form editor icon.
*
* This could be an icon url or a gform-icon class.
*
* @since 2.5
*
* @return string
*/
public function get_form_editor_field_icon() {
return 'gform-icon--consent';
}
/**
* Returns the field button properties for the form editor. The array contains two elements:
* 'group' => 'standard_fields' // or 'advanced_fields', 'post_fields', 'pricing_fields'
* 'text' => 'Button text'
*
* @since 2.4
*
* @return array
*/
public function get_form_editor_button() {
return array(
'group' => 'advanced_fields',
'text' => $this->get_form_editor_field_title(),
);
}
/**
* Returns the class names of the settings which should be available on the field in the form editor.
*
* @since 2.4
*
* @return array
*/
public function get_form_editor_field_settings() {
return array(
'conditional_logic_field_setting',
'error_message_setting',
'label_setting',
'label_placement_setting',
'admin_label_setting',
'checkbox_label_setting',
'rules_setting',
'visibility_setting',
'description_setting',
'css_class_setting',
);
}
/**
* Indicate if this field type can be used when configuring conditional logic rules.
*
* @since 2.4
*
* @return bool
*/
public function is_conditional_logic_supported() {
return true;
}
/**
* Returns the HTML tag for the field container.
*
* @since 2.5
*
* @param array $form The current Form object.
*
* @return string
*/
public function get_field_container_tag( $form ) {
if ( GFCommon::is_legacy_markup_enabled( $form ) ) {
return parent::get_field_container_tag( $form );
}
return 'fieldset';
}
/**
* Returns the field inner markup.
*
* @since 2.4
*
* @param array $form The Form Object currently being processed.
* @param array $value The field value. From default/dynamic population, $_POST, or a resumed incomplete submission.
* @param null|array $entry Null or the Entry Object currently being edited.
*
* @return string
*/
public function get_field_input( $form, $value = array(), $entry = null ) {
$is_entry_detail = $this->is_entry_detail();
$is_form_editor = $this->is_form_editor();
$is_admin = $is_form_editor || $is_entry_detail;
$html_input_type = 'checkbox';
$id = (int) $this->id;
$tabindex = $this->get_tabindex();
$disabled_text = $is_form_editor ? 'disabled="disabled"' : '';
$required_attribute = $this->isRequired ? 'aria-required="true"' : '';
$invalid_attribute = $this->failed_validation ? 'aria-invalid="true"' : 'aria-invalid="false"';
$target_input_id = parent::get_first_input_id( $form );
$for_attribute = empty( $target_input_id ) ? '' : "for='{$target_input_id}'";
$label_class_attribute = 'class="gform-field-label gform-field-label--type-inline gfield_consent_label"';
$required_div = ( $this->labelPlacement === 'hidden_label' && $this->isRequired && ! GFCommon::is_entry_detail_edit() ) ? $this->get_required_indicator() : '';
if ( $is_admin && ! GFCommon::is_entry_detail_edit() ) {
$checkbox_label = ! is_array( $value ) || empty( $value[ $id . '.2' ] ) ? $this->checkboxLabel : $value[ $id . '.2' ];
$revision_id = ! is_array( $value ) || empty( $value[ $id . '.3' ] ) ? GFFormsModel::get_latest_form_revisions_id( $form['id'] ) : $value[ $id . '.3' ];
$value = ! is_array( $value ) || empty( $value[ $id . '.1' ] ) ? '0' : esc_attr( $value[ $id . '.1' ] );
} else {
$checkbox_label = trim( $this->checkboxLabel );
$revision_id = GFFormsModel::get_latest_form_revisions_id( $form['id'] );
// We compare if the description text from different revisions has been changed.
$current_description = $this->get_field_description_from_revision( $revision_id );
$submitted_revision_id = ( is_array( $value ) && isset( $value[ $id . '.3' ] ) ) ? $value[ $id . '.3' ] : $revision_id;
$submitted_description = $this->get_field_description_from_revision( $submitted_revision_id );
$submitted_label = ( is_array( $value ) && isset( $value[ $id . '.2' ] ) ) ? $value[ $id . '.2' ] : '';
$value = ! is_array( $value ) || empty( $value[ $id . '.1' ] ) || ( $checkbox_label !== $submitted_label ) || ( $current_description !== $submitted_description ) ? '0' : esc_attr( $value[ $id . '.1' ] );
}
$checked = $is_form_editor ? '' : checked( '1', $value, false );
$description = $is_entry_detail ? $this->get_field_description_from_revision( $revision_id ) : $this->description;
$extra_describedby_ids = empty( $description ) ? array() : array( "gfield_consent_description_{$form['id']}_{$this->id}" );
$aria_describedby = $this->get_aria_describedby( $extra_describedby_ids );
$input = " ";
$input .= "";
$input .= "";
$is_inside_repeater = $this->get_context_property( 'itemIndex' ) !== null;
if ( $is_entry_detail && ( ! $this->is_entry_detail_edit() || ! $is_inside_repeater ) ) {
$input .= $this->get_description( $this->get_field_description_from_revision( $revision_id ), '' );
}
return sprintf( "
%s
", $input );
}
/**
* Returns the input ID to be assigned to the field label for attribute.
*
* @since 2.4
*
* @param array $form The Form Object currently being processed.
*
* @return string
*/
public function get_first_input_id( $form ) {
return '';
}
/**
* Returns the markup for the field description.
*
* @since 2.4
*
* @param string $description The field description.
* @param string $css_class The css class to be assigned to the description container.
*
* @return string
*/
public function get_description( $description, $css_class ) {
if ( ! empty( $description ) ) {
$id = "gfield_consent_description_{$this->formId}_{$this->id}";
$css_class .= ' gfield_consent_description';
return "
" . nl2br( $description ) . '
';
}
return parent::get_description( $description, $css_class );
}
/**
* If a field has a description, the aria-describedby attribute for the input field is returned.
* This method is specific to the consent field since the consent description has a different ID pattern.
*
* @since 2.6.8
*
* @param array|string $extra_ids Any extra ids that should be added to the describedby attribute.
*
* @return string
*/
public function get_aria_describedby( $extra_ids = array() ) {
$describedby_ids = is_array( $extra_ids ) ? $extra_ids : explode( ' ', $extra_ids );
if ( $this->failed_validation ) {
$describedby_ids[] = "validation_message_{$this->formId}_{$this->id}";
}
if ( empty( $describedby_ids ) ) {
return '';
}
return 'aria-describedby="' . implode( ' ', $describedby_ids ) . '"';
}
/**
* Used when determining if the field has failed required validation.
*
* The consent field has three inputs; only the checkbox is required.
*
* @since 2.7.5
*
* @param int $form_id The ID of the form currently being processed.
*
* @return bool
*/
public function is_value_submission_empty( $form_id ) {
return rgblank( rgpost( 'input_' . $this->id . '_1' ) );
}
/**
* Sanitize and format the value before it is saved to the Entry Object.
*
* @since 3.0.0
*
* @param string $value The value to be saved.
* @param array $form The Form object currently being processed.
* @param string $input_name The input name used when accessing the $_POST.
* @param int $entry_id The ID of the entry currently being processed.
* @param array $entry The entry currently being processed.
* @param string $repeater_index The repeater item index if the field is inside a repeater (e.g., '_0', '_1', '_0_1').
*
* @return array|string The sanitized and formatted input value to be saved.
*/
public function get_value_save_input( $value, $form, $input_name, $entry_id, $entry, $repeater_index = '' ) {
$parts = explode( '_', $input_name );
$field_id = isset( $parts[1] ) ? $parts[1] : '';
$input_id = isset( $parts[2] ) ? $parts[2] : '';
if ( $input_id == '1' ) {
$value = ( ! empty( $value ) ) ? '1' : '';
} else {
$checkbox_key = $field_id . '.1' . $repeater_index;
$consent_value = isset( $entry[ $checkbox_key ] ) ? $entry[ $checkbox_key ] : '';
$value = ( $consent_value === '1' ) ? $value : '';
}
return $value;
}
/**
* Set the values of consent field inputs in merge tags.
*
* @since 2.4
*
* @param string|array $value The field value. Depending on the location the merge tag is being used the following functions may have already been applied to the value: esc_html, nl2br, and urlencode.
* @param string $input_id The field or input ID from the merge tag currently being processed.
* @param array $entry The Entry Object currently being processed.
* @param array $form The Form Object currently being processed.
* @param string $modifier The merge tag modifier. e.g. value.
* @param string|array $raw_value The raw field value from before any formatting was applied to $value.
* @param bool $url_encode Indicates if the urlencode function may have been applied to the $value.
* @param bool $esc_html Indicates if the esc_html function may have been applied to the $value.
* @param string $format The format requested for the location the merge is being used. Possible values: html, text or url.
* @param bool $nl2br Indicates if the nl2br function may have been applied to the $value.
*
* @return string
*/
public function get_value_merge_tag( $value, $input_id, $entry, $form, $modifier, $raw_value, $url_encode, $esc_html, $format, $nl2br ) {
list( $field_id, $input_id ) = explode( '.', $input_id );
switch ( $input_id ) {
case '1':
$value = ! rgblank( $value ) ? $this->checked_indicator_markup : '';
break;
case '3':
$value = ! rgblank( $value ) ? $this->get_field_description_from_revision( $value ) : '';
if ( $value !== '' && $nl2br ) {
$value = nl2br( $value );
}
break;
}
return $value;
}
/**
* Format the entry value for display on the entries list page.
*
* @since 2.4
*
* @param string|array $value The field value.
* @param array $entry The Entry Object currently being processed.
* @param string $field_id The field or input ID currently being processed.
* @param array $columns The properties for the columns being displayed on the entry list page.
* @param array $form The Form Object currently being processed.
*
* @return string
*/
public function get_value_entry_list( $value, $entry, $field_id, $columns, $form ) {
list( $field_id, $input_id ) = explode( '.', $field_id );
switch ( $input_id ) {
case '1':
$value = ! rgblank( $value ) ? $this->checked_indicator_markup : '';
$value .= ! rgblank( $value ) ? ' ' . wp_kses( trim( $entry[ $this->id . '.2' ] ), wp_kses_allowed_html( 'data' ) ) : '';
break;
}
return $value;
}
/**
* Format the entry value for display on the entry detail page and for the {all_fields} merge tag.
*
* @since 2.4
* @since 2.9.29 Changed the second parameter $currency (string) to $entry (array).
*
* @param string|array $value The field value.
* @param array $entry The entry.
* @param bool|false $use_text When processing choice based fields should the choice text be returned instead of the value.
* @param string $format The format requested for the location the merge is being used. Possible values: html, text or url.
* @param string $media The location where the value will be displayed. Possible values: screen or email.
*
* @return string
*/
public function get_value_entry_detail( $value, $entry = array(), $use_text = false, $format = 'html', $media = 'screen' ) {
$return = '';
if ( is_array( $value ) && ! empty( $value ) ) {
$consent = isset( $value[ $this->id . '.1' ] ) ? trim( $value[ $this->id . '.1' ] ) : '';
$text = isset( $value[ $this->id . '.2' ] ) ? trim( $value[ $this->id . '.2' ] ) : '';
$revision_id = isset( $value[ $this->id . '.3' ] ) ? absint( trim( $value[ $this->id . '.3' ] ) ) : 0;
if ( ! rgblank( $consent ) ) {
$return = $this->checked_indicator_markup;
$return .= ' ' . wp_kses( $text, wp_kses_allowed_html( 'data' ) );
if ( $media === 'screen' ) {
// checking revisions.
$description = $this->get_field_description_from_revision( $revision_id );
if ( ! empty( $description ) ) {
$return .= '
' . nl2br( $description ) . '
';
}
}
}
}
return $return;
}
/**
* Format the entry value before it is used in entry exports and by framework add-ons using GFAddOn::get_field_value().
*
* For CSV export return a string or array.
*
* @since 2.4
*
* @param array $entry The entry currently being processed.
* @param string $input_id The field or input ID.
* @param bool|false $use_text When processing choice based fields should the choice text be returned instead of the value.
* @param bool|false $is_csv Is the value going to be used in the .csv entries export.
*
* @return string|array
*/
public function get_value_export( $entry, $input_id = '', $use_text = false, $is_csv = false ) {
if ( empty( $input_id ) ) {
return '';
}
$value = parent::get_value_export( $entry, $input_id, $use_text, $is_csv );
list( $field_id, $input_id ) = rgexplode( '.', $input_id, 2 );
switch ( $input_id ) {
case '1':
$value = ! rgblank( $value ) ? esc_html__( 'Checked', 'gravityforms' ) : esc_html__( 'Not Checked', 'gravityforms' );
break;
case '3':
$value = ! rgblank( $value ) ? $this->get_field_description_from_revision( $value ) : '';
break;
}
return $value;
}
/**
* Forces settings into expected values while saving the form object.
*
* No escaping should be done at this stage to prevent double escaping on output.
*
* @since 2.4
*/
public function sanitize_settings() {
parent::sanitize_settings();
$this->checkboxLabel = $this->maybe_wp_kses( $this->checkboxLabel );
}
/**
* Returns the filter settings for the current field.
*
* If overriding to add custom settings call the parent method first to get the default settings.
*
* @since 2.4
*
* @return array
*/
public function get_filter_settings() {
$filter_settings = array(
'key' => $this->id . '.1',
'text' => GFFormsModel::get_label( $this ),
'preventMultiple' => false,
'operators' => $this->get_filter_operators(),
);
$values = $this->get_filter_values();
if ( ! empty( $values ) ) {
$filter_settings['values'] = $values;
}
return $filter_settings;
}
/**
* Returns the filter operators for the current field.
*
* @since 2.4
*
* @return array
*/
public function get_filter_operators() {
$operators = array( 'is', 'isnot' );
return $operators;
}
/**
* Returns the filters values setting for the current field.
*
* @since 2.4
*
* @return array
*/
public function get_filter_values() {
$choices = array(
array(
'value' => '1',
'text' => esc_html__( 'Checked', 'gravityforms' ),
),
);
return $choices;
}
/**
* Get consent description from the form revision.
*
* @since 2.4
*
* @param int $revision_id Revision ID.
*
* @return string
*/
public function get_field_description_from_revision( $revision_id ) {
global $wpdb;
$revisions_table_name = GFFormsModel::get_form_revisions_table_name();
$display_meta = $wpdb->get_var( $wpdb->prepare( "SELECT display_meta FROM $revisions_table_name WHERE form_id=%d AND id=%d", $this->formId, $revision_id ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$value = '';
$is_entry_detail = $this->is_entry_detail();
if ( ! empty( $display_meta ) ) {
$display_meta_array = json_decode( $display_meta, true );
$field_data = $this->find_nested_field_by_id( $display_meta_array['fields'], $this->id );
if ( $field_data ) {
$value = $field_data['description'];
}
} else {
$value = ( ! empty( $this->description ) ) ? $this->description : '';
}
if ( $is_entry_detail ) {
$value = $this->maybe_wp_kses( $value );
}
return $value;
}
/**
* Recursively searches for a field by ID within a fields array, including nested fields inside repeaters.
*
* @since 3.0.0
*
* @param array $fields Array of field data from form metadata.
* @param int $field_id The field ID to search for.
*
* @return array|null The field data array if found, null otherwise.
*/
private function find_nested_field_by_id( $fields, $field_id ) {
foreach ( $fields as $field ) {
if ( $field['id'] === $field_id ) {
return $field;
}
if ( isset( $field['fields'] ) && is_array( $field['fields'] ) ) {
$result = $this->find_nested_field_by_id( $field['fields'], $field_id );
if ( $result ) {
return $result;
}
}
}
return null;
}
/**
* Indicates if state validation should be skipped if the submitted value is blank.
*
* Input value will be blank when the input is not checked.
*
* @since 3.0
*
* @return bool
*/
public function skip_state_validation_if_blank( $key ) {
return true;
}
/**
* Prepares the value that will be hashed on form display as part of the state.
*
* @since 3.0
*
* @param string|array $value The default value.
*
* @return null|array
*/
public function get_values_for_state_hash( $value ) {
$id = $this->id;
return array(
"{$id}.1" => 1,
"{$id}.2" => $this->checkboxLabel,
"{$id}.3" => GFFormsModel::get_latest_form_revisions_id( $this->formId ),
);
}
}
GF_Fields::register( new GF_Field_Consent() );