Email_Welcome_User
extends Email_Welcome_User
in package
Handle new user welcome email.
Tags
Table of Contents
Constants
- CONTENT = 'email-welcome-user.php'
- New user welcome email content partial filename.
Properties
- $content : string
- Fully qualified path to the email content partial.
- $instances : array<string|int, object>
- The array of instances of this class and sub-classes.
- $mail_args : array<string|int, mixed>
- The array of arguments for the email.
Methods
- get_email() : array<string|int, string>
- Filter the new user welcome email.
- get_instance() : object
- Creates and/or returns the instance of this class.
- is_send() : bool
- Filter and set the send email flag.
- __construct() : mixed
- Initialise the class.
Constants
CONTENT
New user welcome email content partial filename.
protected
string
CONTENT
= 'email-welcome-user.php'
Tags
Properties
$content
Fully qualified path to the email content partial.
protected
string
$content
= ''
Tags
$instances
The array of instances of this class and sub-classes.
protected
static array<string|int, object>
$instances
= array()
Tags
$mail_args
The array of arguments for the email.
protected
array<string|int, mixed>
$mail_args
= array('to' => array(), 'cc' => array(), 'bcc' => array(), 'subject' => '', 'body' => '', 'is_internal' => false)
{ The email arguments. @type string[] $to The email address(es) of the recipients of the email. @type string[] $cc Optional. The email address(es) of the cc recipients of the email. @type string[] $bcc Optional. The email address(es) of the bcc recipients of the email. * @type string $subject The subject of the email. @type string $body The email content. @type bool $is_internal Flag to indicate that eamil is internal and not intended for external users. }
Tags
Methods
get_email()
Filter the new user welcome email.
public
get_email(array<string|int, string> $default_email, WP_User $user, string $blogname) : array<string|int, string>
Parameters
- $default_email : array<string|int, string>
-
{ The default welcome email settings. @type string $to The intended recipient - the new user email address. @type string $subject The subject of the email. @type string $message The body content of the email. @type string $headers The headers of the email. }
- $user : WP_User
-
WP_User object of the new user.
- $blogname : string
-
The site title.
Tags
Return values
array<string|int, string> —The modified email parameters.
get_instance()
Creates and/or returns the instance of this class.
public
static get_instance() : object
Tags
Return values
object —The instance of this class.
is_send()
Filter and set the send email flag.
public
is_send(array<string|int, mixed> ...$args) : bool
Parameters
- $args : array<string|int, mixed>
-
A variable set of arguments.
Tags
Return values
bool —The send email flag.
__construct()
Initialise the class.
protected
__construct() : mixed