Add custom options for date fields. More...

Inheritance diagram for GravityView_Field_Date:

Public Member Functions
	__construct ()

	apply_format_date_modifiers ( $return, $raw_value='', $value='', $merge_tag='', $modifier='', $field=null)
	Allow Date fields to take advantage of the GV date modifiers. More...

	field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)

Public Member Functions inherited from GravityView_Field
	__construct ()
	GravityView_Field constructor. More...

	_filter_gform_custom_merge_tags ( $custom_merge_tags=array(), $form_id=0, $fields=array(), $element_id='')
	Add custom merge tags to merge tag options. More...

	_filter_gform_replace_merge_tags ( $text, $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
	Match the merge tag in replacement text for the field. More...

	_filter_sortable_fields ( $not_sortable)
	Use field settings to modify whether a field is sortable. More...

	add_entry_meta ( $entry_meta)
	Add the custom entry meta key to make it searchable and sortable. More...

	add_field_support ( $key, &$field_options)

	add_sortable_field ( $fields)
	Add the field to the Filter & Sort available fields. More...

	as_array ()
	Returns the field as an array to be used in field pickers. More...

	field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
	Tap in here to modify field options. More...

	replace_merge_tag ( $matches=array(), $text='', $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
	Run GravityView filters when using GFCommon::replace_variables() More...

	set_default_search_label ( $label='', $gf_field=null, $field=array())
	Allow setting a default search label for search fields based on the field type. More...

Static Public Member Functions
static	date_display ( $value='', $date_format='mdy', $field_id=0)
	Get the default date format for a field based on the field ID and the time format setting. More...

Data Fields
	$_gf_field_class_name = 'GF_Field_Date'

	$group = 'advanced'

	$icon = 'dashicons-calendar-alt'

	$is_searchable = true

	$name = 'date'

	$search_operators = array( 'less_than', 'greater_than', 'is', 'isnot' )

Data Fields inherited from GravityView_Field
	$_gf_field_class_name

	$contexts = array( 'single', 'multiple', 'edit', 'export' )

	$default_search_label

	$description

	$entry_meta_is_default_column = false

	$entry_meta_key = null

	$entry_meta_update_callback = null

	$group
	`standard`, `advanced`, `post`, `pricing`, `meta`, `gravityview`, or `add-ons` More...

	$icon = 'dashicons-admin-generic'

	$is_numeric
	boolean Is field content number-based? More...

	$is_searchable = true

	$is_sortable = true
	boolean Can the field be sorted in search? More...

	$label

	$name

	$search_operators

Additional Inherited Members
Protected Member Functions inherited from GravityView_Field
	custom_merge_tags ( $form=array(), $fields=array())
	Add custom Merge Tags to Merge Tag options, if custom Merge Tags exist. More...

	is_choice_value_enabled ()
	Check whether the `enableChoiceValue` flag is set for a GF field. More...

Protected Attributes inherited from GravityView_Field
	$_custom_merge_tag = false

	$_field_id = ''

	$_field_options = array()

Detailed Description

Add custom options for date fields.

Definition at line 11 of file class-gravityview-field-date.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 25 of file class-gravityview-field-date.php.

Member Function Documentation

◆ apply_format_date_modifiers()

apply_format_date_modifiers	(	$return,
		$raw_value = `''`,
		$value = `''`,
		$merge_tag = `''`,
		$modifier = `''`,
		$field = `null`
	)

Allow Date fields to take advantage of the GV date modifiers.

Since: 2.0 GravityView_Merge_Tags::format_date

Parameters

string	$return	The current merge tag value to be filtered.
string	$raw_value	The raw value submitted for this field. May be CSV or JSON-encoded.
string	$value	The original merge tag value, passed from Gravity Forms
string	$merge_tag	If the merge tag being executed is an individual field merge tag (i.e. {Name:3}), this variable will contain the field's ID. If not, this variable will contain the name of the merge tag (i.e. all_fields).
string	$modifier	The string containing any modifiers for this merge tag. For example, "maxwords:10" would be the modifiers for the following merge tag: `{Text:2:maxwords:10}`.
GF_Field	$field	The current field.

Returns: string If Date field, run it through GravityView_Merge_Tags::format_date; otherwise, return the original value

Definition at line 60 of file class-gravityview-field-date.php.

References $field, and GravityView_Merge_Tags\format_date().

◆ date_display()

static date_display	(	$value = `''`,
		$date_format = `'mdy'`,
		$field_id = `0`
	)

static

Get the default date format for a field based on the field ID and the time format setting.

Since: 1.16.4

Parameters

string	$date_format	The Gravity Forms date format for the field. Default: "mdy"
int	$field_id	The ID of the field. Used to figure out full date/day/month/year