Inheritance diagram for GravityView_Field_Unsubscribe:

Public Member Functions
	__construct ()

	add_hooks ()
	Hooks called from constructor. More...

	field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
	Configure the field options. More...

	filter_gravityview_entry_default_field ( $entry_default_fields, $form, $context)
	Add the unsubsribe to the configuration fields. More...

	maybe_not_visible ( $visible, $field)
	Hide the field from the renderer. More...

	modify_entry_value_unsubscribe ( $output, $entry, $field_settings, $field)
	Modify the render content. More...

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...

Data Fields
	$contexts = array( 'single', 'multiple' )

	$group = 'pricing'

	$icon = 'dashicons-cart'

	$is_searchable = false

	$name = 'unsubscribe'

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

Private Member Functions
	maybe_unsubscribe ( $entry)
	Try to unsubscribe from the entry. More...

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

Definition at line 9 of file class-gravityview-field-unsubscribe.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 21 of file class-gravityview-field-unsubscribe.php.

References add_hooks(), and GV\description.

Member Function Documentation

◆ add_hooks()

add_hooks ( )

Hooks called from constructor.

Returns: void

Definition at line 35 of file class-gravityview-field-unsubscribe.php.

Referenced by __construct().

◆ field_options()

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

Configure the field options.

Called from the gravityview_entry_default_fields filter.

Remove the logged in, new window and show as link options. Add the allow unsubscribe for all admins option.

Parameters

array	$field_options	The options.
string	$template_id	The template ID.
int \| string \| float	$field_id	The field ID.
string	$context	The configuration context (edit, single, etc.)
string	$input_type	The input type.
int	$form_id	The form ID.

Returns: array The field options.

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

◆ filter_gravityview_entry_default_field()

filter_gravityview_entry_default_field	(	$entry_default_fields,
		$form,
		$context
	)

Add the unsubsribe to the configuration fields.

Only if a subscription feed is active for the current form.

Called from gravityview_entry_default_fields

Parameters

array	$entry_default_fields	An array of available for configuration
array \| int	$form	Form ID or array
string	$context	The configuration context (edit, single, etc.)