If this file is called directly, abort. More...

Public Member Functions
	__construct ()

	_trigger_notifications ( $entry_id=0)
	Passes approval notification and action hook to the send_notifications method. More...

	after_submission ( $entry, $form)
	Update the is_approved meta whenever the entry is submitted (and it contains a User Opt-in field) More...

	after_update_entry_update_approved_meta ( $form, $entry_id=NULL)
	Update the is_approved meta whenever the entry is updated. More...

	ajax_update_approved ()
	Approve/Disapprove entries using the × or ✓ icons in the GF Entries screen. More...

Static Public Member Functions
static	add_approval_notification_events ( $notification_events=array(), $form=array())
	Adds entry approval status change custom notification events. More...

static	autounapprove ( $form, $entry_id, $edit, $gv_data)
	Maybe unapprove entry on edit. More...

static	get_entry_status ( $entry, $value_or_label='label')
	Get the approval status for an entry. More...

static	get_popover_placement ()
	Where should the popover be placed? More...

static	get_popover_template ()
	Get HTML template for a popover used to display approval statuses. More...

static	update_approved ( $entry_id=0, $approved=2, $form_id=0, $approvedcolumn=0)
	update_approved function. More...

static	update_bulk ( $entries=array(), $approved=0, $form_id=0)
	Process a bulk of entries to update the approve field/property. More...

Data Fields
const	meta_key = 'is_approved'

Private Member Functions
	_send_notifications ( $entry_id='', $event='')
	Passes along notification triggers to GFAPI::send_notifications() More...

	add_hooks ()
	Add actions and filters related to entry approval. More...

Static Private Member Functions
static	add_approval_status_updated_note ( $entry_id, $approved=0)
	Add a note when an entry is approved. More...

static	get_approved_column_input_label ( $form, $approved_column)
	Get the value for the approved field checkbox. More...

static	update_approved_meta ( $entry_id, $status, $form_id=0)
	Update the `is_approved` entry meta value. More...

Detailed Description

If this file is called directly, abort.

Generate linked list output for a list of entries.

Since: 1.18

Definition at line 23 of file class-gravityview-entry-approval.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 30 of file class-gravityview-entry-approval.php.

References add_hooks().

Member Function Documentation

◆ _send_notifications()

_send_notifications	(	$entry_id = `''`,
		$event = `''`
	)

private

Passes along notification triggers to GFAPI::send_notifications()

Since: 2.1

Parameters

int	$entry_id	ID of entry being updated
string	$event	Hook that triggered the notification. This is used as the key in the GF notifications array.

Returns: void

Definition at line 92 of file class-gravityview-entry-approval.php.

References $entry, GV\$form, and gravityview().

Referenced by _trigger_notifications().

◆ _trigger_notifications()

_trigger_notifications ( $entry_id = 0 )

Passes approval notification and action hook to the send_notifications method.

See also: GravityView_Entry_Approval::send_notifications()

Definition at line 74 of file class-gravityview-entry-approval.php.

References _send_notifications().

◆ add_approval_notification_events()

static add_approval_notification_events	(	$notification_events = `array()`,
		$form = `array()`
	)

static

Adds entry approval status change custom notification events.

Since: 2.1

Parameters

array	$notification_events	The notification events.
array	$form	The current form.

Definition at line 119 of file class-gravityview-entry-approval.php.

◆ add_approval_status_updated_note()

static add_approval_status_updated_note	(	$entry_id,
		$approved = `0`
	)

staticprivate

Add a note when an entry is approved.

See also: GravityView_Entry_Approval::update_approved

Since: 1.18

Parameters

int	$entry_id	Gravity Forms entry ID
int	$approved	Approval status

Returns: false|int|WP_Error Note ID if successful; WP_Error if error when adding note, FALSE if note not updated because of gravityview/approve_entries/add-note filter or GravityView_Entry_Notes class not existing

Runs Filter:: gravityview/approve_entries/add-note Add a note when the entry has been approved or disapproved?

Since: 1.16.3

Parameters

bool $add_note True: Yep, add that note! False: Do not, under any circumstances, add that note!

Definition at line 449 of file class-gravityview-entry-approval.php.

References $entry, $form_id, GravityView_Entry_Notes\add_note(), GravityView_Entry_Approval_Status\APPROVED, GravityView_Entry_Approval_Status\DISAPPROVED, GravityView_Entry_Approval_Status\is_valid(), GravityView_Entry_Approval_Status\maybe_convert_status(), and GravityView_Entry_Approval_Status\UNAPPROVED.

◆ add_hooks()

add_hooks ( )

private

Add actions and filters related to entry approval.

Returns: void

Definition at line 39 of file class-gravityview-entry-approval.php.

Referenced by __construct().

◆ after_submission()

after_submission	(	$entry,
		$form
	)

