Filter hook 'wp_mail'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into wp_mail
add_filter('wp_mail', 'my_custom_filter', 10, 1);

function my_custom_filter($args) {
    // Your custom filtering logic here
    return $args;
}

Source Code Context

<?php
 187  		 *     @type string          $message     Message contents.
 188  		 *     @type string|string[] $headers     Additional headers.
 189  		 *     @type string|string[] $attachments Paths to files to attach.
 190  		 * }
 191  		 */
 192  		$atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );
 193  
 194  		/**
 195  		 * Filters whether to preempt sending an email.
 196  		 *
 197  		 * Returning a non-null value will short-circuit {@see wp_mail()}, returning

PHP Documentation

<?php
/**
		 * Filters the wp_mail() arguments.
		 *
		 * @since 2.2.0
		 *
		 * @param array $args {
		 *     Array of the `wp_mail()` arguments.
		 *
		 *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
		 *     @type string          $subject     Email subject.
		 *     @type string          $message     Message contents.
		 *     @type string|string[] $headers     Additional headers.
		 *     @type string|string[] $attachments Paths to files to attach.
		 * }
		 */