基于 JSON 结构创建 WordPress 插件选项-php教程-PHP中文网

基于 JSON 结构创建 WordPress 插件选项

霞舞

发布： 2024-12-10 08:07:04

转载

1132人浏览过

有一天，我想知道如何让 wordpress 插件选项由 json 文件控制，以便将来可以更轻松地添加其他设置，而无需调整代码本身。

本文提供了一个极其简单的 wordpress 插件示例，该插件的单个设置页面由 2 个部分和 3 个字段/选项组成。

完整代码可以在github上找到。

设置基地

该插件最初由 3 个文件组成。

adventures.json
adventures.php
class.adventures.php

adventures.php 带有基本插件注册：

<?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 带有一个空类：

<?php

class adventures {
    public function __construct() {

    }
}

登录后复制

adventures.json 包含插件设置的 json 结构：

{
    "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"
            }
        ]
    }
}

登录后复制

读取 json 数据

为您的设置创建一个属性并调用 set_settings():

private $settings;

public function __construct() {
    $this->set_settings();
}

登录后复制

创建 set_settings() 和 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);
}

登录后复制

如果您将 die(print_r($this->settings)) 添加到您的 __construct 中，您可以确认您确实已加载设置。

基于 JSON 结构创建 WordPress 插件选项

设置页面

从构造函数中调用 init_hooks():

public function __construct() {
    $this->set_settings();
    $this->init_hooks();
}

登录后复制

创建init_hooks():

private function init_hooks() {
    add_action('admin_menu', [$this, 'register_settings_pages']);
}

登录后复制

创建register_settings_pages()和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');
}

登录后复制

创建渲染():

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;
}

登录后复制

创建views/settings.php：

<div class="wrap">
    <h1>adventures</h1>
</div>

登录后复制

基于 JSON 结构创建 WordPress 插件选项

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

查看详情

部分

在 init_hooks 中添加另一个操作：

private function init_hooks() {
    add_action('admin_menu', [$this, 'register_settings_pages']);
    add_action('admin_init', [$this, 'register_settings_sections']);
}

登录后复制

创建register_settings_sections()和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);
}

登录后复制

创建views/section.php：

<p>
    <?php echo $args['description']; ?>
</p>

登录后复制

领域

在 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']);
}

登录后复制

创建register_settings_fields()和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);
}

登录后复制

创建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" id="%s">%s</select>', $args['id'], $args['id'], $html_options);

登录后复制

创建views/field.text.php：

<?php

printf('<input name="%s" id="%s" type="text" value="%s" placeholder="%s" />', 
$args['id'], $args['id'], $args['value'], $args['placeholder']);

登录后复制

保存

要查看并保存您的选项，请在 settings.php 中添加一个表单：

<div class="wrap">
    <h1>adventures</h1>

    <form action="options.php" method="post">
        <?php 
        settings_fields(adv__plugin_slug);
        do_settings_sections(adv__plugin_slug);
        submit_button();
        ?>
    </form>
</div>

登录后复制

更改选项并尝试保存。保存应该成功。

基于 JSON 结构创建 WordPress 插件选项

您的设置现已保存，可以通过以下方式在整个网站上访问：

<?php
echo get_option('adv_portal_theme'); // squared.v1

登录后复制

添加新字段

将以下 json 添加到 adventures.json：

{
    "id": "adv_api_token",
    "title": "Host API Token",
    "section": "portal_base",
    "type": "text",
    "placeholder": "Enter API host token",
    "default": "",
    "view": "field.text"
}

登录后复制

它将自动添加到您的设置中：

基于 JSON 结构创建 WordPress 插件选项