Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Registrations

s2member\includes\classes\registrations.inc.php at line #28

Class c_ws_plugin__s2member_registrations

c_ws_plugin__s2member_registrations

public class c_ws_plugin__s2member_registrations

Registration handlers.

Since:

3.5


( 10 Methods )
Method Summary
public static null

configure_user_on_ms_blog_activation(int|str $blog_id, int|str $user_id, str $password, str $title, array $meta)

Configures new Users on a Multisite Network installation.

public static null

configure_user_on_ms_user_activation(int|str $user_id, str $password, array $meta)

Configures new Users on a Multisite Network installation.

public static null

configure_user_registration(int|str $user_id, str $password, array $meta)

Configures all new Users.

public static str

generate_password(str $password)

Filters WordPress® randomly generated Passwords.

public static obj|array

ms_activate_existing_user(obj $_error, array $vars)

Intersects with wpmu_activate_signup() through s2Member's Multisite Networking patch.

public static int|false

ms_create_existing_user(str $user_login, str $user_email, str $user_pass, int|str $user_id)

For Multisite Networks, this function is used to add a User to an existing Blog; and to simulate wp_create_user() behavior.

public static null

ms_process_signup_hidden_fields()

Adds hidden fields for $_POST vars on signup.

public static array

ms_process_signup_meta(array $meta)

Adds Customs Fields to $meta on signup.

public static obj

ms_register_existing_user(obj $errors, str $user_login, str $user_email)

Intersects with register_new_user() through s2Member's Multisite Networking patch.

public static array

ms_validate_user_signup(array $result)

Filters Multisite User validation.

( 10 Methods )
Method Detail

s2member\includes\classes\registrations.inc.php at line #276

configure_user_on_ms_blog_activation()

public static null configure_user_on_ms_blog_activation(int|str $blog_id, int|str $user_id, str $password, str $title, array $meta)

Configures new Users on a Multisite Network installation.

This does NOT fire for a Super Admin managing Network Blogs. Actually it does; BUT it's blocked by the routine below. A Super Admin should NOT trigger this event.

This function should ONLY be fired through /wp-activate.php. Or also through /activate via BuddyPress.

Since:

3.5

Attaches-to:

add_action("wpmu_activate_blog");

Parameters:

int|str $blog_id - A numeric WordPress® Blog ID.

int|str $user_id - A numeric WordPress® User ID.

str $password - Plain text Password should be passed through by the Action Hook.

str $title - The title that a User chose during signup; for their new Blog on the Network.

array $meta - Expects an array of $meta details, passed through by the Action Hook.

Returns:

null

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #235

configure_user_on_ms_user_activation()

public static null configure_user_on_ms_user_activation(int|str $user_id, str $password, array $meta)

Configures new Users on a Multisite Network installation.

This can ONLY be fired in the admin via /user-new.php. Or also during an actual activation; through /wp-activate.php. Or also during an actual activation; through /activate via BuddyPress.

Since:

3.5

Attaches-to:

add_action("wpmu_activate_user");

Parameters:

int|str $user_id - A numeric WordPress® User ID.

str $password - Plain text Password should be passed through by the Action Hook.

array $meta - Expects an array of $meta details, passed through by the Action Hook.

Returns:

null

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #408

configure_user_registration()

public static null configure_user_registration(int|str $user_id, str $password, array $meta)

Configures all new Users.

The Hook user_register is also fired by calling: c_ws_plugin__s2member_registrations::ms_create_existing_user() and/or wpmu_create_user().

This function also receives hand-offs from s2Member's handlers for these two Hooks: wpmu_activate_user and wpmu_activate_blog.

Since:

3.5

Attaches-to:

add_action("user_register");

Parameters:

int|str $user_id - A numeric WordPress® User ID.

str $password - Optional in most cases. A User's plain text Password. If unspecified, attempts are made to collect the plain text Password from other sources.

array $meta - Optional in most cases. Defaults to false. An array of meta data for a User/Member.

Returns:

null - No return value. Returns null in possible every scenario.

Todo:

Impossible to delete cookies when fired inside: /wp-activate.php?

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #44

generate_password()

