user_request_action_email_headers │ filter-hook │ WP 5.4.0

Filters the headers of the email sent when an account action is attempted.

Usage

add_filter( 'user_request_action_email_headers', 'wp_kama_user_request_action_email_headers_filter', 10, 5 );

/**
 * Function for `user_request_action_email_headers` filter-hook.
 * 
 * @param string|array $headers    The email headers.
 * @param string       $subject    The email subject.
 * @param string       $content    The email content.
 * @param int          $request_id The request ID.
 * @param array        $email_data Data relating to the account action email.
 *
 * @return string|array
 */
function wp_kama_user_request_action_email_headers_filter( $headers, $subject, $content, $request_id, $email_data ){

	// filter...
	return $headers;
}

$headers(string|array)

The email headers.

$subject(string)

The email subject.

$content(string)

The email content.

$request_id(int)

The request ID.

$email_data(array)

Data relating to the account action email.

• request(WP_User_Request)
  User request object.

• email(string)
  The email address this is being sent to.

• description(string)
  Description of the action being performed so the user knows what the email is for.

• confirm_url(string)
  The link to click on to confirm the account action.

• sitename(string)
  The site name sending the mail.

• siteurl(string)
  The site URL sending the mail.

Changelog

Where the hook is called

$headers = apply_filters( 'user_request_action_email_headers', $headers, $subject, $content, $request_id, $email_data );

Where the hook is used in WordPress