Extending WordPress Options API, read options from places other than database, the OOP way

wordpress, wp, wordpress-development, wordpress-php-library


WP Option Store

Latest Stable Version Total Downloads Build Status codecov Scrutinizer Code Quality PHP Versions Tested StyleCI License Donate via PayPal Hire Typist Tech

Extending WordPress Options API, read options from places other than database, the OOP way.

The Goals, or What This Package Does?

WordPress Option API only allows you get_option from database. This package is for those who not accepting the status quo.


Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/.

$ composer require typisttech/wp-option-store

You should put all WP Option Store classes under your own namespace to avoid class name conflicts.



use TypistTech\WPOptionStore\Factory;

// By default, the `Factory` adds 2 strategies (order matters):
//  1. ConstantStrategy
//  2. DatabaseStrategy
$filteredOptionStore = Factory::build();

// To get an option from strategies:
//  1. Read `MY_OPTION` constant
//  2. If (1) is not `null`, jump to (6)
//  3. Read from `get_option('my_option')`, the normal WordPress Options API
//  4. If (3) is not `null`, jump to (6)
//  5. We have tried all strategies, pass `null` to (6)
//  6. Pass whatever we have read (could be null) through `apply_filters('my_option', $whateverWeHaveRead);`

// To get an option and perform type cast.


This strategy gets options from PHP constants.

define('MY_OPTION', 'abc123');

$strategy = new ConstantStrategy();

$value1 = $strategy->get('my_option');
// $value1 === 'abc123';

$value2 = $strategy->get('my_non_exist_option');
// $value2 === null;


This strategy gets options from WordPress Options API.

update_option('my_option', 'abc123');

$strategy = new DatabaseStrategy();

$value1 = $strategy->get('my_option');
// $value1 === 'abc123';

$value2 = $strategy->get('my_non_exist_option');
// $value2 === null;

Important: An unset value should be null instead of WordPress' default false.


This class gets option values from strategies.

__construct(StrategyInterface ...$strategies)

OptionStore constructor.

  • @param StrategyInterface[] ...$strategies Strategies that get option values.
$databaseStrategy = new DatabaseStrategy();
$constantStrategy = new ConstantStrategy();
$optionStore = new OptionStore($constantStrategy, $databaseStrategy);

Note: Strategies order matters!

get(string $optionName)

Get an option value.

  • @param string $optionName Name of option to retrieve.
// It returns the first non-null value from strategies.
define('MY_OPTION', 'abc');
update_option('my_option', 'xyz');

$value1 = $optionStore->get('my_option');
// $value1 === 'abc';

// It returns `null` when option not found.
$value2 = $optionStore->get('my_non_exist_option');
// $value2 === null;

Type casting

OptionStore provides several helper methods for type casting.



This is a subclass of OptionStore.

get(string $optionName)

Get an option value.

  • @param string $optionName Name of option to retrieve.
// It returns the first non-null value from strategies,
// and applies filters.
define('MY_OPTION', 'abc');
update_option('my_option', 'xyz');

add_filter('my_option', function($value) {
    return 'filtered ' . $value;

$value = $filteredOptionStore->get('my_option');
// $value === 'filtered abc';

Note: Filters are applied before type casting.


Factory is a helper class to reduce boilerplate code for those who use default strategies. If you use a custom strategy or reorder the strategies, don't use this class.

build(): FilteredOptionStore

$filteredOptionStore = Factory::build();

Frequently Asked Questions

Can I implement my own strategy classes?

Of course! Just implements the StrategyInterface.

Take a look at classes ConstantStrategy and DatabaseStrategy as well as their tests for example implementations of StrategyInterface.

If you'd like to create a open-source package to do this to help others, open a new issue to let us know, we'd love to help you with it.

Can I change the order of the strategies?

Why not? Don't use Factory.

// Order matters!
$optionStore = new FilteredOptionStore(
    new MyStrategy1(),
    new MyStrategy2(),
    new MyStrategy3(),

Is this a plugin?

No, this is a package that should be part of your plugin.

What to do when wp.org plugin team tell me to clean up the vendor folder?

Re-install packages via the following command. This package exports only necessary files to dist.

$ composer install --no-dev --prefer-dist --optimize-autoloader

Can two different plugins use this package at the same time?

Yes, if put all WP Option Store classes under your own namespace to avoid class name conflicts.

Do you have real life examples that use this package?

Here you go:

Add your own plugin here


Love wp-option-store? Help me maintain it, a donation here can help with it.

Why don't you hire me?

Ready to take freelance WordPress jobs. Contact me via the contact form here or, via email info@typist.tech

Want to help in other way? Want to be a sponsor?

Contact: Tang Rufus


To setup a developer workable version you should run these commands:

$ composer create-project --keep-vcs --no-install typisttech/wp-option-store:dev-master
$ cd wp-option-store
$ composer install

Running the Tests

WP Option Store run tests on Codeception and relies wp-browser to provide WordPress integration. Before testing, you have to install WordPress locally and add a codeception.yml file. See *.suite.example.yml for Local by Flywheel configuration examples.

Actually run the tests:

$ composer test

We also test all PHP files against PSR-2: Coding Style Guide and part of the WordPress coding standard.

Check the code style with $ composer check-style.


Please provide feedback! We want to make this package useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small.

Change log

Please see CHANGELOG for more information on what has changed recently.


If you discover any security related issues, please email wp-option-store@typist.tech instead of using the issue tracker.


Please see CONTRIBUTING and CODE_OF_CONDUCT for details.


WP Option Store is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.

Full list of contributors can be found here.


WP Option Store is licensed under the GPLv2 (or later) from the Free Software Foundation. Please see License File for more information.