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.

• 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

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

View all references View on Trac View on GitHub

Changelog