Customer_New_Account extends WCWP_Email
New account email for the customer added via User > Add New
Tags
Table of Contents
- $password_generated : bool
- Is the password generated?
- $set_password_url : string
- Set password URL
- $user_email : string
- User email.
- $user_id : int
- User ID
- $user_login : string
- User login name.
- $user_pass : string
- User password.
- $placeholders_desc : array<string|int, mixed>
- Placeholder descriptions
- $template_directory : string
- The template directory.
- __construct() : mixed
- Constructor.
- admin_options() : mixed
- Admin Options.
- get_body_content() : string
- Return content from the body_content field.
- get_content_html() : string
- Get content html.
- get_content_plain() : string
- Get content plain.
- get_default_body_content() : string
- Default email body content
- get_default_heading() : string
- Get email heading.
- get_default_subject() : string
- Get email subject.
- handle_locate_core_template() : string
- Load our custom template as the core template for settings page
- handle_locate_template() : string
- Locate our template for sending the mails
- init_form_fields() : mixed
- Initialise settings form fields.
- override_new_user_notification_email() : array<string|int, mixed>
- Override the default new user email.
- register() : mixed
- {@inheritdoc}
- trigger() : mixed
- Trigger.
- generate_merge_tags_list() : mixed
- Outputs a list of available merge tags.
- generate_set_password_url() : string
- Generate set password URL link for a new user.
Properties
$password_generated
Is the password generated?
public
bool
$password_generated
Tags
$set_password_url
Set password URL
public
string
$set_password_url
Tags
$user_email
User email.
public
string
$user_email
Tags
$user_id
User ID
public
int
$user_id
Tags
$user_login
User login name.
public
string
$user_login
Tags
$user_pass
User password.
public
string
$user_pass
Tags
$placeholders_desc
Placeholder descriptions
protected
array<string|int, mixed>
$placeholders_desc
Tags
$template_directory
The template directory.
protected
string
$template_directory
Tags
Methods
__construct()
Constructor.
public
__construct(string $template_directory) : mixed
Parameters
- $template_directory : string
Tags
Return values
mixed —admin_options()
Admin Options.
public
admin_options() : mixed
We make a slight modification to the core admin options, so that the back link goes to our custom emails list
Tags
Return values
mixed —get_body_content()
Return content from the body_content field.
public
get_body_content() : string
Tags
Return values
string —get_content_html()
Get content html.
public
get_content_html() : string
Tags
Return values
string —get_content_plain()
Get content plain.
public
get_content_plain() : string
Tags
Return values
string —get_default_body_content()
Default email body content
public
get_default_body_content() : string
Tags
Return values
string —get_default_heading()
Get email heading.
public
get_default_heading() : string
Tags
Return values
string —get_default_subject()
Get email subject.
public
get_default_subject() : string
Tags
Return values
string —handle_locate_core_template()
Load our custom template as the core template for settings page
public
handle_locate_core_template(string $file, string $template, string $template_base, string $template_id) : string
Parameters
- $file : string
- $template : string
- $template_base : string
- $template_id : string
Tags
Return values
string —$file
handle_locate_template()
Locate our template for sending the mails
public
handle_locate_template(string $template, string $template_name, string $template_path) : string
Parameters
- $template : string
- $template_name : string
- $template_path : string
Tags
Return values
string —$template
init_form_fields()
Initialise settings form fields.
public
init_form_fields() : mixed
Tags
Return values
mixed —override_new_user_notification_email()
Override the default new user email.
public
override_new_user_notification_email(array<string|int, mixed> $email, WP_User $user, string $blogname) : array<string|int, mixed>
Parameters
- $email : array<string|int, mixed>
- $user : WP_User
- $blogname : string
Tags
Return values
array<string|int, mixed> —register()
{@inheritdoc}
public
register() : mixed
Tags
Return values
mixed —trigger()
Trigger.
public
trigger(int $user_id[, string $user_pass = '' ]) : mixed
Parameters
- $user_id : int
-
User ID.
- $user_pass : string = ''
-
User Password.
Tags
Return values
mixed —generate_merge_tags_list()
Outputs a list of available merge tags.
protected
generate_merge_tags_list() : mixed
Tags
Return values
mixed —generate_set_password_url()
Generate set password URL link for a new user.
protected
generate_set_password_url() : string