Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Login_Redirects

s2member\includes\classes\login-redirects.inc.php at line #28

Class c_ws_plugin__s2member_login_redirects

c_ws_plugin__s2member_login_redirects

public class c_ws_plugin__s2member_login_redirects

Login redirections.

Since:

3.5


( 5 Methods )
Method Summary
public static str|bool

fill_login_redirect_rc_vars(str $url, obj $user, bool $root_returns_false)

Fills Replacement Codes in Special Redirection URLs.

public static null

login_redirect(str $username, WP_User $user)

Handles login redirections.

public static str|bool

login_redirection_uri(obj $user, bool $root_returns_false)

Parses a Special Login Redirection URI.

public static str|bool

login_redirection_url(obj $user, bool $root_returns_false)

Parses a Special Login Redirection URL.

public static WP_User|WP_Error

ms_wp_authenticate_user(bool $user_or_wp_error, WP_User|WP_Error $Expects)

Assists in multisite User authentication.

( 5 Methods )
Method Detail

s2member\includes\classes\login-redirects.inc.php at line #174

fill_login_redirect_rc_vars()

public static str|bool fill_login_redirect_rc_vars(str $url, obj $user, bool $root_returns_false)

Fills Replacement Codes in Special Redirection URLs.

Since:

3.5

Parameters:

str $url - A URL with possible Replacement Codes in it.

obj $user - Optional. A WP_User object. Defaults to the current User, if logged-in.

bool $root_returns_false - Defaults to false. True if the function should return false when a URL is reduced to the site root.

Returns:

str|bool - A Special Login Redirection URL with Replacement Codes having been parsed, or false if $root_returns_false = true and the URL is the site root.

[ back to top ]

s2member\includes\classes\login-redirects.inc.php at line #67

login_redirect()

public static null login_redirect(str $username, WP_User $user)

Handles login redirections.

Since:

3.5

Attaches-to:

add_action("wp_login");

Parameters:

str $username - Expects Username.

WP_User $user - Expects a WP_User object instance.

Returns:

null - Or exits script execution after a redirection takes place.

[ back to top ]

s2member\includes\classes\login-redirects.inc.php at line #152

login_redirection_uri()

public static str|bool login_redirection_uri(obj $user, bool $root_returns_false)

Parses a Special Login Redirection URI.

Since:

3.5

Parameters:

obj $user - Optional. A WP_User object. Defaults to the current User, if logged-in.

bool $root_returns_false - Defaults to false. True if the function should return false when a URI is reduced to the site root.

Returns:

str|bool - A Special Login Redirection URI with Replacement Codes having been parsed, or false if $root_returns_false = true and the URI is the site root.

[ back to top ]

s2member\includes\classes\login-redirects.inc.php at line #131

login_redirection_url()

public static str|bool login_redirection_url(obj $user, bool $root_returns_false)

Parses a Special Login Redirection URL.

Since:

3.5

Parameters:

obj $user - Optional. A WP_User object. Defaults to the current User, if logged-in.

bool $root_returns_false - Defaults to false. True if the function should return false when a URL is reduced to the site root.

Returns:

str|bool - A Special Login Redirection URL with Replacement Codes having been parsed, or false if $root_returns_false = true and the URL is the site root.

[ back to top ]

s2member\includes\classes\login-redirects.inc.php at line #42

ms_wp_authenticate_user()

public static WP_User|WP_Error ms_wp_authenticate_user(bool $user_or_wp_error, WP_User|WP_Error $Expects)

Assists in multisite User authentication.

Since:

130405

Attaches-to:

add_filter("wp_authenticate_user");

Parameters:

WP_User|WP_Error $Expects - either a WP_User or WP_Error object passed in by the Filter.

Returns:

WP_User|WP_Error - WP_User or WP_Error object (if there was a problem).

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail