ernilambar/optiz

Lightweight schema-driven settings framework for WordPress

1.0.0 2026-05-09 16:00 UTC

Requires

• php: >=8.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^1
• ernilambar/coding-standard: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.4
• phpcompatibility/php-compatibility: ^10@alpha
• phpunit/phpunit: ^9.6 || ^10 || ^11
• slevomat/coding-standard: ^8.22
• squizlabs/php_codesniffer: ^3.13
• wp-coding-standards/wpcs: ^3.3

MIT

• Nilambar Sharma

• framework
• admin
• schema
• wordpress
• options
• Settings

README

Lightweight schema-driven settings framework for WordPress. Plugins bundle this library to generate admin settings pages from a PHP array — no UI builder required.

Requirements

• PHP 8.0+
• WordPress 6.0+

Installation

composer require ernilambar/optiz

Include the entry point in your plugin bootstrap before plugins_loaded:

require_once __DIR__ . '/vendor/ernilambar/optiz/init.php';

When multiple plugins bundle different versions, init.php automatically elects the highest version — only one copy runs.

Quick start

Register the schema on init (or later). Registering earlier — e.g. on plugins_loaded — calls __() before WordPress is ready to load translations and triggers a _doing_it_wrong notice in WP 6.7+.

add_action( 'init', function () {
    \Nilambar\Optiz\Manager::register( 'my_plugin', [
        'option_key' => 'my_plugin_options',
        'page'       => [
            'title'     => __( 'My Plugin', 'textdomain' ),
            'menu_slug' => 'my-plugin-settings',
        ],
        'tabs' => [
            [
                'id'     => 'general',
                'label'  => __( 'General', 'textdomain' ),
                'fields' => [
                    [
                        'id'      => 'api_key',
                        'type'    => 'text',
                        'label'   => __( 'API Key', 'textdomain' ),
                        'default' => '',
                    ],
                    [
                        'id'      => 'enable_feature',
                        'type'    => 'toggle',
                        'label'   => __( 'Enable Feature', 'textdomain' ),
                        'default' => false,
                    ],
                ],
            ],
        ],
    ] );
} );

Read a saved value anywhere in the plugin:

$value = \Nilambar\Optiz\Manager::instance( 'my_plugin' )->get( 'api_key' );

Documentation

See docs/DOCS.md for the full reference: schema, all field types, type-specific options, sanitization, conditional fields, and the Manager API.

License

MIT