GF_Field_Total
Source: includes/fields/class-gf-field-total.php:8
Details
- Kind:
class - Namespace:
(global) - Extends: GF_Field
Methods
| Method | Description |
|---|---|
get_form_editor_field_icon() | Returns the field's form editor icon. |
get_field_container() | Returns the HTML markup for the field's containing element. |
get_value_entry_detail() | Format the entry value for display on the entry detail page and for the {all_fields} merge tag. |
get_value_save_input() | Sanitize and format the value before it is saved to the Entry Object. |
get_value_merge_tag() | Gets merge tag values. |
validate() | Validates the field value. |
post_convert_field() | Actions to be performed after the field has been converted to an object. |
sanitize_settings() | Sanitizes the field properties. |
Method Reference
get_form_editor_field_icon()
public function get_form_editor_field_icon()
Returns the field's form editor icon.
This could be an icon url or a gform-icon class.
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-total.php:38
get_field_container()
public function get_field_container( $atts, $form )
Returns the HTML markup for the field's containing element.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$atts | array | Container attributes. | |
$form | array | The current Form object. |
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-total.php:52
get_value_entry_detail()
public function get_value_entry_detail( $value, $entry=[], $use_text=false, $format='html', $media='screen' )
Format the entry value for display on the entry detail page and for the {all_fields} merge tag.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The field value. | |
$entry | array | [] | The entry. |
$use_text | bool | false | false | When processing choice based fields should the choice text be returned instead of the value. |
$format | string | 'html' | The format requested for the location the merge is being used. Possible values: html, text or url. |
$media | string | 'screen' | The location where the value will be displayed. Possible values: screen or email. |
Returns
string
Since:
1.92.9.29(Changed the second parameter $currency (string) to $entry (array).)
Source: includes/fields/class-gf-field-total.php:101
get_value_save_input()
public function get_value_save_input( $value, $form, $input_name, $entry_id, $entry, $repeater_index='' )
Sanitize and format the value before it is saved to the Entry Object.
For total fields inside a repeater, the value is scoped to only the products within that repeater level (and nested repeaters), excluding shipping.
For top-level total fields, the value includes all products in the form (including those inside repeaters) plus shipping.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | The value to be saved. | |
$form | array | The Form object currently being processed. | |
$input_name | string | The input name used when accessing the $_POST. | |
$entry_id | int | The ID of the entry currently being processed. | |
$entry | array | The entry currently being processed. | |
$repeater_index | string | '' | The repeater index if the field is inside a repeater. |
Returns
array|string— The sanitized and formatted input value to be saved.
Since: 3.0.0
Source: includes/fields/class-gf-field-total.php:125
get_value_merge_tag()
public function get_value_merge_tag( $value, $input_id, $entry, $form, $modifier, $raw_value, $url_encode, $esc_html, $format, $nl2br )
Gets merge tag values.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | array | string | The value of the input. | |
$input_id | string | The input ID to use. | |
$entry | array | The Entry Object. | |
$form | array | The Form Object | |
$modifier | string | The modifier passed. | |
$raw_value | array | string | The raw value of the input. | |
$url_encode | bool | If the result should be URL encoded. | |
$esc_html | bool | If the HTML should be escaped. | |
$format | string | The format that the value should be. | |
$nl2br | bool | If the nl2br function should be used. |
Returns
string— The processed merge tag.
Since: Unknown
Source: includes/fields/class-gf-field-total.php:159
validate()
public function validate( $value, $form )
Validates the field value.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | The submitted value. | |
$form | array | The form currently being validated. |
Returns
void
Since: 2.8.2
Source: includes/fields/class-gf-field-total.php:177
post_convert_field()
public function post_convert_field()
Actions to be performed after the field has been converted to an object.
Returns
void
Since: 3.0 (Enabled total validation for existing fields.)
Source: includes/fields/class-gf-field-total.php:222
sanitize_settings()
public function sanitize_settings()
Sanitizes the field properties.
Returns
void
Since: 2.8.2
Source: includes/fields/class-gf-field-total.php:236