Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_TaxonomyField

Class AdminPageFramework_TaxonomyField

Provides methods for creating fields in the taxonomy page (edit-tags.php).

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_TaxonomyField
Abstract
Package: AdminPageFramework\TaxonomyField
Since: 3.0.0
Extends: AdminPageFramework_Factory
Located at factory/AdminPageFramework_TaxonomyField/AdminPageFramework_TaxonomyField.php

Methods summary

public
# __construct( array|string $asTaxonomySlug, string $sOptionKey = '', string $sCapability = 'manage_options', string $sTextDomain = 'admin-page-framework' )

Constructs the class object instance of AdminPageFramework_TaxonomyField.

Handles setting up properties and hooks.

Examples

new APF_TaxonomyField( 'apf_sample_taxonomy' ); // taxonomy slug

Parameters

$asTaxonomySlug
array|string
The taxonomy slug(s). If multiple slugs need to be passed, enclose them in an array and pass the array.
$sOptionKey
string
The option key used for the options table to save the data. By default, the instantiated class name will be applied.
$sCapability
string
The access rights. Default: manage_options.
$sTextDomain
string
The text domain. Default: admin-page-framework.

Since

3.0.0

Overrides

AdminPageFramework_Factory_View::__construct
public
# setUp( )

The set up method.

Since

3.0.0

Remark

should be overridden by the user definition class.

Overrides

AdminPageFramework_Factory_Controller::setUp
protected
# _setOptionArray( mixed $iTermID = null, mixed $sOptionKey )

Sets the $aOptions property array in the property object.

This array will be referred later in the getFieldOutput() method.

Since

unknown
3.0.0 the scope is changed to protected as the taxonomy field class redefines it. #internal

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