Admin Page Framework Documentation
  • Package
  • Class
  • Tree

Packages

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

Classes

  • AdminPageFramework_MetaBox_Page
  • AdminPageFramework_MetaBox_Page_Controller

Class AdminPageFramework_MetaBox_Page_Documentation

Provides an abstract base class to create meta boxes in generic admin pages created by the framework.

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 afther 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 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_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.
Abstract
Package: AdminPageFramework\PageMetaBox
Since: 3.3.0
Heading: Page Meta Box
Located at _document/AdminPageFramework_MetaBox_Page_Documentation.php
Admin Page Framework Documentation generated by ApiGen 2.8.0