Overview

Classes

  • GF_Personal_Data
  • GFAddOn
  • GFAddOnFeedsTable
  • GFAPI
  • GFFeedAddOn
  • GFPaymentAddOn
  • GFPaymentStatsTable
  • Overview
  • Class

Class GF_Personal_Data

Handles Integration with the WordPress personal data export and erase tools.

Since: 2.4 Class GF_Personal_Data
Located at class-personal-data.php
Methods summary
public static
# form_settings( mixed $form_id )

Renders the form settings.

Renders the form settings.

Parameters

$form_id

Since

2.4
public static
# process_form_settings( mixed $form_id )

Saves the form settings.

Saves the form settings.

Parameters

$form_id

Since

2.4
public static array|mixed
# get_form( integer $form_id )

Returns the form array for use in the form settings.

Returns the form array for use in the form settings.

Parameters

$form_id

Returns

array|mixed
array|mixed

Since

2.4
public static array
# get_columns( )

Returns an assoiative array of the database columns that may contain personal data.

Returns an assoiative array of the database columns that may contain personal data.

Returns

array
array

Since

2.4
public static array
# get_custom_items( array $form )

Returns an array with the custom personal data items configurations.

Returns an array with the custom personal data items configurations.

Parameters

$form

Returns

array
array

Since

2.4
public static array|null
# get_forms( )

Returns an associative array of all the form metas with the form ID as the key.

Returns an associative array of all the form metas with the form ID as the key.

Returns

array|null
array|null

Since

2.4
public static array
# get_entries( string $email_address, integer $page = 1, integer $limit = 50 )

Returns all the entries across all forms for the specified email address.

Returns all the entries across all forms for the specified email address.

Parameters

$email_address
$page
$limit

Returns

array
array

Since

2.4
public static array
# data_exporter( string $email_address, integer $page = 1 )

Exports personal data specified in the form settings.

Exports personal data specified in the form settings.

Parameters

$email_address
$page

Returns

array
array

Since

2.4
public static array
# get_draft_submissions_export_items( mixed $email_address )

Returns the export items for draft submissions.

Returns the export items for draft submissions.

Parameters

$email_address

Returns

array
array

Since

2.4
public static array
# data_eraser( string $email_address, integer $page = 1 )

Erases personal data specified in the form settings.

Erases personal data specified in the form settings.

Parameters

$email_address
$page

Returns

array
array

Since

2.4
public static
# erase_field_values( mixed $value, mixed $entry_id, mixed $input_id, mixed $item_index = '' )
public static array
# get_draft_submissions( mixed $email_address )

Returns the draft submissions (save and continue) for the given email address.

Returns the draft submissions (save and continue) for the given email address.

Parameters

$email_address

Returns

array
array

Since

2.4
public static boolean
# erase_draft_submissions_data( mixed $email_address )

Erases the data in the draft submissions.

Erases the data in the draft submissions.

Parameters

$email_address

Returns

boolean
bool

Since

2.4
public static
# cron_task( )

Deletes and trashes entries according to the retention policy in each of the form settings.

Deletes and trashes entries according to the retention policy in each of the form settings.

Since

2.4
public static
# log_debug( mixed $message )

Writes a message to the debug log

Writes a message to the debug log

Parameters

$message

Since

2.4
public static
# flush_current_forms( )

Flushes the forms

Flushes the forms

Since

2.4
Gravity Forms API API documentation generated by ApiGen 2.8.0