Author 诗语

DescriptionUsageParametersExamplePlacementSinceSource Code

Description
Allows the entry to be modified before the confirmation is processed.
Usage
add_filter( 'gform_entry_pre_handle_confirmation', 'your_function_name', 10, 2 );

Parameters

$entry Entry Object
The current entry.

$form Form Object
The current form.

Example
add_filter( 'gform_entry_pre_handle_confirmation', 'change_entry', 10, 2 );
function change_entry( $entry, $form ){
if ( rgar( $entry, '1.3' ) == 'Rocketgenius' || rgar( $entry, '1.6' ) == 'Rocketgenius') {
$entry['2'] = '[email protected]';
}
return $entry;
}

Placement
This code should be placed in the functions.php file of your active theme.
Since
This filter was added in Gravity Forms version 2.3.4.2.
Source Code
This filter is located in GFFormDisplay::handle_submission() in form_display.php.

DescriptionUsageParametersExamplesPlacementSinceSource Code

Description
The 「gform_entry_list_columns」 filter in Gravity Forms allows the columns set to be displayed on the Entry List page to be changed. This allows different columns to be displayed for each form.
Usage
The following would apply to all forms:
add_filter( 'gform_entry_list_columns', 'your_function_name', 10, 2 );

To target a specific form, append the form id to the hook name. (format: gform_entry_list_columns_FORMID)
add_filter( 'gform_entry_list_columns_1', 'your_function_name', 10, 2 );

Parameters

$table_columns array
The columns to be displayed in the entry list table.

$form_id integer
The ID of the form to which the entries being displayed belong.

Examples
This example adds the Address City column on the form to be displayed in the entry list.
add_filter( 'gform_entry_list_columns', 'set_columns', 10, 2 );
function set_columns( $table_columns, $form_id ){
$table_columns['field_id-3.3'] = 'City';
return $table_columns;
}

Placement
This code should be placed in the functions.php file of your active theme.
Since
This filter was added in Gravity Forms version 2.0.7.6.
Source Code
This filter is located in GF_Entry_List_Table::get_columns() in entry_list.php.

DescriptionUsageParametersExamples1. Add a value to the entry meta.2. Delete an entry propertySource Code

Description
This hook fires after the lead has been created but before the post has been created, notifications have been sent, and the confirmation has been processed.
Usage
1add_action( 'gform_entry_created', 'your_function_name', 10, 2 );

Parameters

$entry Entry Object
The entry that was just created.

$form Form Object
The current form.

Examples
1. Add a value to the entry meta.
This example demonstrates how to use to the gform_entry_created hook to populate a value in the entry』s entry meta. It is possible to populate the entry meta anywhere you have the entry ID; however, let』s assume that we』re going to retrieve this entry meta and replace a gform_custom_merge_tags.
123456789101112131415add_action( 'gform_entry_created', 'generate_mergedoc' );function generate_mergedoc( $entry, $form ) {     $feed = self::get_mergedoc_feeds( $form['id'] );     if ( empty( $feed ) || ! rgar( $feed, 'active' ) || ! $entry )        return;     // get download link    $download_link = self::get_download_link( $uid );     // update entry meta    gform_update_meta( $entry['id'], 'gfmergedoc_download_link', $download_link ); }
2. Delete an entry property
The following example shows how you can delete an entry property such as the user agent from the database.
123add_action( 'gform_entry_created', function( $entry ) {    GFAPI::update_entry_property( $entry['id'], 'user_agent', '' );} );
Source Code
This filter is located in GFFormDisplay::handle_submission() in form_display.php.

DescriptionUsageParametersExamplesSource Code

Description
Use this action to inject markup to any non-first column of every entry in the entry list grid.
Usage
add_action( 'gform_entries_column', 'add_icon', 10, 5 );

Parameters

$form_id integer
ID of the current form.

$field_id integer
ID of the field that this column applies to.

$value string
Current value that will be displayed in this cell.

$entry Entry Object
Current entry object.

$query_string string
Current page query string with search and pagination state.

Examples
This example appends an icon to the column depending on the text being displayed in the cell.
Note: This example assumes that field with ID 5 is NOT placed in the first column on the entry grid. This hook does not fire for the first column in the grid. Look at gform_entries_first_column to add content to the first column.
add_action( 'gform_entries_column', 'add_icon', 10, 5 );
function add_icon( $form_id, $field_id, $value, $entry, $query_string ) {

//targeting form 190 only.
if ( $form_id != 190 )
return;

//targeting field 5 only
if ( $field_id != 5 )
return;

if ( $value == 'yes' ) {
echo " ";
} elseif ( $value == 'no' ) {
echo " ";
}
}

Source Code
This action hook is located in GFEntryList::leads_page() in entry_list.php.

DescriptionUsageParametersExamplesPlacementSource Code

Description
Use this action hook to add extra content to the sidebar. In Gravity Forms 1.9 and earlier, the content would be displayed before the Notifications box (if visible). In Gravity Forms 2.0+, the content is displayed after the meta boxes but before the print button.
Note: To add custom meta boxes to the sidebar, we recommend using the gform_entry_detail_meta_boxes filter.
Usage
add_action( 'gform_entry_detail_sidebar_middle', 'add_sidebar_text_middle', 10, 2 );

Parameters

$form Form Object
The form from which the entry value was submitted.

$entry Entry Object
The current entry.

Examples
This example adds a new box with a header and text.
add_action( 'gform_entry_detail_sidebar_middle', 'add_sidebar_text_middle', 10, 2 );
function add_sidebar_text_middle( $form, $entry ) {
echo "

";
}

Placement
This code should be placed in the functions.php file of your active theme.
Source Code
This filter is located in GFEntryDetail::lead_detail_page() in entry_detail.php.

DescriptionUsageParametersExamplesPlacementSource Code

Description
Use this action hook to add extra text/sections after the main content on the Entry detail page.
Usage
1add_action( 'gform_entry_detail_content_after', 'add_main_text_after', 10, 2 );

Parameters

$form Form Object
The form from which the entry value was submitted.

$entry Entry Object
The current entry.

Examples
This example adds a new section with a header and text.
1234add_action( 'gform_entry_detail_content_after', 'add_main_text_after', 10, 2 );function add_main_text_after( $form, $entry ) {    echo '

';}
Placement
This code should be placed in the functions.php file of your active theme.
Source Code
This filter is located in GFEntryDetail::lead_detail_page() in entry_detail.php.