Properties

$subPages

$subPages : array

Public static varable to hold Subpages information.

Type

array

Methods

get_class_name()

get_class_name() : string

Get Class Name

Returns

string —

CLASS

init()

init() 

Method init()

Initiate hooks for the users page.

init_menu()

init_menu() 

Method init_menu()

Initiate menu.

init_subpages_menu()

init_subpages_menu() 

Initiates sub pages menu.

init_left_menu()

init_left_menu(array  $subPages = array(), integer  $level = 2) 

Initiates Users menu.

Parameters

array $subPages

Sub pages array.

integer $level

What level to display on.

render_header()

render_header(string  $shownPage = '') 

Method render_header()

Render Users page header.

Parameters

string $shownPage

The page slug shown at this moment.

render_footer()

render_footer(string  $shownPage = '') 

Method render_footer()

Render Users page footer. Closes the page container.

Parameters

string $shownPage

The page slug shown at this moment.

render()

render() : void

Renders manage users dashboard.

render_search_options()

render_search_options() 

Method render_search_options()

Render User page search.

render_update_users()

render_update_users() 

Renders Edit Users Modal window.

render_table()

render_table(boolean  $cached = true, string  $role = '', string  $groups = '', string  $sites = '', null  $search = null) 

Renders Users Table.

Parameters

boolean $cached

true|false Cached or not.

string $role

Current user role.

string $groups

Current user groups.

string $sites

Current Child Sites the user is on.

null $search

Search field.

render_cache_not_found()

render_cache_not_found() 

Renders when cache is not found.

users_search_handler()

users_search_handler(mixed  $data, mixed  $website, mixed  $output) 

Handles user search.

Parameters

mixed $data

Search data.

mixed $website

Child Site.

mixed $output

Output to pass to self::users_search_handler_renderer().

delete()

delete() 

Deletes user.

edit()

edit() 

Edits user.

update_user()

update_user() 

Updates user.

update_password()

update_password() 

Updates users password.

action()

action(mixed  $pAction, string  $extra = '') : mixed

Users actions.

Parameters

mixed $pAction

Action to perform delete|update_user|update_password.

string $extra

Additional Roles to add if any.

Throws

\Exception

Error message.

Returns

mixed —

$information User update info that is returned.

render_bulk_add()

render_bulk_add() 

Renders the Add New user form.

render_bulk_import_users()

render_bulk_import_users() : void

Renders bulk Import Users form.

render_import_users()

render_import_users() 

Method render_import_users()

Render Import Users page.

render_bulk_add_modal()

render_bulk_add_modal(mixed  $dbwebsites, mixed  $output) 

Renders Bulk User addition Modal window.

Parameters

mixed $dbwebsites

Child sites list.

mixed $output

Modal window content.

render_bulk_upload()

render_bulk_upload() 

Renders Import Users Modal window.

mainwp_help_content()

mainwp_help_content() 

Hooks the section help content to the Help Sidebar element.

users_search_handler_renderer()

users_search_handler_renderer(array  $users, object  $website) : mixed

Renders Search results.

Parameters

array $users

Users array.

object $website

Object containing the child site info.

Returns

mixed —

Search results table.

get_role()

get_role(string  $role) 

Gets the selected users current role.

Parameters

string $role

Selected Users Role.