\AdminPageFramework_Help

Provides methods to manipulate the help screen sections.

Summary

Methods
Properties
Constants
No public methods found
No public properties found
No constants found
addHelpTab()
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

addHelpTab()

addHelpTab(array $arrHelpTab) : void

Adds the given contextual help tab contents into the property.

Contextual Help Tab Array Structure

  • strPageSlug - the page slug of the page that the contextual help tab and its contents are displayed.
  • strPageTabSlug - ( optional ) the tab slug of the page that the contextual help tab and its contents are displayed.
  • strHelpTabTitle - the title of the contextual help tab.
  • strHelpTabID - the id of the contextual help tab.
  • strHelpTabContent - the HTML string content of the the contextual help tab.
  • strHelpTabSidebarContent - ( optional ) the HTML string content of the sidebar of the contextual help tab.

Example

$this->addHelpTab( array( 'strPageSlug' => 'first_page', // ( mandatory ) // 'strPageTabSlug' => null, // ( optional ) 'strHelpTabTitle' => 'Admin Page Framework', 'strHelpTabID' => 'admin_page_framework', // ( mandatory ) 'strHelpTabContent' => __( 'This contextual help text can be set with the addHelpTab() method.', 'admin-page-framework' ), 'strHelpTabSidebarContent' => __( 'This is placed in the sidebar of the help pane.', 'admin-page-framework' ), ) );

Parameters

array $arrHelpTab

The help tab array. The key structure is explained in the description part.

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