apply_filters( 'pre_wp_mail', null|bool $return, array $atts )

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.


Top ↑

Parameters

$return null|bool
Short-circuit return value.
$atts array
Array of the wp_mail() arguments.
  • tostring|string[]
    Array or comma-separated list of email addresses to send message.
  • subjectstring
    Email subject.
  • messagestring
    Message contents.
  • headersstring|string[]
    Additional headers.
  • attachmentsstring|string[]
    Paths to files to attach.

Top ↑

Source

File: wp-includes/pluggable.php. View all references

$pre_wp_mail = apply_filters( 'pre_wp_mail', null, $atts );


Top ↑

Changelog

Changelog
Version Description
5.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.