类型：CMS系统
简介：一款开源的内容管理系统（CMS），用于构建和管理网站。
元数据就是关于数据的数据，听起来有点绕，通俗易懂来说就是提供了关于数据的信息，但不是数据实际内容本身。例如在WordPress中元数据指的是文章、分类发项目、评论和用户的附加信息，一个主要数据可以有很多元数据，这就是WordPress数据结构的灵活性所在。本文主要介绍如何在WordPress插件开发中进行元数据管理，宝库添加、更新和删除操作。
一、WordPress文章元数据
1、添加元数据
在WordPress中添加元数据可以使用add_post_meta()函数，此函数接受post_id、meta_key、meta_value和unique标志各一个。
其中meta_key是插件在其他地方引用的meta_value依据，可以使用任意字符串作为名称，例如“mycrazymetakeyname”。建议在名称前面加上前缀，并以下划线分隔名称中的单词，如 wporg_featured_menu，以防止冲突和语义化。同一个meta_key可以被多次使用来存储各种各样的元数据。
meta_value可以使字符串、证书数据或者对象，如果meta_value是一个数组或对象，WordPress会在存储到数据库之前自动序列化他们，并在从数据库中获取之前反序列化。
unique标志可以让我们声明某条元数据相对于一条主数据是否为唯一的。非唯一的meta_key相对于一条主数据可以有多个值，比如‘price’这个meta_key，一个产品的价格是唯一的，所以我们应该为这条元数据添加unique标记，以确保一个产品只有一个价格。
2、更新元数据
update_post_meta()函数可以用来更新WordPress中已存在的元数据，但如果我们使用这个函数更新了一条不存在的元数据，该函数自动调用add_post_meta()来帮我们添加这条数据，该函数的参数和add_post_meta()类似。
3、删除元数据
delete_post_meta()函数用于删除元数据，该函数接受一个post_id，一个 meta_key 和一个可选的meta_value。
4、字符转义
stripslashes()可用于在WordPress中存储文章元数据的时候转义数据中的某些字符串，在传入可能包含 \ 转义字符串的时候（例如 JSON ）需要注意。例如一个JSON字符串 {key:value with \escaped quotes\}：
$escaped_json = '{key:value with \escaped quotes\}';
update_post_meta($id, 'escaped_json', $escaped_json);
$broken = get_post_meta($id, 'escaped_json', true);
/*
$broken, after stripslashes(), ends up unparsable:
{key:value with escaped quotes}
*/
那么该如何解决？可以通过wp_slash()函数再加一个转义级别，用来补偿stripslashes()的转义。代码如下：
$escaped_json = '{key:value with \escaped quotes\}';
update_post_meta($id, 'double_escaped_json', wp_slash($escaped_json));
$fixed = get_post_meta($id, 'double_escaped_json', true);
/*
$fixed, after stripslashes(), ends up as desired:
{key:value with \escaped quotes\}
*/
5、隐藏的自定义字段
WordPress默认会隐藏两类自定义字段，需通过特定方式才能在编辑界面显示：
下面的例子将添加一个meta_key为 “_color” 的隐藏自定义字段，该字段的值为 “red”，这个字段不会在 WordPress 默认的自定义字段编辑界面中显示。
add_post_meta( 68, '_color', 'red', true );
要显示这类隐藏字段，需通过add_meta_box()函数创建自定义元数据盒子。
无论meta_key是否以下划线开头，若meta_value是数组，由于数据库中存储的是序列化后的数据，默认编辑界面无法正常展示和编辑，同样需要自定义元数据盒子来处理。
二、自定义元数据盒子的实现
元数据盒子是WordPress文章编辑界面的模块化组件，默认包含编辑器、发布选项、分类目录等模块。插件可通过自定义元数据盒子，为用户提供直观的元数据编辑入口，以下是完整实现流程。
元数据盒子本质是嵌入文章编辑界面的HTML表单容器，用户输入的内容会随文章发布/更新一起提交，无需单独设计提交逻辑。
元数据盒子可以让用户很方便的编辑当前文章的相关信息，我们的自定义元数据盒子和默认的文章信息显示在一个界面上，他们之间的从属和相关关系很清晰。
如果用户不需要某个元数据盒子，他们可以很方便的将其隐藏，根据需要，用户也可以对元数据盒子排序，把自己经常使用的元数据盒子放在合适的位置。
注意：此页面上的所有示例代码仅用于说明，不适合生产环境。安全输入，用户权限，随机数和国际化等相关操作已被省略。实际开发中一定要处理这些重要的操作。
1、添加元数据盒子
调用add_meta_box()函数定义盒子属性，并将其挂载到add_meta_boxes动作钩子上。以下示例在 “文章”（post）和自定义文章类型（wporg_cpt）的编辑界面添加元数据盒子：
function wporg_add_custom_box() {
$screens = ['post', 'wporg_cpt'];
foreach ($screens as $screen) {
add_meta_box(
'wporg_box_id', // Unique ID
'Custom Meta Box Title', // Box title
'wporg_custom_box_html', // Content callback, must be of type callable
$screen // Post type
);
}
}
add_action('add_meta_boxes', 'wporg_add_custom_box');
上述代码中的wporg_custom_box_html是回调函数，负责渲染盒子内的表单元素。例如添加一个下拉列表：
function wporg_custom_box_html($post) {
?>
<label for=wporg_field>Description for this field</label>
<select name=wporg_field id=wporg_field class=postbox>
<option value=>Select something...</option>
<option value=something>Something</option>
<option value=else>Else</option>
</select>
<?php
}
若已保存过元数据，需在表单加载时显示默认值，可通过get_post_meta()函数获取已存数据。以下示例为下拉列表设置默认选中状态：
function wporg_custom_box_html($post) {
$value = get_post_meta($post->ID, '_wporg_meta_key', true);
?>
<label for=wporg_field>Description for this field</label>
<select name=wporg_field id=wporg_field class=postbox>
<option value=>Select something...</option>
<option value=something <?php selected($value, 'something'); ?>>Something</option>
<option value=else <?php selected($value, 'else'); ?>>Else</option>
</select>
<?php
}
其中selected()是WordPress提供的辅助函数。
2、保存自定字段值
表单数据需通过save_post动作钩子处理，该钩子会在文章保存/更新时触发。以下示例将表单中的wporg_field值存储到_wporg_meta_key（隐藏元数据）中：
function wporg_save_postdata($post_id) {
if (array_key_exists('wporg_field', $_POST)) {
update_post_meta(
$post_id,
'_wporg_meta_key',
$_POST['wporg_field']
);
}
}
add_action('save_post', 'wporg_save_postdata');
注意：save_post钩子可能被多次触发，实际开发中需添加判断逻辑，避免重复存储或非法提交。
WordPress加载文章编辑界面时，会调用do_meta_boxes()函数遍历所有已注册的元数据盒子，根据add_meta_box()定义的回调函数生成表单 HTML，并自动添加容器标签（如div）和样式类，确保盒子与界面风格统一。
若需删除默认或其他插件添加的元数据盒子，可使用remove_meta_box()函数，参数需与添加时的meta_box_id、文章类型完全匹配。例如删除 “文章” 类型下的 “标签” 盒子（需先在wp-includes/edit-form-advanced.php中查询默认盒子的 ID）：
3、元数据盒子的进阶实现方式
除了基础的面向过程开发，还可通过面向对象或AJAX技术优化元数据盒子的实现，提升代码可维护性和用户体验。
采用抽象类 + 静态方法的方式，可避免全局命名空间冲突，同时简化代码组织。示例如下：
abstract class WPOrg_Meta_Box {
public static function add() {
$screens = ['post', 'wporg_cpt'];
foreach ($screens as $screen) {
add_meta_box(
'wporg_box_id', // Unique ID
'Custom Meta Box Title', // Box title
[self::class, 'html'], // Content callback, must be of type callable
$screen // Post type
);
}
}
public static function save($post_id) {
if (array_key_exists('wporg_field', $_POST)) {
update_post_meta(
$post_id,
'_wporg_meta_key',
$_POST['wporg_field']
);
}
}
public static function html($post) {
$value = get_post_meta($post->ID, '_wporg_meta_key', true);
?>
<label for=wporg_field>Description for this field</label>
<select name=wporg_field id=wporg_field class=postbox>
<option value=>Select something...</option>
<option value=something <?php selected($value, 'something'); ?>>Something</option>
<option value=else <?php selected($value, 'else'); ?>>Else</option>
</select>
<?php
}
}
add_action('add_meta_boxes', ['WPOrg_Meta_Box', 'add']);
add_action('save_post', ['WPOrg_Meta_Box', 'save']);
默认情况下，元数据需随文章一起保存，通过Ajax可实现 “实时提交元数据”，无需等待文章保存，提升用户体验。完整流程分为客户端和服务端两部分。
定义一个触发器：
(function ($, window, document) {
'use strict';
// execute when the DOM is ready
$(document).ready(function () {
// js 'change' event triggered on the wporg_field form field
$('#wporg_field').on('change', function () {
// our code
});
});
}(jQuery, window, document));
客户端：
首先通过JS监听表单元素的变化（如下拉列表选择变更），触发 AJAX 请求。示例代码：
(function ($, window, document) {
'use strict';
// execute when the DOM is ready
$(document).ready(function () {
// js 'change' event triggered on the wporg_field form field
$('#wporg_field').on('change', function () {
// jQuery post method, a shorthand for $.ajax with POST
$.post(wporg_meta_box_obj.url, // or ajaxurl
{
action: 'wporg_ajax_change', // POST data, action
wporg_field_value: $('#wporg_field').val() // POST data, wporg_field_value
}, function (data) {
// handle response data
if (data === 'success') {
// perform our success logic
} else if (data === 'failure') {
// perform our failure logic
} else {
// do nothing
}
}
);
});
});
}(jQuery, window, document));
通过wp_localize_script()函数将 WordPress 后台的 AJAX 地址（admin-ajax.php）传递到前端，确保请求路径正确：
function wporg_meta_box_scripts(){
// get current admin screen, or null
$screen = get_current_screen();
// verify admin screen object
if (is_object($screen)) {
// enqueue only for specific post types
if (in_array($screen->post_type, ['post', 'wporg_cpt'])) {
// enqueue script
wp_enqueue_script('wporg_meta_box_script', plugin_dir_url(__FILE__) . 'admin/meta-boxes/js/admin.js', ['jquery']);
// localize script, create a custom js object
wp_localize_script(
'wporg_meta_box_script',
'wporg_meta_box_obj',
[
'url' => admin_url('admin-ajax.php'),
]
);
}
}
}
add_action('admin_enqueue_scripts', 'wporg_meta_box_scripts');
最后一步是编写处理AJAX请求的服务端代码。
function wporg_meta_box_ajax_handler() {
if (isset($_POST['wporg_field_value'])) {
switch ($_POST['wporg_field_value']) {
case 'something':
echo 'success';
break;
default:
echo 'failure';
break;
}
}
// ajax handlers must die
die;
}
// wp_ajax_ is the prefix, wporg_ajax_change is the action we've used in client side code
add_action('wp_ajax_wporg_ajax_change', 'wporg_meta_box_ajax_handler');
四、渲染文章元数据
WordPress提供两个核心函数读取文章元数据，满足不同场景需求：
1、get_post_meta ()
该函数用于读取某篇文章下特定meta_key的元数据，参数如下：
get_post_meta( int $post_id, string $key = '', bool $single = false );
示例：
$wporg_meta_value = get_post_meta(get_the_ID(), 'wporg_meta_key');
2、get_post_custom ()
该函数返回某篇文章的所有元数据，用法如下：
get_post_custom( int $post_id );
示例：
$meta_array = get_post_custom(get_the_ID());