Update the is_approved meta whenever the entry is submitted (and it contains a User Opt-in field)

Since: 1.16.6; 2.0.14 Set the default approval is_approved value upon submission

Parameters

$entry	array Gravity Forms entry object
$form	array Gravity Forms form object

Runs Filter:: gravityview/approve_entries/after_submission Modify whether to run the after_submission process

Since: 2.3

Parameters

bool $process_after_submission default: true

Runs Filter:: gravityview/approve_entries/after_submission/default_status Modify the default approval status for newly submitted entries

Since: 2.0.14

Parameters

int $default_status See GravityView_Entry_Approval_Status() for valid statuses.

Definition at line 250 of file class-gravityview-entry-approval.php.

References $entry, GV\$form, after_update_entry_update_approved_meta(), gravityview(), GravityView_Entry_Approval_Status\is_valid(), and GravityView_Entry_Approval_Status\UNAPPROVED.

◆ after_update_entry_update_approved_meta()

after_update_entry_update_approved_meta	(	$form,
		$entry_id = `NULL`
	)

Update the is_approved meta whenever the entry is updated.

Since: 1.7.6.1 Was previously named update_approved_meta

Parameters

array	$form	Gravity Forms form array
int	$entry_id	ID of the Gravity Forms entry

Returns: void

If the form doesn't contain the approve field, don't assume anything.

Runs Filter:: gravityview/approve_entries/update_unapproved_meta Filter the approval status on entry update.

Parameters

string	$value	The approval status.
array	$form	The form.
array	$entry	The entry.

Definition at line 294 of file class-gravityview-entry-approval.php.

References $entry, GV\$form, $value, GravityView_Entry_Approval_Status\APPROVED, and GravityView_Entry_Approval_Status\DISAPPROVED.

Referenced by after_submission().

◆ ajax_update_approved()

ajax_update_approved ( )

Approve/Disapprove entries using the × or ✓ icons in the GF Entries screen.

wp_send_json_error() wp_send_json_success()

Expects a $_POST request with the following $_POST keys and values:

array $_POST { int $form_id ID of the form connected to the entry being updated string|int $entry_slug The ID or slug of the entry being updated string $approved The value of the entry approval status {

See also: GravityView_Entry_Approval_Status::is_valid() } }

Returns: void Prints result using wp_send_json_success() and wp_send_json_error()

Definition at line 171 of file class-gravityview-entry-approval.php.

References $current_status, $form_id, Utils\_POST(), GVCommon\get_entry_id(), gravityview(), GVCommon\has_cap(), and GravityView_Entry_Approval_Status\is_valid().

◆ autounapprove()

static autounapprove	(	$form,
		$entry_id,
		$edit,
		$gv_data
	)

static

Maybe unapprove entry on edit.

Called from gravityview/edit_entry/after_update

Parameters

array	$form	Gravity Forms form array
string	$entry_id	Numeric ID of the entry that was updated
GravityView_Edit_Entry_Render	$edit	This object
GravityView_View_Data	$gv_data	The View data

Returns: void

Runs Filter:: gravityview/approve_entries/autounapprove/status

Since: 2.2.2

Parameters

int \| false	$approval_status	Approval status integer, or false if you want to not update status. Use GravityView_Entry_Approval_Status constants. Default: 3 (GravityView_Entry_Approval_Status::UNAPPROVED)
array	$form	Gravity Forms form array
string	$entry_id	Numeric ID of the entry that was updated
\GV\View	$view	Current View where the entry was edited

Definition at line 674 of file class-gravityview-entry-approval.php.

References GV\$form, View\by_id(), GVCommon\has_cap(), GravityView_Entry_Approval_Status\is_valid(), and GravityView_Entry_Approval_Status\UNAPPROVED.

◆ get_approved_column_input_label()

static get_approved_column_input_label	(	$form,
		$approved_column
	)

staticprivate

Get the value for the approved field checkbox.

When approving a field via the entry meta, use the correct value for the new approved column input

Since: 1.19

Parameters

array \| int	$form	Form ID or form array
string	$approved_column	Approved column field ID

Returns: string|null

Definition at line 547 of file class-gravityview-entry-approval.php.

References $field, GV\$form, and gravityview_get_field().

◆ get_entry_status()

static get_entry_status	(	$entry,
		$value_or_label = `'label'`
	)

static

Get the approval status for an entry.

Since: 1.18 GVCommon::get_entry_id() Accepts entry slug or entry ID

Parameters

array \| int \| string	$entry	Entry array, entry slug, or entry ID
string	$value_or_label	"value" or "label" (default: "label")

Returns: bool|string Return the label or value of entry approval

Definition at line 140 of file class-gravityview-entry-approval.php.

