Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Users_List

s2member\includes\classes\users-list.inc.php at line #28

Class c_ws_plugin__s2member_users_list

c_ws_plugin__s2member_users_list

public class c_ws_plugin__s2member_users_list

Users list.

Since:

3.5


( 5 Methods )
Method Summary
public static array

users_list_cols(bool $cols, array $columns)

Adds columns to the list of Users.

public static str

users_list_display_cols(str $val, str $col, int|str $user_id)

Displays column data in the row of details.

public static inner

users_list_edit_cols(obj $user)

Adds Custom Fields to the admin Profile editing page.

public static null

users_list_query(obj $query)

Modifies the search query.

public static inner

users_list_update_cols(int|str $user_id)

Saves Custom Fields after an admin updates Profile.

( 5 Methods )
Method Detail

s2member\includes\classes\users-list.inc.php at line #120

users_list_cols()

public static array users_list_cols(bool $cols, array $columns)

Adds columns to the list of Users.

Since:

3.5

Attaches-to:

add_filter ("manage_users_columns");

Parameters:

array $columns - Expects an array of columns to be passed through by the Filter.

Returns:

array - Array of columns, merged with columns introduced by this routine.

[ back to top ]

s2member\includes\classes\users-list.inc.php at line #168

users_list_display_cols()

public static str users_list_display_cols(str $val, str $col, int|str $user_id)

Displays column data in the row of details.

Since:

3.5

Attaches-to:

add_filter ("manage_users_custom_column");

Parameters:

str $val - A value for this column, passed through by the Filter.

str $col - The name of the column for which we might need to supply data for.

int|str $user_id - Expects a WordPress® User ID, passed through by the Filter.

Returns:

str - A column value introduced by this routine, or existing value, or, if empty, a dash.

[ back to top ]

s2member\includes\classes\users-list.inc.php at line #42

users_list_edit_cols()

public static inner users_list_edit_cols(obj $user)

Adds Custom Fields to the admin Profile editing page.

Since:

3.5

Attaches-to:

add_action("edit_user_profile");

add_action("show_user_profile");

Parameters:

obj $user - Expects a WP_User object passed in by the Action Hook.

Returns:

inner - Return-value of inner routine.

[ back to top ]

s2member\includes\classes\users-list.inc.php at line #75

users_list_query()

public static null users_list_query(obj $query)

Modifies the search query.

Affects searches performed in the list of Users.

Since:

3.5

Attaches-to:

add_action("pre_user_query");

Parameters:

obj $query - Expects a WP_User_Query object, by reference.

Returns:

null - After possibly modifying the $query object.

[ back to top ]

s2member\includes\classes\users-list.inc.php at line #58

users_list_update_cols()

public static inner users_list_update_cols(int|str $user_id)

Saves Custom Fields after an admin updates Profile.

Since:

3.5

Attaches-to:

add_action("edit_user_profile_update");

add_action("personal_options_update");

Parameters:

int|str $user_id - Expects a numeric WordPress® User ID passed in by the Action Hook.

Returns:

inner - Return-value of inner routine.

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail