WordPress settings framework for easily creating plugin and theme options pages. Includes 30+ field types such as AJAX relational fields, date pickers, and media uploaders.

Stop fighting the WordPress Settings API. This framework provides a modern, object-oriented, and fluent API that streamlines the creation of powerful and maintainable settings pages.

Create anything from a simple plugin options page to a complex, tabbed interface for a theme, all with the same clean API.

A single page with one or more sections of fields. Perfect for most plugins.

Organize a large number of settings into a clean, tabbed interface, complete with Dashicons for a native WordPress feel.

• ✅ Declarative & Fluent API: Define entire pages with a clean, chainable API that is easy to read and version control.
• 🚀 Comprehensive Field Library: Over 30 field types included, from basic inputs to advanced AJAX-powered relationship pickers.
• 🧠 Built-in Conditional Logic: Show or hide fields based on other fields' values without writing a single line of JavaScript.
• ⚙️ Intelligent Asset Loading: CSS and JS are loaded only when a field that needs them is used, keeping your admin pages lightweight and fast.
• ⚡ High-Performance Relational Fields: Add searchable fields for Posts, Users, and Terms that load data via AJAX, ensuring excellent performance even on sites with thousands of entries.
• 🔒 Secure by Default: Built-in sanitization for all standard field types and secure handling for sensitive data like password fields (values are never rendered in the HTML).
• 🧩 Truly Extensible: Designed from the ground up to be extended. Register your own custom field types to meet any project requirement.

The framework follows a simple and memorable pattern:

1. create(): Get a Settings_Builder instance and create a new Settings_Page.
2. configure(): Use the fluent methods (set_page_title, add_section, add_field, etc.) to define the entire structure and content of your page.
3. init(): Make one final call to init() to build the page and register all the necessary hooks with WordPress.

Install via Composer into your plugin or theme:

composer require wptechnix/wp-settings-builder

Ensure your project includes the Composer autoloader:

require_once __DIR__ . '/vendor/autoload.php';

This example creates a settings page with three powerful fields and shows how to retrieve a saved value.

<?php use WPTechnix\WP_Settings_Builder\Settings_Builder; // 1. CREATE: Get a builder and create a page instance. $page = ( new Settings_Builder() )->create( 'my_plugin_options', 'my-plugin-settings' ); // 2. CONFIGURE: Define the page's location, sections, and fields. $page->set_page_title( 'My Awesome Plugin Settings' ) ->set_menu_title( 'My Plugin' ) ->set_parent_slug( 'tools.php' ); // Places it under the "Tools" menu $page->add_section( 'api_section', 'API & General Configuration' ); $page->add_field( 'api_key', 'api_section', 'password', 'Service API Key', [ 'description' => 'Your secret key is masked and protected.', ] ); $page->add_field( 'enable_feature', 'api_section', 'switch', 'Enable Awesome Feature', [ 'description' => 'Turn the main feature on or off.', 'default' => true, ] ); $page->add_field( 'featured_post', 'api_section', 'post', 'Featured Post', [ 'description' => 'Type to search for a post to feature on the homepage.', 'query_args' => [ 'post_type' => 'post' ], ] ); // 3. INITIALIZE: Build the page and register all WordPress hooks. $page->init();

To use a saved setting elsewhere in your code:

use WPTechnix\WP_Settings_Builder\Settings_Builder; $settings_page = Settings_Builder::get_instance( 'my-plugin-settings' ); if ( $settings_page ) { $featured_post_id = $settings_page->get_setting( 'featured_post', 0 ); if ( $featured_post_id > 0 ) { // Now you can use this ID in a WP_Query or get_post(). $post_title = get_the_title( $featured_post_id ); } }

This is a quick reference for all available field types. For detailed options and examples, see the full documentation guides.

For a deep dive into every feature and method, please see the full documentation.

• Core Concepts
  • Introduction
  • Getting Started
  • Settings Page Configuration
• Field Guides
  • Basic Inputs
  • Choice and Toggles
  • Content and Media
  • Date and Time
  • Relational (AJAX)
• Advanced Topics
  • Conditional Logic
  • Advanced Guide: Creating Custom Fields
  • Helpers and Methods

Contributions are welcome! Please feel free to open a pull request or submit an issue on the GitHub repository with your suggestions or bug reports.

This project is licensed under the MIT License. See the LICENSE file for details.