WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Admin Page Framework

Provides simpler means of building administration pages for plugin and theme developers.

It provides plugin and theme developers with easier means of creating option pages. Extend the library class and pass your arrays that define the form elements to the predefined class methods. The library handles all the complex coding behind the scene and creates the pages and the forms for you. The package includes a demo plugin which helps you walk through necessary features.

Notes: this framework does not do anything by itself. If you are not a developer, you do not need this.

Features

  • Root Page, Sub Pages, and Tabs - it allows you to instantly create a top level page and the sub pages of it, plus tabs inside the sub pages.
  • Extensible - the created admin pages will become highly extensible with the automatically created hooks. In other words, it empowers other developers to customize your plugin or theme. That will result on making your projects grow.
  • Import and Export Options - buttons that the user can import and export settings by uploading and downloading text files.
  • Image Upload - it lets the user easily upload images to the site or the user can choose from existent urls or already uploaded files.
  • Color Picker - it lets the user easily pick colors.
  • Rich Text Editor - supports the rich text editor form input.
  • Section Tabs - Form sections can be displayed in a tabbed box.
  • Repeatable Sections and Fields - supports repeatable form sections and fields.
  • Sortable Fields - supports sortable fields.
  • Reset Button - create a reset button that lets your users to initialize the saved options.
  • Validation and Error Messages - with the pre-defined validation callbacks, the user's submitting data can be verified as a part of using the Settings API. Furthermore, by setting the error array, you can display the error message to the user.
  • Custom Post Types - the framework provides methods to create custom post types.
  • Meta Boxes - the framework provides methods to create custom meta boxes with form elements that you define.
  • Taxonomy Fields - the framework provides methods to add fields in the taxonomy definition page.
  • Contextual Help Pane - help contents can be added to the contextual help pane that appears at the top right of each screen.
  • Custom Field Types - your own field type can be registered.

Built-in Field Types

  • text - a normal field to enter text input.
  • password - a masked text input field.
  • textarea - a text input field with multiple lines. It supports rich text editor.
  • radio - a set of radio buttons that lets the user pick an option.
  • checkbox - a check box that lets the user enable/disable an item.
  • select - a drop-down list that lest the user pick one or more item(s) from a list.
  • hidden - a hidden field that will be useful to insert invisible values.
  • file - a file uploader that lets the user upload files.
  • image - a custom text field with the image uploader script that lets the user set the image URL.
  • media - a custom text field with the media uploader script that lets the user set the file URL.
  • color - a custom text field with the color picker script.
  • submit - a submit button that lets the user send the form.
  • export - a custom submit field that lets the user export the stored data.
  • import - a custom combination field of the file and the submit fields that let the user import data.
  • posttype - a set of check-lists of taxonomies enabled on the site in a tabbed box.
  • taxonomy - check-lists of taxonomies enabled on the site in a tabbed box.
  • size - a combination field of the text and the select fields that let the user set sizes with a selectable unit.
  • section_title - a text field type that will be placed in the section title so that it lets the user set the section title.

Custom Field Types

You can include your own custom field types when they are necessary. The reason that they are not built-in is to keep the library size as small as possible. The example custom field types are included in the demo plugin.

  • geometry - a location selector with the Google map.
  • date, time, date_time - date and time fields with the date picker.
  • dial - a dial input field.
  • font - a font uploader and its preview.
  • revealer - a selector field that displays a hidden HTML element.
  • grid - a drag and drop grid composer.
  • autocomplete - a custom text field that shows a predefined pop-up autocomplete list.

Necessary Files

  • admin-page-framework.min.php is in the library folder. Alternatively you may use admin-page-framework.php located in the development folder. In that case, all the class files in the sub-folders need to be copied.

Documentation

The HTML documentation is included in the distribution package and can be accessed via the sidebar menu that the demo plugin creates.

Tutorials

Index

  1. Create an Admin Page
  2. Create a Form
  3. Create a Page Group
  4. Create In-page Tabs
  5. Organize a Form with Sections
  6. Use Section Tabs and Repeatable Sections

Requires: 3.3 or higher
Compatible up to: 3.9.1
Last Updated: 2014-5-10
Downloads: 8,071

Ratings

4 stars
4.6 out of 5 stars

Support

4 of 6 support threads in the last two months have been resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

1 person says it works.
0 people say it's broken.

100,1,1 100,1,1 100,1,1 100,1,1 100,1,1
100,1,1
100,2,2 100,1,1 100,1,1
100,1,1 100,1,1 100,1,1
100,1,1
100,1,1
100,1,1 100,1,1 100,1,1 100,1,1
100,1,1 100,1,1
100,3,3 100,1,1 100,1,1
100,1,1
100,1,1