thoughtful-web / settings-page-wp
WordPress 设置页面生成器和验证器,作为免费开源软件发布,遵循 GNU GPL-2.0+ 许可协议
Requires
- php: >=7.3.5
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-15 17:41:32 UTC
README
此 PHP 库提供了一种快速、简单的方式,将设置页面添加到您的插件或主题中。一个配置文件定义了您的设置以及管理它们的页面。
目录
功能
- 从配置文件(*.php 或 *.json)生成设置页面。
- 默认情况下在服务器上验证。
- 除了 WordPress 的 Iris 库之外,不使用任何外部库。
- 支持以下表单字段类型
- 复选框
- 颜色
- 电子邮件
- 数字
- 电话
- 单选按钮
- 选择
- 文本
- 文本区域
- 网址
- WP 编辑器
要求
系统要求
- WordPress 5.4 及以上版本。
- PHP 7.3.5 及以上版本。
安装要求
如果您熟悉命令行,可以使用 Composer 或 Git 进行安装。否则,您可以 从 Github 下载发行版。
无论如何,此库必须在插件或主题根目录下存在两个目录级别。例如:./vendor/thoughtful-web/settings-page-wp/。
快速入门
注意:有关配置文件值和配置文件可能的其它位置的完整规范细节,请参阅此处:docs/config-file.md
步骤 1
下载 composer 模块。
$ composer require thoughtful-web/settings-page-wp
步骤 2
使用 Composer 自动加载器将库包含到您的插件或主题中
require __DIR__ . '/vendor/autoload.php; new \ThoughtfulWeb\SettingsPageWP\Page();
步骤 3
将示例配置文件复制到您的插件或主题目录中的 ./config/thoughtful-web/settings.php
。
步骤 4
访问您的新设置页面 https://your-domain.com/wp-admin/admin.php?page=thoughtful-settings 并按需填写。
步骤 5
使用 WordPress 的 get_option()
函数从数据库中检索选项
$the_option = get_option( 'unique_text_field' );
文档
贡献
我欢迎提问和讨论,并已开启 Github 的功能以创建一个空间: https://github.com/thoughtful-web/settings-page-wp/discussions。如果您发现一个问题,请在此处报告: https://github.com/thoughtful-web/settings-page-wp/issues。我目前只接受安全改进的拉取请求。有关详细信息,请参阅贡献指南。
遵循 GNU GPL-2.0+ 许可协议的免费开源软件。
版权所有 Zachary Kendall Watkins 2021-2022。