public static str generate_password(str $password)

Filters WordPress® randomly generated Passwords.

Also captures Passwords generated by WordPress® (with a global var), for internal use.

Since:

3.5

Attaches-to:

add_filter("random_password");

Parameters:

str $password - Expects a plain text Password passed through by the Filter.

Returns:

str - Password, possibly assigned through s2Member Custom Registration/Profile Field input.

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #192

ms_activate_existing_user()

public static obj|array ms_activate_existing_user(obj $_error, array $vars)

Intersects with wpmu_activate_signup() through s2Member's Multisite Networking patch.

This function should return the same array that wpmu_activate_signup() returns; with the assumption that $user_already_exists. Which is exactly where this function intersects inside the /wp-includes/ms-functions.php.

This can ONLY be fired through /wp-activate.php on the front-side. Or through /activate via BuddyPress.

Since:

3.5

Attaches-to:

add_filter("_wpmu_activate_existing_error_");

Parameters:

obj $_error - Expects a WP_Error object to be passed through by the Filter.

array $vars - Expects the defined variables from the scope of the calling Filter.

Returns:

obj|array - If unable to add an existing User, the original $_error obj is returned. Otherwise we return an array of User details for continued processing by the caller.

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #364

ms_create_existing_user()

public static int|false ms_create_existing_user(str $user_login, str $user_email, str $user_pass, int|str $user_id)

For Multisite Networks, this function is used to add a User to an existing Blog; and to simulate wp_create_user() behavior.

The $user_id value will be returned by this function, just like wp_create_user() does. This function will fire the Hook user_register.

Since:

3.5

Parameters:

str $user_login - Expects the User's Username.

str $user_email - Expects the User's Email Address.

str $user_pass - Expects the User's plain text Password.

int|str $user_id - Optional. A numeric WordPress® User ID. If unspecified, a lookup is performed with $user_login and $user_email.

Returns:

int|false - Returns numeric $user_id on success, else false on failure.

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #113

ms_process_signup_hidden_fields()

public static null ms_process_signup_hidden_fields()

Adds hidden fields for $_POST vars on signup.

This can ONLY be fired through /wp-signup.php on the front-side. Or through /register via BuddyPress.

Since:

3.5

Attaches-to:

add_filter("signup_hidden_fields");

Returns:

null

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #148

ms_process_signup_meta()

public static array ms_process_signup_meta(array $meta)

Adds Customs Fields to $meta on signup.

This can ONLY be fired through /wp-signup.php on the front-side. Or possibly through /user-new.php in the admin. Or through /register via BuddyPress.

Since:

3.5

Attaches-to:

add_filter("add_signup_meta");

add_filter("bp_signup_usermeta");

Parameters:

array $meta - Expects an array of meta-data to be passed in by the Filter.

Returns:

array - Full $meta array with s2Member Custom Fields included.

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #311

ms_register_existing_user()

public static obj ms_register_existing_user(obj $errors, str $user_login, str $user_email)

Intersects with register_new_user() through s2Member's Multisite Networking patch.

This function Filters registration errors inside /wp-login.php via register_new_user(). When an existing Multisite User is registering, this takes over registration processing.

This can ONLY be fired through /wp-login.php on the front-side.

Since:

3.5

Attaches-to:

add_filter("registration_errors");

Parameters:

obj $errors - Expects a WP_Error object passed in by the Filter.

str $user_login - Expects the User's Username, passed in by the Filter.

str $user_email - Expects the User's Email Address, passed in by the Filter.

Returns:

obj - A WP_Error object, or exits script execution after handling registration redirection.

[ back to top ]

s2member\includes\classes\registrations.inc.php at line #80

ms_validate_user_signup()

public static array ms_validate_user_signup(array $result)

Filters Multisite User validation.

This can ONLY be fired through /wp-signup.php on the front-side. Or through /register via BuddyPress.

Since:

3.5

Attaches-to:

add_filter("wpmu_validate_user_signup");

Parameters:

array $result - Expects a $result array to be passed through by the Filter.

Returns:

array - The Filtered $result array. Possibly containing errors introduced by s2Member.

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail