auto_plugin_theme_update_email │ filter-hook │ WP 5.5.0

Filters the email sent following an automatic background update for plugins and themes.

Usage

add_filter( 'auto_plugin_theme_update_email', 'wp_kama_auto_plugin_theme_update_email_filter', 10, 4 );

/**
 * Function for `auto_plugin_theme_update_email` filter-hook.
 * 
 * @param array  $email              Array of email arguments that will be passed to wp_mail().
 * @param string $type               The type of email being sent. Can be one of 'success', 'fail', 'mixed'.
 * @param array  $successful_updates A list of updates that succeeded.
 * @param array  $failed_updates     A list of updates that failed.
 *
 * @return array
 */
function wp_kama_auto_plugin_theme_update_email_filter( $email, $type, $successful_updates, $failed_updates ){

	// filter...
	return $email;
}

$email(array)

Array of email arguments that will be passed to wp_mail().

• to(string)
  The email recipient. An array of emails can be returned, as handled by wp_mail().

• subject(string)
  The email's subject.

• body(string)
  The email message body.

• headers(string)
  Any email headers.
  Default: no headers

$type(string)

The type of email being sent. Can be one of 'success', 'fail', 'mixed'.

$successful_updates(array)

A list of updates that succeeded.

$failed_updates(array)

A list of updates that failed.

Changelog

Where the hook is called

$email = apply_filters( 'auto_plugin_theme_update_email', $email, $type, $successful_updates, $failed_updates );

Where the hook is used in WordPress