gform_akismet_fields

Description
Usage
Parameters
Examples
1. Override the comment_content
2. Provide the IP address
Placement
Source Code

Description

Use this filter to specify the fields that are sent to the Akismet anti-spam service.

Usage

add_filter( 'gform_akismet_fields', 'set_akismet_fields', 10, 4 );

You can also target a specific form by adding the form id after the hook name.

add_filter( 'gform_akismet_fields_6', 'set_akismet_fields', 10, 4 );

Parameters

$akismet_fields array
The data to be sent to Akismet, in the following format:

array(
'comment_type' =&gt; 'gravity_form',
'comment_author' =&gt; 'Author name',
'comment_author_email' =&gt; '[email protected]',
'comment_author_url' =&gt; 'http://www.someurl.com',
'comment_content' =&gt; 'Some text',
'contact_form_subject' =&gt; 'Contact Us',
'comment_author_ip' =&gt; '127.0.0.1',
'permalink' =&gt; 'http://www.someurl.com/contactus',
'user_ip' =&gt; '127.0.0.1',
'user_agent' =&gt; 'user agent string',
'referrer' =&gt; 'http://www.referrer.com',
'blog' =&gt; 'http://www.someurl.com',
);

Property	Default Source
comment_author	The first Name type field found on the form
comment_author_email	The first Email type field found on the form
comment_author_url	The first Website type field found on the form
comment_content	The first Paragraph type field found on the form
contact_form_subject	The form title

$form Form Object

The form which created the entry.

$entry Entry Object

The entry being processed.

$action string

The action triggering the Akismet request: submit, spam, or ham. Since version 2.4.18.5.

Examples

1. Override the comment_content

This example overrides the value in the “comment_content” Akismet field so that is is pulled from another field. (field ID: 1).

add_filter( 'gform_akismet_fields', 'set_akismet_fields', 10, 3 );
function set_akismet_fields( $akismet_fields, $form, $entry ) {
$akismet_fields['comment_content'] = rgar( $entry, '1' );

return $akismet_fields;
}

2. Provide the IP address

This example shows how you can pass the IP address to Akismet when it has been removed from the entry using the gform_ip_address filter.

add_filter( 'gform_akismet_fields', 'set_akismet_fields', 10, 3 );
function set_akismet_fields( $akismet_fields, $form, $entry ) {
remove_filter( 'gform_ip_address', '__return_empty_string' );
$ip = GFFormsModel::get_ip();
$akismet_fields['comment_author_IP'] = $ip;
$akismet_fields['user_ip'] = preg_replace( '/[^0-9., ]/', '', $ip );

return $akismet_fields;
}

Placement

This code should be placed in the functions.php file of your active theme.

Source Code

This filter is located in GFCommon::get_akismet_fields() in common.php.