有一天,我想知道如何让 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 中,您可以确认您确实已加载设置。
设置页面
从构造函数中调用 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:
登录后复制adventures
部分
在 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:
登录后复制<?php echo $args['description']; ?>
领域
在 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('', $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 中添加一个表单:
登录后复制adventures
<form action="options.php" method="post"> <?php settings_fields(adv__plugin_slug); do_settings_sections(adv__plugin_slug); submit_button(); ?> </form>
更改选项并尝试保存。保存应该成功。
您的设置现已保存,可以通过以下方式在整个网站上访问:
<?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 插件选项的详细内容,更多请关注慧达安全导航其它相关文章!
免责 声明
1、本网站名称:慧达安全导航
2、本站永久网址:https//www.huida178.com/
3、本站所有资源来源于网友投稿和高价购买,所有资源仅对编程人员及源代码爱好者开放下载做参考和研究及学习,本站不提供任何技术服务!
4、本站所有资源的属示图片和信息不代表本站的立场!本站只是储蓄平台及搬运
5、下载者禁止在服务器和虚拟机下进行搭建运营,本站所有资源不支持联网运行!只允许调试,参考和研究!!!!
6、未经原版权作者许可禁止用于任何商业环境,任何人不得擅作它用,下载者不得用于违反国家法律,否则发生的一切法律后果自行承担!
7、为尊重作者版权,请在下载24小时内删除!请购买原版授权作品,支持你喜欢的作者,谢谢!
8.若资源侵犯了您的合法权益,请持 您的版权证书和相关原作品信息来信通知我们!QQ:1247526623我们会及时删除,给您带来的不便,我们深表歉意!
9、如下载链接失效、广告或者压缩包问题请联系站长处理
10、如果你也有好源码或者教程,可以发布到网站,分享有金币奖励和额外收入!
11、本站资源售价只是赞助,收取费用仅维持本站的日常运营所需
12、因源码具有可复制性,一经赞助,不得以任何形式退款。
13、本文内容由网友自发贡献和站长收集,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系1247526623@qq.com
转载请注明出处: 慧达安全导航 » 基于 JSON 结构创建 WordPress 插件选项
发表评论 取消回复