devgeniem/wp-readonly-options

Predefine WordPress options in your code and force get_option() results.

1.2.2 2019-11-14 08:21 UTC

Requires

• php: >=7.0
• composer/installers: >=v1.0.12

GPL-2.0

• Onni Hakala

• database
• wordpress
• option
• wp
• force
• must use

README

WP Plugin: Readonly Options

Have you ever wanted to set all your options as define('PLUGIN_OPTION','some_value') in wp_config.php?

Sometimes you need to use 3rd party plugins that only gives you those options in admin pages and GUI. And now you can't use git to version control your settings as you would love to do.

This plugin helps you to set all your settings in your code and doesn't force you to go over to admin pages.

How it works

It works by allowing you to force the results of get_option() to your predefined values.

This also adds tiny amount if javascript into admin pages so that it can set readonly attributes to your options: <input readonly>. This makes it easier for the users to understand that these options can't be changed.

This only works in php7.0 version or better since we use arrays when defining constants. We also like to use scalar type hintings. Sorry legacy projects :(

Installation

Prefered installation is with composer:

{
    "require": {
        "devgeniem/wp-readonly-options": "^1.1"
    },
    "extra": {
        "installer-paths": {
          "web/app/mu-plugins/{$name}/": ["type:wordpress-muplugin"],
        },
    }
}

Code Example

My options page looks so empty and lonely:

I'll look up the keys from /wp-admin/options.php and I see that they are sm_bucket and sm_key_json.

You can also see the names by using Google Chrome inspector. Key name is same as input element ID.

I can use those keys with WP_READONLY_OPTIONS and I add the following code to my wp-config.php:

php7.0

define( 'WP_READONLY_OPTIONS', array(
    'sm_bucket' => 'my-bucket.example.com'
    'sm_key_json' => '{
      "type": "service_account",
      "project_id": "XXXXXXXXXXXXXXXXXXXXXXX",
      "private_key_id": "XXXXXXXXXXXXXXXXXXXX",
      "private_key": "-----BEGIN PRIVATE KEY-----\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      -----END PRIVATE KEY-----
    }'
));

php5.X

define( 'WP_READONLY_OPTIONS', serialize( array(
    'sm_bucket' => 'my-bucket.example.com'
    'sm_key_json' => '{
      "type": "service_account",
      "project_id": "XXXXXXXXXXXXXXXXXXXXXXX",
      "private_key_id": "XXXXXXXXXXXXXXXXXXXX",
      "private_key": "-----BEGIN PRIVATE KEY-----\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      -----END PRIVATE KEY-----
    }'
)));

Afterwise I can see the values in readonly mode:

Configuration

Disables readonly attribute setter Javascript hack. It might be incompatible with something.

define('WP_READONLY_OPTIONS_NO_JS',true);

License

GPLv2

Maintainers

@onnimonni

@villepietarinen