Class AdminPageFramework_Page_Controller
Provides methods to manipulate how admin pages are displayed.
- AdminPageFramework_Factory_Router
-
AdminPageFramework_Factory_Model
-
AdminPageFramework_Factory_View
-
AdminPageFramework_Factory_Controller
-
AdminPageFramework_Factory
-
AdminPageFramework_Router
-
AdminPageFramework_Form_Model_Port
-
AdminPageFramework_Form_Model_Validation
-
AdminPageFramework_Form_Model
-
AdminPageFramework_Form_View
-
AdminPageFramework_Form_Controller
-
AdminPageFramework_Page_Model
-
AdminPageFramework_Page_View_MetaBox
-
AdminPageFramework_Page_View
-
AdminPageFramework_Page_Controller
Direct known subclasses
Indirect known subclasses
AdminPageFramework
,
AdminPageFramework_Menu_Controller
,
AdminPageFramework_Menu_View
,
AdminPageFramework_NetworkAdmin
Package: AdminPageFramework\AdminPage
Since: 3.3.1
Extends: AdminPageFramework_Page_View
Located at factory/AdminPageFramework/AdminPageFramework_Page_Controller.php
Methods summary
public
|
#
addInPageTabs( array $aTab1, array $aTab2 = null, array $_and_more = null )
Adds in-page tabs. The parameters accept in-page tab arrays and they must have the following array keys. Example$this->addInPageTabs( array( 'page_slug' => 'myfirstpage' 'tab_slug' => 'firsttab', 'title' => __( 'Text Fields', 'my-text-domain' ), ), array( 'page_slug' => 'myfirstpage' 'tab_slug' => 'secondtab', 'title' => __( 'Selectors and Checkboxes', 'my-text-domain' ), ) ); $this->addInPageTabs( 'myfirstpage', // sets the target page slug array( 'tab_slug' => 'firsttab', 'title' => __( 'Text Fields', 'my-text-domain' ), ), array( 'tab_slug' => 'secondtab', 'title' => __( 'Selectors and Checkboxes', 'my-text-domain' ), ) ); Parameters
Since
2.0.0
3.0.0 Changed the scope to public. Added page slug target support. 3.3.1 Moved from AdminPageFramework_Page .Remark
Accepts variadic parameters; the number of accepted parameters are not limited
to three.
In-page tabs are different from page-heading tabs which is automatically added with page titles. |
public
|
#
addInPageTab( array|string $asInPageTab )
Adds an in-page tab. The singular form of the Parameters
Since
2.0.0
3.0.0 Changed the scope to public. 3.3.1 Moved from AdminPageFramework_Page .Remark
Use this method to add in-page tabs to ensure the array holds all the necessary
keys.
In-page tabs are different from page-heading tabs which are automatically added with page titles. |
public
|
#
setPageTitleVisibility( boolean $bShow = true, mixed $sPageSlug = '' )
Sets whether the page title is displayed or not. Example$this->setPageTitleVisibility( false ); // disables the page title. Parameters
Since
2.0.0
3.0.0 Changed the scope to public. 3.3.1 Moved from AdminPageFramework_Page . |
public
|
#
setPageHeadingTabsVisibility( boolean $bShow = true, string $sPageSlug = '' )
Sets whether page-heading tabs are displayed or not. Example$this->setPageHeadingTabsVisibility( false ); // disables the page heading tabs by passing false. Parameters
Since
2.0.0
3.0.0 Changed the scope to public. 3.3.1 Moved from AdminPageFramework_Page .Remark
Page-heading tabs and in-page tabs are different. The former displays page
titles and the latter displays tab titles.
If the second parameter is omitted, it sets the default value. |
public
|
#
setInPageTabsVisibility( boolean $bShow = true, string $sPageSlug = '' )
Sets whether in-page tabs are displayed or not. Sometimes, it is required to disable in-page tabs in certain pages. In that case, use the second parameter. Parameters
Since
2.1.1
3.0.0 Changed the scope to public. Changed the name from showInPageTabs() to setInPageTabsVisibility() .3.3.1 Moved from AdminPageFramework_Page .Remark
If the second parameter is omitted, it sets the default value.
|
public
|
#
setInPageTabTag( string $sTag = 'h3', string $sPageSlug = '' )
Sets in-page tab's HTML tag. Example$this->setInPageTabTag( 'h2' ); Parameters
Since
2.0.0
3.0.0 Changed the scope to public. 3.3.1 Moved from AdminPageFramework_Page .Remark
If the second parameter is omitted, it sets the default value.
|
public
|
#
setPageHeadingTabTag( string $sTag = 'h2', string $sPageSlug = '' )
Sets page-heading tab's HTML tag. Example$this->setPageHeadingTabTag( 'h2' ); Parameters
Since
2.1.2
3.0.0 Changed the scope to public. 3.3.1 Moved from AdminPageFramework_Page .Remark
If the second parameter is omitted, it sets the default value.
|
Methods inherited from AdminPageFramework_Page_View_MetaBox
__construct()
,
_getNumberOfColumns()
,
_printMetaBox()
,
_replyToAddMetaboxScript()
,
_replyToEnableMetaBox()
,
_replyToReturnDefaultNumberOfScreenColumns()
,
_replyToSetNumberOfScreenLayoutColumns()
Methods inherited from AdminPageFramework_Form_Controller
addSettingField()
,
addSettingFields()
,
addSettingSection()
,
addSettingSections()
,
getValue()
,
removeSettingFields()
,
removeSettingSections()
Methods inherited from AdminPageFramework_Form_View
_replyToGetFieldOutput()
,
_replyToGetSectionHeaderOutput()
Methods inherited from AdminPageFramework_Form_Model
_replyToCheckRedirects()
,
_replyToRegisterSettings()
,
_replyToSendFormEmail()
,
getSavedOptions()
Methods inherited from AdminPageFramework_Form_Model_Validation
_handleSubmittedData()
,
_replyToRemoveConfirmationQueryKey()
,
_validateSubmittedData()
Methods inherited from AdminPageFramework_Form_Model_Port
_exportOptions()
,
_importOptions()
Methods inherited from AdminPageFramework_Router
__call()
,
_doPageLoadCall()
,
_isInThePage()
,
_isInstantiatable()
,
_sortByOrder()
Methods inherited from AdminPageFramework_Factory_Controller
addHelpText()
,
hasFieldError()
,
hasSettingNotice()
,
setFieldErrors()
,
setSettingNotice()
,
setUp()
Methods inherited from AdminPageFramework_Factory_View
_replyToPrintSettingNotice()
Methods inherited from AdminPageFramework_Factory_Model
_getFieldErrors()
,
_isValidationErrors()
,
_loadDefaultFieldTypeDefinitions()
,
_registerFields()
,
_replyToDeleteFieldErrors()
,
_replyToSaveFieldErrors()
,
_replyToSaveNotices()
,
_setLastInput()
,
_setUp()
,
getFieldErrors()
,
validate()
Methods inherited from AdminPageFramework_Factory_Router
__get()
,
__toString()
,
_getFormInstance()
,
_getHelpPaneInstance()
,
_getLinkInstancce()
,
_getPageLoadInfoInstance()
,
_getResourceInstance()
,
_replyToLoadComponents()
Magic methods summary
Properties summary
Properties inherited from AdminPageFramework_Form_Model
$_bDoneEmail
,
$_sFieldsType
,
$_sTargetPageSlug
,
$_sTargetSectionTabSlug
,
$_sTargetTabSlug
,
$aFieldErrors
Properties inherited from AdminPageFramework_Router
$_aHookPrefixes
Properties inherited from AdminPageFramework_Factory_Router
$oProp