c_ws_plugin__s2member_email_configs
public class c_ws_plugin__s2member_email_configs
3.5
( 9 Methods ) Method Summary | |
---|---|
public static str | _email_config_email(str $email) A sort of callback function that applies the email Filter. |
public static str | _email_config_name(str $name) A sort of callback function that applies the name Filter. |
public static null | Modifies email From: |
public static null | email_config_release(bool $all) Releases Filters that modify the email From: "Name" . |
public static bool | email_config_status(bool $any) Checks the status of Filters being applied to the email From: "Name" . |
public static array | email_filter(array $array) Filters email addresses passed to |
public static str | ms_nice_email_roles(str $message) Converts primitive Role names in emails sent by WordPress®. |
public static bool | new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email) Handles new User/Member notifications. |
public static bool | reset_pass_resend_new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email) Resets a User/Member password and resends the New User Notification email message (to the User/Member only). |
public static str _email_config_email(str $email)
A sort of callback function that applies the email Filter.
3.5
add_filter("wp_mail_from");
str $email - Expects the email address to be passed in by the Filter.
str - s2Member-configured email address.
public static str _email_config_name(str $name)
A sort of callback function that applies the name Filter.
3.5
add_filter("wp_mail_from_name");
str $name - Expects the name to be passed in by the Filter.
str - s2Member-configured name.
public static null email_config()
Modifies email From: "Name"
.
These Filters are only needed during registration.
3.5
null
public static null email_config_release(bool $all)
Releases Filters that modify the email From: "Name"
.3.5
bool $all - Optional. Defaults to false. If true, remove ALL Filters, not just those applied by s2Member.
null
public static bool email_config_status(bool $any)
Checks the status of Filters being applied to the email From: "Name"
.3.5
bool $any - Optional. Defaults to false. If true, return true if ANY Filters are being applied, not just those applied by s2Member.
bool - True if Filters are being applied, else false.
public static array email_filter(array $array)
Filters email addresses passed to wp_mail()
.
3.5
add_filter("wp_mail");
s2Member\Utilities → c_ws_plugin__s2member_utils_strings::parse_emails()
array $array - Expects an array passed through by the Filter.
array - Returns the array passed through by the Filter.
public static str ms_nice_email_roles(str $message)
Converts primitive Role names in emails sent by WordPress®.
Only necessary with this particular email: wpmu_signup_user_notification_email
.
3.5
add_filter("wpmu_signup_user_notification_email");
str $message - Expects the message string to be passed in by the Filter.
str - Message after having been Filtered by s2Member.
public static bool new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email)
Handles new User/Member notifications.
110707
str|int $user_id - A numeric WordPress® User ID.
str $user_pass - Optional. A plain text version of the User's password. If omitted, only the administrative notification will be sent.
array $notify - An array of directives. Must be non-empty, with at least one of these values user,admin
.
str $user_email - Optional. This defaults to the user's currently configured email address.
bool - True if all required parameters are supplied, else false.
public static bool reset_pass_resend_new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email)
Resets a User/Member password and resends the New User Notification email message (to the User/Member only).
110707
str|int $user_id - A numeric WordPress® User ID.
str $user_pass - Optional. A plain text version of the User's password. If omitted, a new password will be generated automatically.
array $notify - An array of directives. Must be non-empty, with at least one of these values user,admin
. This defaults to a value of array('user')
. We notify the User/Member only (and NOT the administrator).
str $user_email - Optional. This defaults to the user's currently configured email address.
bool - True if all required parameters are supplied, else false.
Email configurations for s2Member.