What is this?

It’s a PHP class wrapper for handling WordPress Settings API. This is an easily accessible OOP API for developers to use in their own plugins.

Package Installation (via Composer)

To install this package, edit your composer.json file:

{
    "require": {
        "webkinder/wordpress-options-page-api": "1.0.0"
    }
}

Now run:

$ composer install

Usage Example

Checkout the examples folder for OOP and procedural example.

Retrieving saved options

/**
 * Get the value of a settings field
 *
 * @param string $option settings field name
 * @param string $section the section name this field belongs to
 * @param string $default default text if it's not found
 *
 * @return mixed
 */
function prefix_get_option( $option, $section, $default = '' ) {

    $options = get_option( $section );

    if ( isset( $options[$option] ) ) {
        return $options[$option];
    }

    return $default;
}

Screenshot

Contributing

Contributions are welcome. Send us your PR’s.

Generate the docs

cd docs && bash generate-docs.sh -d . && cd -

Frequently Asked Questions

What this plugin for?

This is an API for the WordPress Settings API

Acknowledgments

This is an extended version of tareq1988 with more features and opinionated changes and additions.

Changelog:

---

v1.0 (14 March, 2019)
------------------------
- First version published