MainWP Code Reference
\
MainWP
Child
Dashboard

\MainWP\DashboardMainWP_Overview

Class MainWP_Overview

Summary

Methods
Properties
Constants
get_class_name()
get()
__construct()
on_screen_layout_columns()
on_admin_menu()
init_left_menu()
on_load_page()
add_meta_boxes()
on_show_page()
render_dashboard_body()
mainwp_help_content()
No public properties found
No constants found
No protected methods found
$instance
N/A
No private methods found
$enable_widgets
N/A

Properties

$instance

$instance : mixed

The single instance of the class

Type

mixed — Default null

$enable_widgets

$enable_widgets : array

Enabled widgets

Type

array

Methods

get_class_name()

get_class_name() : string

Get Class Name

Returns

string —

CLASS

get()

get()

Check if there is a session, if there isn't one create it.

@return self::singlton Overview Page Session.

__construct()

__construct()

MainWP_Overview constructor.

Run each time the class is called.

on_screen_layout_columns()

on_screen_layout_columns(mixed  $columns, mixed  $screen) : integer

Set the number of page coumns.

Parameters

mixed $columns

Number of Columns.
mixed $screen

Screen size.

Returns

integer —

$columns Number of desired page columns.

on_admin_menu()

on_admin_menu()

Add MainWP Overview top level menu.

init_left_menu()

init_left_menu()

Instantiate the MainWP Overview Menu item.

on_load_page()

on_load_page()

Method on_load_page()

Run on page load.

add_meta_boxes()

add_meta_boxes(array  $page)

Method add_meta_boxes()

Add MainWP Overview Page Widgets.

Parameters

array $page

Current page.

on_show_page()

on_show_page()

Method on_show_page()

When the page loads render the body content.

render_dashboard_body()

render_dashboard_body(object  $websites, mixed  $dashboard, integer  $screen_layout)

Method render_dashboard_body()

Render the Dashboard Body content.

Parameters

object $websites

Object containing child sites info.
mixed $dashboard

Dashboard.
integer $screen_layout

Screen Layout.

mainwp_help_content()

mainwp_help_content() : void

Method mainwp_help_content()

Hook the section help content to the Help Sidebar element