Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_TaxonomyField

Class AdminPageFramework_TaxonomyField

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

Hooks

The class automatically creates WordPress action and filter hooks associated with the class methods. The class methods corresponding to the name of the below actions and filters can be extended to modify the page output. Those methods are the callbacks of the filters and actions.

Methods and Action Hooks

  • start_{instantiated class name} – triggered at the end of the class constructor.
  • do_{instantiated class name} – triggered when the meta box gets rendered. The first parameter: the class object [3.1.3+].

Methods and Filter Hooks

  • field_types_{instantiated class name} – receives the field type definition array. The first parameter: the field type definition array.
  • field_{instantiated class name}_{field ID} – receives the form input field output of the given input field ID. The first parameter: output string. The second parameter: the array of option.
  • content_{instantiated class name} – receives the entire output of the meta box. The first parameter: the output HTML string.
  • style_common_{instantiated class name} – receives the output of the base CSS rules applied to the pages of the associated post types with the meta box.
  • style_ie_common_{instantiated class name} – receives the output of the base CSS rules for Internet Explorer applied to the pages of the associated post types with the meta box.
  • style_{instantiated class name} – receives the output of the CSS rules applied to the pages of the associated post types with the meta box.
  • style_ie_{instantiated class name} – receives the output of the CSS rules for Internet Explorer applied to the pages of the associated post types with the meta box.
  • script_common_{instantiated class name} – receives the output of the base JavaScript scripts applied to the pages of the associated post types with the meta box.
  • script_{instantiated class name} – receives the output of the JavaScript scripts applied to the pages of the associated post types with the meta box.
  • validation_{instantiated class name} – receives the form submission values as array. The first parameter: submitted input array. The second parameter: the original array stored in the database.
  • columns_{taxonomy slug} – receives the header columns array. The first parameter: the header columns array.
  • columns_{instantiated class name} – receives the header sortable columns array. The first parameter: the header columns array.
  • sortable_columns_{taxonomy slug} – receives the header sortable columns array. The first parameter: the header columns array.
  • sortable_columns_{instantiated class name} – receives the header columns array. The first parameter: the header columns array.
  • cell_{taxonomy slug} – receives the cell output of the term listing table. The first parameter: the output string. The second parameter: the column slug. The third parameter: the term ID.
  • cell_{instantiated class name} – receives the cell output of the term listing table. The first parameter: the output string. The second parameter: the column slug. The third parameter: the term ID.
  • cell_{instantiated class name}_{column slug} – receives the cell output of the term listing table. The first parameter: the output string. The second parameter: the term ID.
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
Use: AdminPageFramework_Utility
Use: AdminPageFramework_Message
Use: AdminPageFramework_Debug
Use: AdminPageFramework_Property_MetaBox
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.

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.

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.

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(), enqueueScript(), enqueueScripts(), enqueueStyle(), hasSettingNotice(), setFieldErrors(), setSettingNotice()

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(), _isInstantiatable(), _replyToLoadComponents()

Magic methods summary

Properties summary

Properties inherited from AdminPageFramework_Factory_Router

$oProp

Admin Page Framework Documentation API documentation generated by ApiGen 2.8.0