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

Meta Box

Provides an abstract base class to create meta boxes in post editing pages.

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. This receives the class object in the first parameter.
  • set_up_{instantiated class name} – triggered after the setUp() method is called. This receives the class object in the first parameter.
  • do_{instantiated class name} – triggered when the meta box gets rendered. The first parameter: the calss 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_admin_page_framework – [3.2.1+] receives the output of the base CSS rules applied to common CSS rules shared by the framework.
  • 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.

Remarks

The slugs must not contain a dot(.) or a hyphen(-) since it is used in the callback method name.

Classes

AdminPageFramework_MetaBox Provides methods for creating meta boxes for post types.
AdminPageFramework_MetaBox_Controller Provides UI related methods.
AdminPageFramework_MetaBox_Model Handles retrieving data from the database and the submitted $_POST array.
AdminPageFramework_MetaBox_Router Handles routing of function calls and instantiation of associated classes.
AdminPageFramework_MetaBox_View Handles displaying meta box outputs.
Admin Page Framework Documentation generated by ApiGen 2.8.0