Creating WordPress plugin options based on a JSON structure
Dec 11, 2024 pm 03:48 PMThe other day I was wondering how I could let WordPress plugin options be controlled by a JSON file, allowing one to more easily add additional settings in the future without having to adjust the code itself.
This article provides an example of an extremely simple WordPress plugin with a single settings pages consisting of 2 sections and 3 fields / options.
The full code can be found on Github.
Setting up the base
The plugin initially consists of 3 files.
- adventures.json
- adventures.php
- class.adventures.php
adventures.php with a basic plugin registration:
<?php /* Plugin Name: Adventures Plugin URI: https://mortenhartvig.dk Description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed pharetra nisi eu varius pellentesque. Aenean posuere, velit mollis sodales convallis, ipsum lectus feugiat nunc, ac auctor sapien enim eu metus. Version: 1 Requires at least: 6.1 Requires PHP: 8.3 Author: Morten Hartvig Author URI: https://mortenhartvig.dk License: Do whatever you want */ define('ADV__PLUGIN_DIR', plugin_dir_path(__FILE__)); define('ADV__PLUGIN_VIEW', ADV__PLUGIN_DIR . 'views'); define('ADV__PLUGIN_SLUG', 'adv'); require_once ADV__PLUGIN_DIR . 'class.adventures.php'; (new Adventures());
class.adventures.php with an empty class:
<?php class Adventures { public function __construct() { } }
adventures.json contains the JSON structure of the plugin settings:
{ "settings": { "pages": [ { "title": "Adventures", "capability": "manage_options", "slug": "adv" } ], "sections": [ { "id": "portal_base", "title": "Base configuration", "description": "Lorem 1, ipsum dolor sit amet consectetur adipisicing elit. Cumque nulla in officiis. Laborum quisquam illo eaque, deserunt facere mollitia sint doloremque maiores, obcaecati reiciendis voluptate itaque iure fugiat quia architecto!", "view": "section" }, { "id": "portal_appearance", "title": "Appearance", "description": "Lorem 2, ipsum dolor sit amet consectetur adipisicing elit. Cumque nulla in officiis. Laborum quisquam illo eaque, deserunt facere mollitia sint doloremque maiores, obcaecati reiciendis voluptate itaque iure fugiat quia architecto!", "view": "section" } ], "fields": [ { "id": "adv_portal_key", "title": "Portal Key", "section": "portal_base", "type": "text", "placeholder": "Enter your portal key", "view": "field.text" }, { "id": "adv_api_host", "title": "Host API", "section": "portal_base", "type": "text", "placeholder": "Enter API host", "default": "https://api.mortenhartvig.dk", "view": "field.text" }, { "id": "adv_portal_theme", "title": "Theme", "section": "portal_appearance", "type": "select", "options": { "rounded.v1": "Round (V1)", "squared.v1": "Square (V1)", "standard": "Standard" }, "default": "standard", "view": "field.select" } ] } }
Reading JSON data
Create a property for your settings and call set_settings():
private $settings; public function __construct() { $this->set_settings(); }
Create set_settings() and get_json_data():
private function set_settings() { $data = $this->get_json_data(); $this->settings = $data['settings']; } private function get_json_data() { $file = ADV__PLUGIN_DIR . 'adventures.json'; if (!file_exists($file)) { die('adventures.json not found'); } return json_decode(file_get_contents($file), true); }
If you add a die(print_r($this->settings)) to your __construct you can confirm that you indeed have your settings loaded.
Settings page
Call init_hooks() from the constructor:
public function __construct() { $this->set_settings(); $this->init_hooks(); }
Create init_hooks():
private function init_hooks() { add_action('admin_menu', [$this, 'register_settings_pages']); }
Create register_settings_pages() and settings_page_callback().
public function register_settings_pages() { foreach ($this->settings['pages'] as $page) { add_options_page($page['title'], $page['title'], $page['capability'], $page['slug'], [$this, 'settings_page_callback']); } } public function settings_page_callback() { $this->render('settings.php'); }
Create render():
private function render($filename, $args) { if (is_array($args)) { $value = get_option($args['id']); if (empty($value) && isset($args['default'])) { $value = $args['default']; } $args = array_merge($args, ['value' => $value]); } $file = ADV__PLUGIN_VIEW . $filename; if (!str_ends_with($file,'.php')) { $file .= '.php'; } if(!file_exists($file)) { die('File not found ' . $filename); } require $file; }
Create views/settings.php:
<div> <p><img src="/static/imghw/default1.png" data-src="https://img.php.cn/upload/article/000/000/000/173390329693560.jpg" class="lazy" alt="Creating WordPress plugin options based on a JSON structure" /></p> <h3> Sections </h3> <p>Add another action in init_hooks:<br> </p> <pre class="brush:php;toolbar:false">private function init_hooks() { add_action('admin_menu', [$this, 'register_settings_pages']); add_action('admin_init', [$this, 'register_settings_sections']); }
Create register_settings_sections() and settings_section_callback():
public function register_settings_sections() { foreach ($this->settings['sections'] as $section) { add_settings_section($section['id'], $section['title'], [$this, 'settings_section_callback'], ADV__PLUGIN_SLUG, $section); } } public function settings_section_callback($args) { $this->render($args['view'], $args); }
Create views/section.php:
<p> <?php echo $args['description']; ?> </p>
Fields
Add a third action in init_hooks:
private function init_hooks() { add_action('admin_menu', [$this, 'register_settings_pages']); add_action('admin_init', [$this, 'register_settings_sections']); add_action('admin_init', [$this, 'register_settings_fields']); }
Create register_settings_fields() and settings_field_callback():
public function register_settings_fields() { foreach ($this->settings['fields'] as $field) { add_settings_field($field['id'], $field['title'], [$this, 'settings_field_callback'], ADV__PLUGIN_SLUG, $field['section'], $field); register_setting(ADV__PLUGIN_SLUG, $field['id']); } } public function settings_field_callback($args) { $this->render($args['view'], $args); }
Create views/field.select.php:
<?php $html_options = ''; foreach ($args['options'] as $key => $val) { $html_options .= sprintf('<option value="%s" %s >%s</option>', $key, selected($args['value'], $key, false), $val); } printf('<select name="%s"> <p>Create views/field.text.php:<br> </p> <pre class="brush:php;toolbar:false"><?php printf('<input name="%s"> <h3> Saving </h3> <p>To view and save your options add a form to settings.php:<br> </p> <pre class="brush:php;toolbar:false"><div> <p>Change an option and attempt to <em>Save</em>. The save should be successful.</p> <p><img src="/static/imghw/default1.png" data-src="https://img.php.cn/upload/article/000/000/000/173390329893991.jpg" class="lazy" alt="Creating WordPress plugin options based on a JSON structure"></p> <p>Your settings are now saved and can be accessed throughout the site via:<br> </p> <pre class="brush:php;toolbar:false"><?php echo get_option('adv_portal_theme'); // squared.v1
Adding new fields
Add the JSON below to adventures.json:
{ "id": "adv_api_token", "title": "Host API Token", "section": "portal_base", "type": "text", "placeholder": "Enter API host token", "default": "", "view": "field.text" }
It will automatically be added to your settings:
The above is the detailed content of Creating WordPress plugin options based on a JSON structure. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

ToversionaPHP-basedAPIeffectively,useURL-basedversioningforclarityandeaseofrouting,separateversionedcodetoavoidconflicts,deprecateoldversionswithclearcommunication,andconsidercustomheadersonlywhennecessary.StartbyplacingtheversionintheURL(e.g.,/api/v

TosecurelyhandleauthenticationandauthorizationinPHP,followthesesteps:1.Alwayshashpasswordswithpassword_hash()andverifyusingpassword_verify(),usepreparedstatementstopreventSQLinjection,andstoreuserdatain$_SESSIONafterlogin.2.Implementrole-basedaccessc

Proceduralandobject-orientedprogramming(OOP)inPHPdiffersignificantlyinstructure,reusability,anddatahandling.1.Proceduralprogrammingusesfunctionsorganizedsequentially,suitableforsmallscripts.2.OOPorganizescodeintoclassesandobjects,modelingreal-worlden

PHPdoesnothaveabuilt-inWeakMapbutoffersWeakReferenceforsimilarfunctionality.1.WeakReferenceallowsholdingreferenceswithoutpreventinggarbagecollection.2.Itisusefulforcaching,eventlisteners,andmetadatawithoutaffectingobjectlifecycles.3.YoucansimulateaWe

To safely handle file uploads in PHP, the core is to verify file types, rename files, and restrict permissions. 1. Use finfo_file() to check the real MIME type, and only specific types such as image/jpeg are allowed; 2. Use uniqid() to generate random file names and store them in non-Web root directory; 3. Limit file size through php.ini and HTML forms, and set directory permissions to 0755; 4. Use ClamAV to scan malware to enhance security. These steps effectively prevent security vulnerabilities and ensure that the file upload process is safe and reliable.

Yes, PHP can interact with NoSQL databases like MongoDB and Redis through specific extensions or libraries. First, use the MongoDBPHP driver (installed through PECL or Composer) to create client instances and operate databases and collections, supporting insertion, query, aggregation and other operations; second, use the Predis library or phpredis extension to connect to Redis, perform key-value settings and acquisitions, and recommend phpredis for high-performance scenarios, while Predis is convenient for rapid deployment; both are suitable for production environments and are well-documented.

In PHP, the main difference between == and == is the strictness of type checking. ==Type conversion will be performed before comparison, for example, 5=="5" returns true, and ===Request that the value and type are the same before true will be returned, for example, 5==="5" returns false. In usage scenarios, === is more secure and should be used first, and == is only used when type conversion is required.

The methods of using basic mathematical operations in PHP are as follows: 1. Addition signs support integers and floating-point numbers, and can also be used for variables. String numbers will be automatically converted but not recommended to dependencies; 2. Subtraction signs use - signs, variables are the same, and type conversion is also applicable; 3. Multiplication signs use * signs, which are suitable for numbers and similar strings; 4. Division uses / signs, which need to avoid dividing by zero, and note that the result may be floating-point numbers; 5. Taking the modulus signs can be used to judge odd and even numbers, and when processing negative numbers, the remainder signs are consistent with the dividend. The key to using these operators correctly is to ensure that the data types are clear and the boundary situation is handled well.
