Author 詩語

gform_entry_detail_sidebar_after

DescriptionUsageParametersExamplesPlacementSource Code

Description
Use this action hook to add extra text/boxes after the last box in the Entry detail sidebar.
Usage
1add_action( 'gform_entry_detail_sidebar_after', 'add_sidebar_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 box with a header and text.
1234add_action( 'gform_entry_detail_sidebar_after', 'add_sidebar_text_after', 10, 2 );function add_sidebar_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.

gform_entries_view

DescriptionUsageParametersExamplesSource Code

Description
Triggers when viewing an entry with a non-standard entry type.
Usage
add_action( 'gform_entries_view', 'my_function', 10, 3 );

Parameters

$view string
The current entry type.

$form_id string
The ID of the form that the entry belongs to.

$entry_id string
The ID of the current entry.

Examples
if ( rgget('view') == 'my_view' ) {
add_action( 'gform_entries_view', 'my_function', 10, 3 );
function my_function($view, $form_id, $entry_id) {
//Display the view for this entry type
}
}

Source Code
This action hook is located in gravityforms.php.

gform_entries_column_filter

DescriptionUsageParametersExamplesPlacementSource Code

Description
Use this filter to inject markup and replace the value of any non-first column in the entry list grid.
Usage
add_filter( 'gform_entries_column_filter', 'change_column_data', 10, 5 );

Parameters

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

$form_id integer
ID of the current form.

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

$entry Entry Object
Current entry object.

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

Examples
This example replaces the value when the field id is 2 and the form id is 1. Note: This example assumes that field with ID 2 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_filter( 'gform_entries_column_filter', 'change_column_data', 10, 5 );
function change_column_data( $value, $form_id, $field_id, $entry, $query_string ) {
//only change the data when form id is 1 and field id is 2
if ( $form_id != 1 && $field_id != 2 ) {
return $value;
}
return "newdata";
}

This example displays text next to the existing value.
add_filter( 'gform_entries_column_filter', 'change_column_data', 10, 5 );
function change_column_data( $value, $form_id, $field_id, $entry, $query_string ) {
//only change the data when form id is 1 and field id is 2
if ( $form_id != 1 && $field_id != 2 ) {
return $value;
}
return $value . " - newdata";
}

Placement
This code should be placed in the functions.php file of your active theme.
Source Code
This hook is located in GFEntryList::leads_page() in entry_list.php.

gform_entry_detail_sidebar_before

DescriptionUsageParametersExamplesPlacementSource Code

Description
Use this action hook to add extra text/boxes before the first box in the Entry detail sidebar.
Usage
add_action( 'gform_entry_detail_sidebar_before', 'add_sidebar_text_before', 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_before', 'add_sidebar_text_before', 10, 2 );
function add_sidebar_text_before( $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.

gform_dropbox_should_upload_file

DescriptionUsageParametersExamples1. Log the paramsPlacementSinceSource Code

Description

The gform_dropbox_should_upload_file filter can be used to determine if a file for a fileupload or dropbox type field is uploaded to Dropbox.

Usage

The following would apply to all forms:

add_filter( 'gform_dropbox_should_upload_file', 'your_function_name', 10, 7 );

To target a specific form append the form id to the hook name. (format: gform_dropbox_should_upload_file_FORMID)

add_filter( 'gform_dropbox_should_upload_file_2', 'your_function_name', 10, 7 );

To target a specific field append both the form id and the field id to the hook name. (format: gform_dropbox_should_upload_file_FORMID_FIELDID)

add_filter( 'gform_dropbox_should_upload_file_2_3', 'your_function_name', 10, 7 );

Parameters

$should_upload_file booleanIndicates if the file should be uploaded to Dropbox.$url stringThe URL of the file from the entry.$existing false|arrayFalse or an array of files previously uploaded to Dropbox for the current field and entry.$field Field ObjectThe current fileupload or dropbox field object$form Form ObjectThe form containing the current field.$entry Entry ObjectThe entry currently being processed.$feed Feed ObjectThe feed currently being processed.

Examples

1. Log the params

This is a basic usage example showing how you can log the parameters available to this filter.

add_filter( 'gform_dropbox_should_upload_file', 'log_gform_dropbox_should_upload_file', 10, 7 );
add_filter( 'gform_dropbox_should_upload_file_18', 'log_gform_dropbox_should_upload_file', 10, 7 );
add_filter( 'gform_dropbox_should_upload_file_18_6', 'log_gform_dropbox_should_upload_file', 10, 7 );
function log_gform_dropbox_should_upload_file( $should_upload_file, $url, $existing, $field, $form, $entry, $feed ) {
gf_dropbox()->log_debug( current_filter() . ': ' . print_r( func_get_args(), true ) );

return $should_upload_file;
}

Placement

This code should be placed in the functions.php file of your active theme, a custom functions plugin, or your custom add-on.

Since

This filter was added in version 3.0.1.

Source Code

public function should_upload_file( $url, $existing, $field, $form, $entry, $feed ) {
if ( ! empty( $existing ) ) {
$should_upload_file = ! in_array( $url, $existing );
} else {
// The preview link type uses www.dropbox.com.
$should_upload_file = $field instanceof GF_Field_Dropbox && $field->get_link_type( $form ) === 'preview' || stripos( $url, 'www.dropbox.com' ) === false;
}

$filter_args = array( 'gform_dropbox_should_upload_file', $form['id'], $field->id );

if ( function_exists( 'gf_has_filters' ) && gf_has_filters( $filter_args ) ) {
$this->log_debug( __METHOD__ . '(): Executing functions hooked to gform_dropbox_should_upload_file.' );
}

/**
* Provides a way to prevent the uploading of a file to Dropbox.
*
* @since 3.1
*
* @param bool $should_upload_file Indicates if the file should be uploaded to Dropbox.
* @param string $url The URL of the file from the entry.
* @param false|array $existing False or an array of files previously uploaded to Dropbox for the current field and entry.
* @param GF_Field $field The current fileupload or dropbox field object.
* @param array $form The current form object.
* @param array $entry The current entry object.
* @param array $feed The current feed object.
*/
return (bool) gf_apply_filters( $filter_args, $should_upload_file, $url, $existing, $field, $form, $entry, $feed );
}

This filter is located in GFDropbox::should_upload_file() in class-gf-dropbox.php.