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.

Parameters

$return

(null|bool) Short-circuit return value.

$atts

(array) Array of the wp_mail() arguments.

  • 'to'
    (string|string[]) Array or comma-separated list of email addresses to send message.
  • 'subject'
    (string) Email subject.
  • 'message'
    (string) Message contents.
  • 'headers'
    (string|string[]) Additional headers.
  • 'attachments'
    (string|string[]) Paths to files to attach.

Source

File: wp-includes/pluggable.php

View on Trac

Used By

Used By Description
wp-includes/pluggable.php: wp_mail()

Sends an email, similar to PHP’s mail function.

Changelog

Version Description
5.7.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_wp_mail