MainWP Code Reference
\
MainWP
Child
Dashboard

\MainWP\DashboardMainWP_UI

Class MainWP_UI

Summary

Methods
Properties
Constants
get_class_name()
select_sites_box()
select_sites_box_body()
render_select_sites_header()
render_select_sites()
render_select_sites_staging()
render_select_sites_group()
render_top_header()
render_second_top_header()
gen_groups_sites_selection()
render_header_actions()
render_page_navigation()
render_header()
render_footer()
add_widget_box()
do_widget_boxes()
render_empty_bulk_actions()
render_modal_install_plugin_theme()
render_show_all_updates_button()
render_sorting_icons()
render_modal_edit_notes()
render_screen_options()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

get_class_name()

get_class_name() : object

Method get_class_name()

Get Class Name.

Returns

object

select_sites_box()

select_sites_box(string  $type = 'checkbox', boolean  $show_group = true, boolean  $show_select_all = true, string  $class = '', string  $style = '', array  $selected_websites = array(), array  $selected_groups = array(), boolean  $enableOfflineSites = false, integer  $postId)

Method select_sites_box()

Select sites box.

Parameters

string $type

Input type, radio.
boolean $show_group

Whether or not to show group, Default: true.
boolean $show_select_all

Whether to show select all.
string $class

Default = ''.
string $style

Default = ''.
array $selected_websites

Selected Child Sites.
array $selected_groups

Selected Groups.
boolean $enableOfflineSites

(bool) True, if offline sites is enabled. False if not.
integer $postId

Post Meta ID.

select_sites_box_body()

select_sites_box_body(array  $selected_websites = array(), array  $selected_groups = array(), string  $type = 'checkbox', boolean  $show_group = true, boolean  $show_select_all = true, boolean  $updateQty = false, boolean  $enableOfflineSites = false, integer  $postId)

Method select_sites_box_body()

Select sites box Body.

Parameters

array $selected_websites

Child Site that are selected.
array $selected_groups

Group that are selected.
string $type

Selector type.
boolean $show_group

Whether or not to show group, Default: true.
boolean $show_select_all

Whether or not to show select all, Default: true.
boolean $updateQty

Whether or not to update quantity, Default = false.
boolean $enableOfflineSites

Whether or not to enable offline sites, Default: true.
integer $postId

Post ID.

render_select_sites_header()

render_select_sites_header(integer  $tab_id, boolean  $staging_enabled, array  $selected_groups, boolean  $show_group = true, boolean  $show_select_all = true)

Method render_select_sites_header()

Render selected sites header.

Parameters

integer $tab_id

Datatab ID.
boolean $staging_enabled

True, if in the active plugins list. False, not in the list.
array $selected_groups

Selected groups.
boolean $show_group

Whether or not to show group, Default: true.
boolean $show_select_all

Whether or not to show select all, Default: true.

render_select_sites()

render_select_sites(object  $websites, string  $type, mixed  $tab_id, mixed  $selected_websites, boolean  $enableOfflineSites, mixed  $edit_site_id) : void

Method render_select_sites()

Parameters

object $websites

Object containing child sites info.
string $type

Selector type.
mixed $tab_id

Datatab ID.
mixed $selected_websites

Selected Child Sites.
boolean $enableOfflineSites

(bool) True, if offline sites is enabled. False if not.
mixed $edit_site_id

Child Site ID to edit.

render_select_sites_staging()

render_select_sites_staging(boolean  $staging_enabled, mixed  $tab_id, mixed  $selected_websites, mixed  $edit_site_id, string  $type = 'checkbox') : void

Method render_select_sites_staging()

Render selected staging sites.

Parameters

boolean $staging_enabled

(bool) True, if in the active plugins list. False, not in the list.
mixed $tab_id

Datatab ID.
mixed $selected_websites

Selected Child Sites.
mixed $edit_site_id

Child Site ID to edit.
string $type

Selector type.

render_select_sites_group()

render_select_sites_group(array  $groups, mixed  $tab_id, mixed  $selected_groups, string  $type = 'checkbox') : void

Method render_select_sites_group()

Render selected sites group.

Parameters

array $groups

Array of groups.
mixed $tab_id

Datatab ID.
mixed $selected_groups

Selected groups.
string $type

Selector type.

render_top_header()

render_top_header(array  $params = array())

Method render_top_header()

Render top header.

Parameters

array $params

Page parameters.

render_second_top_header()

render_second_top_header(string  $which = '') : void

Method render_second_top_header()

Render second top header.

Parameters

string $which

Current page.

gen_groups_sites_selection()

gen_groups_sites_selection() : void

Method gen_groups_sites_selection()

Generate group sites selection box.

render_header_actions()

render_header_actions() : mixed

Method render_header_actions()

Render header action buttons, (Sync|Add|Options|Community|User|Updates).

Returns

mixed —

$output Render header action buttons html.

render_page_navigation()

render_page_navigation(array  $subitems = array(), null  $name_caller = null)

Method render_page_navigation()

Render page navigation.

Parameters

array $subitems

[access, active, style].
null $name_caller

Menu Name.

render_header()

render_header(string  $title = '') : void

Method render_header()

Render page title.

Parameters

string $title

Page title.

render_footer()

render_footer() : void

Method render_footer()

Render page footer.

add_widget_box()

add_widget_box(mixed  $id, mixed  $callback, null  $screen = null, string|null  $context = null, null  $title = null, string  $priority = 'default') : void

Method add_widget_box()

Customize WordPress add_meta_box() function.

Parameters

mixed $id

Widget ID parameter.
mixed $callback

Callback function.
null $screen

Current page.
string|null $context

right|null. If 3 columns then = 'middle'.
null $title

Widget title.
string $priority

high|core|default|low, Default: default.

do_widget_boxes()

do_widget_boxes(mixed  $screen, string|null  $context = null, string  $object = '') : void

Method do_widget_boxes()

Customize WordPress do_meta_boxes() function.

Parameters

mixed $screen

Current page.
string|null $context

right|null. If 3 columns then = 'middle'.
string $object

Empty string.

render_empty_bulk_actions()

render_empty_bulk_actions()

Method render_empty_bulk_actions()

Render empty bulk actions when drop down is disabled.

render_modal_install_plugin_theme()

render_modal_install_plugin_theme(string  $what = 'plugin')

Method render_modal_install_plugin_theme()

Render modal window for installing plugins & themes.

Parameters

string $what

Which window to render, plugin|theme.

render_show_all_updates_button()

render_show_all_updates_button() : void

Method render_show_all_updates_button()

Render show all updates button.

render_sorting_icons()

render_sorting_icons() : void

Method render_sorting_icons()

Render sorting up & down icons.

render_modal_edit_notes()

render_modal_edit_notes(string  $what = 'site') : void

Method render_modal_edit_notes()

Render modal window for edit notes.

Parameters

string $what

What modal window to render. Default = site.

render_screen_options()

render_screen_options(boolean  $setting_page = true) : void

Method render_screen_options()

Render modal window for Screen Options.

Parameters

boolean $setting_page

Default: True. Widgets that you want to hide in the MainWP Overview page.