хук-фильтр
since 5.7.0
pre_wp_mail
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
apply_filters( 'pre_wp_mail', null|bool $return, array $atts )Описание
Возврат значения, отличного от null, прервёт wp_mail() и вернёт это значение вместо него. Логическое возвращаемое значение следует использовать для указания, было ли письмо успешно отправлено.
Оригинал (английский)
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.
Фильтруемое значение
Значение для прерывания выполнения.
Параметры
$return
null|bool
обязательный
Значение для прерывания выполнения.
$atts
array
обязательный
Массив аргументов wp_mail().
to string|string[]Массив или список email-адресов через запятую, на которые отправляется сообщение.
subject stringТема письма.
message stringСодержимое сообщения.
headers string|string[]Дополнительные заголовки.
attachments string|string[]Пути к прикрепляемым файлам.
embeds string|string[]Пути к встраиваемым файлам.
Исходный код
wp-includes/pluggable.php:233
$pre_wp_mail = apply_filters( 'pre_wp_mail', null, $atts );История изменений
| Версия | Описание |
|---|---|
| 6.9.0 | The $embeds element was added to the $atts array. |
| 5.7.0 | Introduced. |
