WordPress filter hook

gform_pre_send_email

Fired by 4 WordPress plugins, running on 1,160+ sites between them.

“Modify the email before a notification has been sent. You may also use this to prevent an email from being sent.”

How to use gform_pre_send_email

It's a filter: your callback receives the value and 3 more arguments, and must return the (changed) value. Add this to your theme's functions.php or a small custom plugin:

functions.php
add_filter( 'gform_pre_send_email', function( $compact, $message_format, $notification, $entry ) {
	// Change $compact here.
	return $compact;
}, 10, 4 );

Argument names come from YeeMail's source. Other plugins may pass different values: check the call in the plugin you're targeting below.

4 plugins that fire gform_pre_send_email

Sorted by active installs. Each entry shows where the plugin calls the hook and what it passes.

  1. YeeMail icon YeeMail700+ installs apply_filters( 'gform_pre_send_email', compact( 'to', 'subject', 'message', 'headers', 'attachments', 'abort_email' ), $message_format, $notification, $entry ) includes-overwrite/gravityforms-common.php:1891
  2. PDF for Gravity Forms + Drag And Drop Template Builder icon PDF for Gravity Forms + Drag And Drop Template Builder400+ installs apply_filters( 'gform_pre_send_email', compact('to', 'subject', 'message', 'headers', 'attachments', 'abort_email'), $message_format, $notification, $entry ) gravityforms/gfcommon_style.php:1963
  3. Email Customizer for Gravity Forms icon Email Customizer for Gravity Forms50+ installs apply_filters( 'gform_pre_send_email', compact( 'to', 'subject', 'message', 'headers', 'attachments', 'abort_email' ), $message_format, $notification, $entry ) backend/gfcommon_style.php:1891
  4. Easexport icon Easexport10+ installs apply_filters( 'gform_pre_send_email', compact( 'to', 'subject', 'message', 'headers', 'attachments', 'abort_email' ), $message_format, $notification, $entry ) easexport-gravity-forms-scheduled-entries-export.php:429

Need a customisation built on this hook?

Tell us what you want to change and which plugin it's for. We'll write it, test it and send it back as a small plugin.