Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_NetworkAdmin

Class AdminPageFramework_NetworkAdmin

The factory class that creates network admin pages.

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_Base
Extended by AdminPageFramework_Page_MetaBox
Extended by AdminPageFramework_Page
Extended by AdminPageFramework_Menu
Extended by AdminPageFramework_Setting_Base
Extended by AdminPageFramework_Setting_Port
Extended by AdminPageFramework_Setting_Validation
Extended by AdminPageFramework_Setting
Extended by AdminPageFramework
Extended by AdminPageFramework_NetworkAdmin
Abstract
Package: AdminPageFramework\NetworkAdmin\Page
Since: 3.1.0
Extends: AdminPageFramework
Remark: This class stems from several abstract classes.
Located at factory/AdminPageFramework_NetworkAdmin/AdminPageFramework_NetworkAdmin.php

Methods summary

public
# __construct( string $sOptionKey = null, string $sCallerPath = null, string $sCapability = 'manage_network', string $sTextDomain = 'admin-page-framework' )

Registers necessary callbacks ans sets up internal components including properties.

Registers necessary callbacks ans sets up internal components including properties.

Example

if ( is_admin() )
    new MyAdminPageClass( 'my_custom_option_key', __FILE__ );

Parameters

$sOptionKey
string
$sOptionKey ( optional ) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used.
$sCallerPath
string
$sCallerPath ( optional ) used to retrieve the plugin/theme details to auto-insert the information into the page footer.
$sCapability
string
$sCapability ( optional ) sets the overall access level to the admin pages created by the framework. The used capabilities are listed here. The capability can be set per page, tab, setting section, setting field. Default: manage_options
$sTextDomain
string
$sTextDomain ( optional ) the text domain used for the framework's system messages. Default: admin-page-framework.

Returns


returns nothing.

Since

3.1.0

See

http://codex.wordpress.org/Roles_and_Capabilities
http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains

Overrides

AdminPageFramework::__construct
public static mixed
# getOption( string $sOptionKey, string $asKey = null , mixed $vDefault = null )

Retrieves the saved option value from the given option key and the dimensional array key representation.

Retrieves the saved option value from the given option key and the dimensional array key representation.

Example

$aData = AdminPageFramework::getOption( 'APF' );
$aSection = AdminPageFramework::getOption( 'APF', 'my_section' );
$sText = AdminPageFramework::getOption( 'APF', array( 'my_section', 'my_text_field' ), 'foo' );
$sColor = AdminPageFramework::getOption( 'APF', 'my_color_field', '#FFF' );

Parameters

$sOptionKey
string
$sOptionKey the option key of the options table.
$asKey
string
$asKey the representation of dimensional array keys. If the returning option structure is like the following, array( 'a' => array( 'b' => array( 'c' => 'ccc', ), ), ) then the value 'ccc' can be retrieved with the key representation array of array( 'a', 'b', 'c' )
$vDefault
mixed
$vDefault the default value that will be returned if nothing is stored.

Returns

mixed
If the field ID is not specified

Since

3.1.0

Overrides

AdminPageFramework::getOption

Methods inherited from AdminPageFramework

addHelpTab(), addLinkToPluginDescription(), addLinkToPluginTitle(), enqueueScript(), enqueueScripts(), enqueueStyle(), enqueueStyles(), setAdminNotice(), setCapability(), setDisallowedQueryKeys(), setFooterInfoLeft(), setFooterInfoRight(), setPluginSettingsLinkLabel(), setUp()

Methods inherited from AdminPageFramework_Setting

addSettingField(), addSettingFields(), addSettingSection(), addSettingSections(), getFieldValue(), removeSettingFields(), removeSettingSections()

Methods inherited from AdminPageFramework_Setting_Validation

_doValidationCall(), _handleSubmittedData()

Methods inherited from AdminPageFramework_Setting_Port

_exportOptions(), _importOptions()

Methods inherited from AdminPageFramework_Setting_Base

_replyToCheckRedirects(), _replyToGetFieldOutput(), _replyToGetSectionHeaderOutput(), _replyToRegisterSettings()

Methods inherited from AdminPageFramework_Menu

addSubMenuItem(), addSubMenuItems(), setRootMenuPage(), setRootMenuPageBySlug()

Methods inherited from AdminPageFramework_Page

_replyToFinalizeInPageTabs(), addInPageTab(), addInPageTabs(), setInPageTabTag(), setInPageTabsVisibility(), setPageHeadingTabTag(), setPageHeadingTabsVisibility(), setPageTitleVisibility()

Methods inherited from AdminPageFramework_Page_MetaBox

_getNumberOfColumns(), _printMetaBox(), _replyToAddMetaboxScript(), _replyToEnableMetaBox(), _replyToReturnDefaultNumberOfScreenColumns(), _replyToSetNumberOfScreenLayoutColumns()

Methods inherited from AdminPageFramework_Base

__call(), _doPageLoadCall(), _isInThePage(), _isInstantiatable(), _sortByOrder(), addSubMenuLink(), addSubMenuPage(), addSubMenuPages()

Methods inherited from AdminPageFramework_Factory_Controller

addHelpText(), hasSettingNotice(), setFieldErrors(), setSettingNotice()

Methods inherited from AdminPageFramework_Factory_View

_replyToPrintSettingNotice()

Methods inherited from AdminPageFramework_Factory_Model

_setUp()

Methods inherited from AdminPageFramework_Factory_Router

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

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_Setting_Base

$_sFieldsType, $_sTargetPageSlug, $_sTargetSectionTabSlug, $_sTargetTabSlug, $aFieldErrors

Properties inherited from AdminPageFramework_Base

$_aHookPrefixes, $oProp

Admin Page Framework Documentation API documentation generated by ApiGen 2.8.0