什么是WordPress插件API设置？

34 2025-07-24 Google SEO 手机阅读

什么是Wordpress插件API设置？WordPress 提供了两个核心 API，使管理界面易于构建、安全且与 WordPress 管理的设计一致。设置API专注于为开发人员提供创建表单和管理表单数据的方法。

Options API专注于使用简单的键/值系统管理数据。

快速参考

查看使用设置 API 和选项 API构建自定义设置页面的完整示例。

WordPress 的可扩展性一直是其一大优势。它不仅拥有成千上万个插件，您还可以自行构建。有时，您可能决定分发您的插件。这通常需要将硬编码数据替换为插件未来用户可以设置的选项。在本文中，我将讨论在 WordPress 插件中创建设置页面的五种不同方法。

WordPress 设置 API
自定义字段框架
使用代码生成器
使用 REST API
VueJS
React

WordPress 设置 API

WordPress 2.7 中添加的WordPress 设置 API允许开发人员在仪表板中现有的设置表单上注册设置字段，以及创建 WordPress 将显示并负责保存数据的新设置表单：

它允许您定义设置页面、页面内的部分以及部分内的字段。

这绝对是本文讨论的方法中最需要手动操作的，但了解它的工作原理还是值得的。在某些情况下，它可能足够简单，足以满足您的需求。创建 WordPress 插件设置页面的 5 种方法，首先，我们需要注册一个包含设置表单的新菜单项和页面。让我们将页面添加到 WordPress 信息中心的“设置”顶级菜单项下：


function dbi_add_settings_page() {
    add_options_page( 'Example plugin page', 'Example Plugin Menu', 'manage_options', 'dbi-example-plugin', 'dbi_render_plugin_settings_page' );
}
add_action( 'admin_menu', 'dbi_add_settings_page' );

要访问 WordPress 插件设置，导航到您的 WordPress 仪表板，然后转到插件 > 已安装的插件。找到您要配置的插件并点击其“设置”链接。这将带您进入插件的设置页面，您可以在其中自定义其行为。

第五个参数add_options_page是用于显示页面内容的函数名称，在本例中是设置表单。该函数需要包含一个表单元素和一些函数调用，以便与设置 API 进行通信：

该函数settings_fields渲染代码来告诉表单要做什么，并使用nonce来隐藏输入以确保其安全。传递给该函数的参数是稍后将注册的设置组的名称。

函数do_settings_sections是表单的关键部分。所有部分和字段（文本框、选择框、复选框等）都输出在这里，以便用户输入数据。同样，该函数参数是任意的，但必须是唯一的。我们将在注册字段时使用它。

这里发生了三件事。首先，我们在wp_optionsregister_setting表中为我们的设置创建一条新记录，并以 'dbi_example_plugin_options' 作为参数。option_name

我们的各个设置将存储为序列化的数据数组。这非常适合将所有插件设置集中到一起，但数据序列化可能会导致迁移 WordPress 数据库时出现问题，除非处理得当。第三个参数是用于在保存选项时验证输入数据的函数名称。

例如，确保 API 密钥是仅包含数字和字母的 32 个字符串：

function dbi_example_plugin_options_validate( $input ) {
$newinput['api_key'] = trim( $input['api_key'] );
if ( ! preg_match( '/^[a-z0-9]{32}$/i', $newinput['api_key'] ) ) {
$newinput['api_key'] = '';
}
return $newinput;}

其次，我们为设置注册一个组部分add_settings_field，并将其与选项绑定。最后，我们用为该组注册三个字段。所有这些字段都是文本字段，用于保存我们插件的设置。

接下来，我们需要创建函数来显示该部分的有用文本并在表单上呈现字段(php代码)：

呼！就是这样，我们有一个设置页面：

get_option('dbi_example_plugin_options')在我们的代码中使用设置就是使用和使用我们需要的设置的数组键的情况。

这里涉及不少繁琐的环节，注册各种组件、复制代码，还要确保所有组件都正确组合。这在 WordPress API 中并非最容易使用，甚至解释起来也并非易事。因此，市面上出现了一些包装器库，旨在简化向 WordPress 插件添加设置页面的流程，也就不足为奇了。

当我创建Instagram WordPress 插件时，我使用由Gilbert Pellegrom创建的WordPress 设置框架构建了设置页面。

#自定义字段框架

说到 PHP 框架，我想展示一种不使用 WordPress 设置 API 来创建设置页面的替代方法。当我构建网站时，如果需要设置页面，我默认使用“高级自定义字段”来创建一个选项页面，然后使用 ACF 定义字段。

这是我喜欢使用 ACF 的众多原因之一：它让复杂的 WordPress 功能变得简单。你甚至可以使用ACF Blocks为块编辑器注册块，而无需接触 React。

但是，在构建用于分发的插件或主题时，您不能依赖用户安装 ACF。您可以通过 Composer 构建插件以依赖 ACF，但 WordPress 插件依赖其他插件的做法并不被视为最佳实践。

进入Carbon Fields框架。与 ACF 不同，Carbon Fields 不是插件，通常作为插件内部的库安装，推荐使用Composer。

专业提示：如果您确实使用 Composer 在插件中安装 Carbon Fields，请记住通过在 Composer 包的命名空间前添加前缀来避免WordPress 依赖管理地狱。

要访问 WordPress 插件设置，导航到您的 WordPress 仪表板，然后转到插件 > 已安装的插件。找到您要配置的插件并点击其“设置”链接。这将带您进入插件的设置页面，您可以在其中自定义其行为。
以下是更详细的分类：

1.访问插件设置：

仪表板：登录您的 WordPress 仪表板。
插件：将鼠标悬停在左侧菜单中的“插件”上，然后单击“已安装的插件”。
查找插件：找到您想要调整设置的插件。
点击“设置”：在插件标题下方，您会看到“激活 | 删除”或“设置 | 支持 | 停用”等选项。点击“设置”即可访问该插件的具体配置页面。

2.自定义插件设置：

常规设置：
这些通常是插件的核心设置，例如默认行为、用户访问和基本功能。
高级设置：
一些插件提供更详细的配置，包括自定义字段、显示选项或与其他插件或服务的集成。
安全设置：
确保插件设置包括保护数据和防止滥用的选项，例如用户角色和权限。

3.更新和维护插件：

检查更新：
定期检查 WordPress 仪表板中的“更新”部分，了解可用的插件更新。
更新插件：
点击“立即更新”安装最新版本，确保兼容性和安全性。
清除缓存：
更新后，请清除网站的缓存以确保更改立即生效。