Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_MetaBox
  • AdminPageFramework_MetaBox_Controller
  • AdminPageFramework_MetaBox_Model
  • AdminPageFramework_MetaBox_Router
  • AdminPageFramework_MetaBox_View

Class AdminPageFramework_MetaBox

Provides methods for creating meta boxes for post types.

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_Router
Extended by AdminPageFramework_MetaBox_Model
Extended by AdminPageFramework_MetaBox_View
Extended by AdminPageFramework_MetaBox_Controller
Extended by AdminPageFramework_MetaBox
Abstract
Package: AdminPageFramework\MetaBox
Since: 2.0.0
Located at factory/AdminPageFramework_MetaBox/AdminPageFramework_MetaBox.php

Methods summary

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

Constructs the class object instance of AdminPageFramework_MetaBox.

Sets up properties and hooks.

Example

new APF_MetaBox_BuiltinFieldTypes(
    'sample_custom_meta_box', // meta box ID
    __( 'Demo Meta Box with Built-in Field Types', 'admin-page-framework-demo' ), // title
    array( 'apf_posts' ), // post type slugs: post, page, etc.
    'normal', // context (what kind of metabox this is)
    'default' // priority
);

Parameters

$sMetaBoxID
string
$sMetaBoxID The meta box ID. [3.3.0+] If an empty value is passed, the ID will be automatically generated and the lower-cased class name will be used.
$sTitle
string
$sTitle The meta box title.
$asPostTypeOrScreenID
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
$sPriority (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

2.0.0

See

http://codex.wordpress.org/Function_Reference/add_meta_box#Parameters

Overrides

AdminPageFramework_MetaBox_Router::__construct

Methods inherited from AdminPageFramework_MetaBox_Controller

enqueueScript(), enqueueScripts(), enqueueStyle(), enqueueStyles(), setUp()

Methods inherited from AdminPageFramework_MetaBox_View

content()

Methods inherited from AdminPageFramework_MetaBox_Model

_replyToFilterSavingData(), _replyToModifyRedirectPostLocation(), _setUpValidationHooks()

Methods inherited from AdminPageFramework_Factory_Controller

addHelpText(), addSettingField(), addSettingFields(), addSettingSection(), addSettingSections(), hasFieldError(), hasSettingNotice(), setFieldErrors(), setSettingNotice()

Methods inherited from AdminPageFramework_Factory_View

_replyToGetFieldOutput(), _replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

_getFieldErrors(), _isValidationErrors(), _loadDefaultFieldTypeDefinitions(), _registerFields(), _replyToDeleteFieldErrors(), _replyToSaveFieldErrors(), _replyToSaveNotices(), _setLastInput(), _setUp(), getFieldErrors(), getSavedOptions(), validate()

Methods inherited from AdminPageFramework_Factory_Router

__call(), __get(), __toString(), _getFormInstance(), _getHelpPaneInstance(), _getLinkInstancce(), _getPageLoadInfoInstance(), _getResourceInstance(), _isInThePage(), _isInstantiatable(), _replyToLoadComponents()

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_Factory_Router

$oProp

Admin Page Framework Documentation generated by ApiGen 2.8.0