Admin Form Framework

Description

This plugin will help you quickly set up a standard WordPress settings page for your project, be it a theme or a plugin. That’s it!

Below is a “Hello World” piece of code to quickly get you an idea. It will generate a standard settings page with a checkbox, complete markup, save logic.

<?php 
 add_action( 'init', 'my_options_create_page', 11 );  function my_options_create_page() {   $options_page = new Aff();    // Add a checkbox   $options_page->add_field(     array(       'name'        => 'simple_checkbox',       'label'       => __( 'Is this plugin awesome?', 'textdomain' ),       'type'        => 'checkbox',       'description' => __( 'Help your users with a nice description.', 'textdomain' ),       'section'     => 'general', // Optional. Default section. You can add new ones as easily as adding a field.     )   );    // Render the page - this is mandatory   $options_page->init();  ?> 

There are a zillion options plugins out there. Why this?

All plugins will inevitably have their limitations, but Admin Form Framework is written in form of an object that can be easily extended to suit your needs. This is what we use internally at Dream Production.

Get started

For a complete example / settings page template, open up the included my_options.php file from examples folder.

Installation

  1. Upload to the /wp-content/plugins/ directory
  2. Activate the plugin through the ‘Plugins’ menu in WordPress
  3. Follow the instructions to get started with your first settings page.

FAQ

Does this plugin do anything by itself?

No. This plugin is targeted at developers of WordPress themes and plugins.

Why not use WordPress Settings API directly?

The Settings API can be difficult to use by the novice developer. Writing the settings pages means a lot of code that can be difficult to follow, and a lot of repetitive HTML code. Admin Form Framework wraps it all up and allows you to quickly add the options you need without thinking about the technicalities of defining, saving and displaying the options on the options page.

When should I not use Admin Form Framework?

If you require a lot of custom markup or advanced validation, this plugin may get in your way. However, you can easily extend the settings class with new option types that satisfy your particular needs.

Contributors & Developers

“Admin Form Framework” is open source software. The following people have contributed to this plugin.

Changelog

1.2.3

  • Added wysiwyg field type

1.2.1

  • Externalized form and form fields

1.2.0

  • Added file field type

1.1.2

  • Allow saved options to be set externaly

1.1.1

  • Multilingual options made optional

1.1

  • Added WPML compatibility.

1.0.3

  • Fixed Multisite forms.

1.0.2

  • Added single / multisite compatibility.

1.0.1

  • Fixed example and readme.

1.0

  • First public release.