\AdminPageFramework_MetaBox_Help

Provides methods to manipulate the contextual help tab .

Summary

Methods
Properties
Constants
No public methods found
No public properties found
No constants found
addHelpText()
addHelpTextForFormFields()
setHelpTab()
$oScreen
N/A
No private methods found
No private properties found
N/A

Properties

$oScreen

$oScreen : object

Stores the screen object.

Type

object

Methods

addHelpText()

addHelpText( $strHTMLContent,  $strHTMLSidebarContent)

Adds the given HTML text to the contextual help pane.

The help tab will be the meta box title and all the added text will be inserted into the content area within the tab.

Example

$this->addHelpText( __( 'This text will appear in the contextual help pane.', 'admin-page-framework-demo' ), __( 'This description goes to the sidebar of the help pane.', 'admin-page-framework-demo' ) );

Parameters

$strHTMLContent
$strHTMLSidebarContent

addHelpTextForFormFields()

addHelpTextForFormFields( $strFieldTitle,  $strHelpText,  $strHelpTextSidebar)

Adds the given HTML text to the contextual help pane.

The help tab will be the meta box title and all the added text will be inserted into the content area within the tab. On contrary to the addHelpTab() method of the AdminPageFramework_Help class, the help tab title is already determined and the meta box ID and the title will be used.

Parameters

$strFieldTitle
$strHelpText
$strHelpTextSidebar

setHelpTab()

setHelpTab( $strID,  $strTitle,  $arrContents,  $arrSideBarContents)

Sets the contextual help tab.

On contrary to other methods relating to contextual help tabs that just modify the class properties, this finalizes the help tab contents. In other words, the set values here will take effect.

Parameters

$strID
$strTitle
$arrContents
$arrSideBarContents