Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

  • AdminPageFramework
    • FieldType
    • MetaBox
    • NetworkAdmin
      • Page
    • Page
    • PageMetaBox
    • PostType
    • TaxonomyField
  • None

Classes

  • AdminPageFramework_MetaBox_Page
  • AdminPageFramework_MetaBox_Page_Controller
  • AdminPageFramework_MetaBox_Page_Model
  • AdminPageFramework_MetaBox_Page_Router
  • AdminPageFramework_MetaBox_Page_View

Class AdminPageFramework_MetaBox_Page_Router

Provides routing methods for creating meta boxes in pages added by the framework.

AdminPageFramework_Factory_Router
Extended by AdminPageFramework_Factory_Model
Extended by AdminPageFramework_Factory_View
Extended by AdminPageFramework_Factory_Controller
Extended by AdminPageFramework_Factory
Extended by AdminPageFramework_MetaBox_Base
Extended by AdminPageFramework_MetaBox_Page_Router

Direct known subclasses

AdminPageFramework_MetaBox_Page_Model

Indirect known subclasses

AdminPageFramework_MetaBox_Page, AdminPageFramework_MetaBox_Page_Controller, AdminPageFramework_MetaBox_Page_View

Abstract
Package: AdminPageFramework\PageMetaBox
Since: 3.0.4
Located at factory/AdminPageFramework_MetaBox_Page/AdminPageFramework_MetaBox_Page_Router.php

Methods summary

public
# __construct( string $sMetaBoxID, string $sTitle, string|array $asPageSlugs = array(), string $sContext = 'normal', string $sPriority = 'default', string $sCapability = 'manage_options', string $sTextDomain = 'admin-page-framework' )

Triggers the start_{...} action hook.

Triggers the start_{...} action hook.

Parameters

$sMetaBoxID
string
$sMetaBoxID The meta box ID.
$sTitle
string
$sTitle The meta box title.
$asPageSlugs
string|array
$asPostTypeOrScreenID ( optional ) The post type(s) or screen ID that the meta box is associated with.
$sContext
string
$sContext ( optional ) The part of the page where the edit screen section should be shown ('normal', 'advanced', or 'side') Default: normal.
$sPriority
string
$sPriority ( optional ) The priority within the context where the boxes should show ('high', 'core', 'default' or 'low') Default: default.
$sCapability
string
$sCapability ( optional ) The access level to the meta box. Default: edit_posts.
$sTextDomain
string
$sTextDomain ( optional ) The text domain applied to the displayed text messages. Default: admin-page-framework.

Since

3.0.4

Overrides

AdminPageFramework_MetaBox_Base::__construct
protected
# _isInstantiatable( )

Determines whether the meta box class components should be loaded in the currently loading page.

Determines whether the meta box class components should be loaded in the currently loading page.

Since

3.1.3

Overrides

AdminPageFramework_MetaBox_Base::_isInstantiatable

Methods inherited from AdminPageFramework_MetaBox_Base

_getInputArray(), _getSavedMetaArray(), _replyToAddMetaBox(), _replyToDetermineToLoad(), _replyToGetSectionHeaderOutput(), _replyToPrintMetaBoxContents(), _replyToRegisterFormElements(), _replyToSaveMetaBoxFields(), _setOptionArray()

Methods inherited from AdminPageFramework_Factory_Controller

addHelpText(), addSettingField(), addSettingFields(), addSettingSection(), addSettingSections(), enqueueScript(), enqueueScripts(), enqueueStyle(), enqueueStyles(), hasSettingNotice(), setFieldErrors(), setSettingNotice(), setUp(), start()

Methods inherited from AdminPageFramework_Factory_View

_replyToGetFieldOutput(), _replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

_getFieldErrors(), _isValidationErrors(), _loadDefaultFieldTypeDefinitions(), _registerFields(), _replyToDeleteFieldErrors(), _replyToSaveFieldErrors(), _replyToSaveNotices(), _setUp()

Methods inherited from AdminPageFramework_Factory_Router

__call(), __get(), _getFormInstance(), _getHeadTagInstance(), _getHelpPaneInstance(), _getLinkInstancce(), _getPageLoadInfoInstance(), _isInThePage(), _replyToLoadComponents()

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_MetaBox_Base

$_sFieldsType, $_sTargetSectionTabSlug

Properties inherited from AdminPageFramework_Factory_Router

$oProp

Admin Page Framework Documentation API documentation generated by ApiGen 2.8.0