Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

  • AdminPageFramework
    • Factory
    • FieldType
    • MetaBox
    • NetworkAdmin
      • Page
    • Page
    • PageMetaBox
    • PostType
    • TaxonomyField
    • Widget

Classes

  • AdminPageFramework_MetaBox_Page
  • AdminPageFramework_MetaBox_Page_Controller
  • AdminPageFramework_MetaBox_Page_Model
  • AdminPageFramework_MetaBox_Page_Router
  • AdminPageFramework_MetaBox_Page_View

Class AdminPageFramework_MetaBox_Page_Model

Provides model 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
Extended by AdminPageFramework_MetaBox_Page_Model

Direct known subclasses

AdminPageFramework_MetaBox_Page_View

Indirect known subclasses

AdminPageFramework_MetaBox_Page, AdminPageFramework_MetaBox_Page_Controller

Abstract
Package: AdminPageFramework\PageMetaBox
Since: 3.0.4
Located at factory/AdminPageFramework_MetaBox_Page/AdminPageFramework_MetaBox_Page_Model.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' )

Sets up properties and hooks.

Sets up properties and hooks.

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_Page_Router::__construct
public
# _replyToFilterPageOptions( array $aPageOptions )

Filters the page option array.

Filters the page option array.

This is triggered from the system validation method of the main Admin Page Framework factory class with the validation_saved_options_{page slug} filter hook.

Parameters

$aPageOptions
array

Since

3.0.0

Methods inherited from AdminPageFramework_MetaBox_Page_Router

_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(), hasSettingNotice(), setFieldErrors(), setSettingNotice(), setUp()

Methods inherited from AdminPageFramework_Factory_View

_replyToGetFieldOutput(), _replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

_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