WPDK  1.5.0
WordPress Development Kit
 All Data Structures Files Functions Variables Pages
WPDKScreenHelp Class Reference

Public Member Functions

 __construct ()
 Construct. More...
 
 tabs ($tabs=array())
 Tabs. More...
 
 display ()
 Display. More...
 
 addTab ($title, $callable_content)
 Add help tab. More...
 
 sidebar ()
 Sidebar. More...
 

Data Fields

 $currentScreen
 Current screen. More...
 

Detailed Description

Screen helper

Overview

You have to subclass this class

Author
=undo= info@.nosp@m.wpxt.nosp@m.re.me
Date
2014-02-03
Version
1.1.0

Definition at line 17 of file wpdk-screen-help.php.

Constructor & Destructor Documentation

__construct ( )

Construct.

Create an instance of WPDKScreenHelp class

Returns
WPDKScreenHelp

Definition at line 44 of file wpdk-screen-help.php.

Member Function Documentation

addTab (   $title,
  $callable_content 
)

Add help tab.

Add a help tab to current screen

Parameters
string$titleTab title. The title is sanitize and used as id
callable | string$callbackAny string content or callable function for content.

Definition at line 94 of file wpdk-screen-help.php.

display ( )

Display.

Used this method to add tab and sidebar to the screen

Definition at line 69 of file wpdk-screen-help.php.

sidebar ( )

Sidebar.

Return the HTML markup for sidebar

Returns
string

Definition at line 127 of file wpdk-screen-help.php.

tabs (   $tabs = array())

Tabs.

Return a key value pairs array with the list of tabs

Since
1.4.18
Parameters
array$tabsList of tabs
Returns
array

Definition at line 59 of file wpdk-screen-help.php.

Field Documentation

WP_Screen $currentScreen

Current screen.

The WordPres current screen

Definition at line 26 of file wpdk-screen-help.php.


The documentation for this class was generated from the following file: