MainWP Code Reference
\
MainWP
Child
Dashboard
Module
ApiBackups
CostTracker
Log

\MainWP\DashboardMainWP_User

Class MainWP_User

Summary

Methods
Properties
Constants
get_class_name()
init()
init_menu()
init_subpages_menu()
get_manage_columns()
on_load_page()
hook_screen_options_modal_bottom()
init_left_menu()
render_header()
render_footer()
render()
render_search_options()
render_update_users()
render_table()
render_table_body()
render_cache_not_found()
users_search_handler()
delete()
edit()
update_user()
update_password()
action()
render_bulk_add()
render_bulk_import_users()
render_import_users()
do_bulk_add()
render_bulk_add_modal()
render_bulk_upload()
do_import()
mainwp_help_content()
$subPages
No constants found
users_search_handler_renderer()
No protected properties found
N/A
get_role()
No private properties found
N/A

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.

get_manage_columns()

get_manage_columns() : array

Method get_manage_columns()

Get columns to display.

Returns

array —

$colums Array of columns to display on the page.

on_load_page()

on_load_page() : void

Method on_load_page()

Used during init_menu() to get the class names of, admin_head and get_hidden_columns.

hook_screen_options_modal_bottom()

hook_screen_options_modal_bottom()

Method hook_screen_options_modal_bottom()

Render screen options modal bottom.

init_left_menu()

init_left_menu(array  $subPages = array())

Initiates Users menu.

Parameters

array $subPages

Sub pages array.

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()

Method render_footer()

Render Users page footer. Closes the page container.

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, mixed  $clients = '')

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.
mixed $clients

Current Clients's Sites the user is on.

render_table_body()

render_table_body(string  $role = '', string  $groups = '', string  $sites = '', string  $search = '', mixed  $clients = '')

Renders the table body.

Parameters

string $role

User Role.
string $groups

Usr Group.
string $sites

Users Sites.
string $search

Search field.
mixed $clients

Current Clients's Sites the user is on.

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.

do_bulk_add()

do_bulk_add()

Method do_bulk_add()

Bulk User addition $_POST Handler.

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.

do_import()

do_import()

User Import $_POST handler.

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.