References $entry, GVCommon\get_entry_id(), GravityView_Entry_Approval_Status\get_label(), and GravityView_Entry_Approval_Status\maybe_convert_status().

Referenced by GravityView_Admin_ApproveEntries\add_entry_approved_hidden_input(), and GravityView_Field_Is_Approved\custom_merge_tags().

◆ get_popover_placement()

static get_popover_placement ( )

static

Where should the popover be placed?

Since: 2.3.1

Returns: string Where to place the popover; 'right' (default ltr), 'left' (default rtl), 'top', or 'bottom'

Runs Filter:: gravityview/approve_entries/popover_placement Where should the popover be placed?

Since: 2.3.1

Parameters

string $placement Where to place the popover; 'right' (default ltr), 'left' (default rtl), 'top', or 'bottom'

Definition at line 717 of file class-gravityview-entry-approval.php.

Referenced by GravityView_Admin_ApproveEntries\add_scripts_and_styles(), and GravityView_Field_Entry_Approval\enqueue_and_localize_script().

◆ get_popover_template()

static get_popover_template ( )

static

Get HTML template for a popover used to display approval statuses.

Since: 2.3.1

Definition at line 740 of file class-gravityview-entry-approval.php.

References GravityView_Entry_Approval_Status\get_all().

Referenced by GravityView_Admin_ApproveEntries\add_scripts_and_styles(), and GravityView_Field_Entry_Approval\enqueue_and_localize_script().

◆ update_approved()

static update_approved	(	$entry_id = `0`,
		$approved = `2`,
		$form_id = `0`,
		$approvedcolumn = `0`
	)

static

update_approved function.

Since: 1.18 Moved to GravityView_Entry_Approval class

Parameters

int	$entry_id	(default: 0)
int	$approved	(default: 2)
int	$form_id	(default: 0)
int	$approvedcolumn	(default: 0)

Returns: boolean True: It worked; False: it failed

Destroy the cache for this form

See also: class-cache.php

Since: 1.5.1

Definition at line 384 of file class-gravityview-entry-approval.php.

References $entry, $form_id, gravityview(), GravityView_Entry_Approval_Status\is_valid(), and GravityView_Entry_Approval_Status\maybe_convert_status().

Referenced by GravityView_Admin_ApproveEntries\update_approved(), and GravityView_Entry_Approval_Merge_Tags\update_approved().

◆ update_approved_meta()

static update_approved_meta	(	$entry_id,
		$status,
		$form_id = `0`
	)

staticprivate

Update the is_approved entry meta value.

Since: 1.7.6.1 after_update_entry_update_approved_meta was previously to be named update_approved_meta; 1.17.1 Added $form_id parameter

Parameters

int	$entry_id	ID of the Gravity Forms entry
string	$status	String whether entry is approved or not. `0` for not approved, `Approved` for approved.
int	$form_id	ID of the form of the entry being updated. Improves query performance.

Returns: void

Runs Actions:: gravityview/approve_entries/updated Triggered when an entry approval is updated

Since: 1.7.6.1

Parameters

int	$entry_id	ID of the Gravity Forms entry
string \| int	$status	String whether entry is approved or not. See GravityView_Entry_Approval_Status for valid statuses.

Runs Actions:: gravityview/approve_entries/{$action} Triggered when an entry approval is set. {$action} can be 'approved', 'unapproved', or 'disapproved' Note: If you want this to work with Bulk Actions, run in a plugin rather than a theme; the bulk updates hook runs before themes are loaded.

Since: 1.7.6.1; 1.18 Added "unapproved"

Parameters

int $entry_id ID of the Gravity Forms entry

Definition at line 577 of file class-gravityview-entry-approval.php.

References $field, GV\$form, $form_id, GVCommon\get_form(), GravityView_Entry_Approval_Status\get_key(), gravityview(), GravityView_Entry_Approval_Status\is_valid(), and GravityView_Entry_Approval_Status\maybe_convert_status().

◆ update_bulk()

static update_bulk	(	$entries = `array()`,
		$approved = `0`,
		$form_id = `0`
	)

static

Process a bulk of entries to update the approve field/property.

Since: 1.18 Moved to GravityView_Entry_Approval; 1.18 Made public

Parameters

array \| boolean	$entries	If array, array of entry IDs that are to be updated. If true: update all entries.
int	$approved	Approved status. If `0`: unapproved, if not empty, `Approved`
int	$form_id	The Gravity Forms Form ID

Returns: boolean|null True: successfully updated all entries. False: there was an error updating at least one entry. NULL: an error occurred (see log)

Definition at line 338 of file class-gravityview-entry-approval.php.

References $entries, $form_id, gravityview(), GVCommon\has_cap(), and GravityView_Entry_Approval_Status\is_valid().

Referenced by GravityView_Bulk_Actions\process_bulk_action().