Filters whether to preempt sending an email.
Description
Returning a non-null value will short-circuit wp_mail(), returning that value instead. A boolean return value should be used to indicate whether the email was successfully sent.
Parameters
$returnnull|bool- Short-circuit return value.
$attsarray- Array of the
wp_mail()arguments.
tostring|string[]Array or comma-separated list of email addresses to send message.subjectstringEmail subject.messagestringMessage contents.headersstring|string[]Additional headers.attachmentsstring|string[]Paths to files to attach.
Source
$pre_wp_mail = apply_filters( 'pre_wp_mail', null, $atts );
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.