
当你在 wordpress 编辑器中插入自定义短代码并尝试更新或保存页面时,如果遇到“无效 json 响应”错误,这通常意味着 wordpress 后台的 ajax 请求未能收到预期的 json 格式响应。对于短代码而言,一个常见的误区是直接在短代码函数中使用 echo 输出内容。
WordPress 短代码的约定是:短代码函数应该返回它希望显示的内容,而不是直接将其输出到浏览器。当你在短代码函数中直接使用 echo 时,这些内容会在 WordPress 尝试发送其预期的 JSON 响应之前被输出。这会导致 JSON 响应被“污染”,从而引发“无效 JSON 响应”错误。尤其是在 Gutenberg 编辑器或任何依赖 AJAX 保存的场景下,这个问题会更加突出。
解决此问题的关键在于使用 PHP 的输出缓冲机制。通过 ob_start() 和 ob_get_clean() 函数,我们可以捕获短代码函数中所有 echo 的内容,然后将其作为字符串返回,从而符合 WordPress 短代码的预期行为。
基本原理:
除了解决“无效 JSON 响应”问题,开发自定义短代码时,与数据库的交互安全性至关重要。直接将用户输入(如 $_POST 或 $_GET)拼接到 SQL 查询字符串中是极其危险的,这会使你的网站面临 SQL 注入攻击的风险。
WordPress 提供了 $wpdb->prepare() 方法来安全地构建 SQL 查询。它类似于 sprintf(),可以防止 SQL 注入。
$wpdb->prepare() 的用法:
以下是一个改进后的短代码函数示例,它结合了输出缓冲、安全数据库查询和基本的错误处理:
<?php
/**
* 注册自定义短代码
* [my_custom_search_form]
*/
function register_my_custom_shortcode() {
add_shortcode('my_custom_search_form', 'my_custom_search_form_function');
}
add_action('init', 'register_my_custom_shortcode');
/**
* 自定义短代码函数:显示搜索表单并根据查询结果显示表格
*/
function my_custom_search_form_function() {
global $wpdb;
// 定义数据库表名,建议使用 $wpdb->prefix 获取带前缀的表名
$table_name = $wpdb->prefix . 'your_custom_job_table'; // 替换为你的实际表名
// 获取并清理用户输入的筛选条件
$filter = isset($_POST['filter']) ? sanitize_text_field($_POST['filter']) : '';
// 引入搜索表单 HTML,通常放在插件目录的某个文件中
// 确保 form.html 存在于指定路径
$form_path = WP_PLUGIN_DIR . '/your_plugin_directory/assets/runtime/shortcode/form.html';
if (file_exists($form_path)) {
require_once($form_path);
} else {
// 如果表单文件不存在,可以输出一个错误信息或默认内容
error_log('Shortcode form file not found: ' . $form_path);
// return '<p>搜索表单加载失败。</p>'; // 或者直接返回错误信息
}
// 开启输出缓冲
ob_start();
?>
<div class="my-custom-shortcode-wrapper">
<?php
// 只有当有筛选条件时才执行数据库查询并显示结果
if (!empty($filter)) {
// 构建查询:使用 $wpdb->prepare 防止 SQL 注入
// 注意 LIKE 子句中的 %% 用于转义 %
$query = $wpdb->prepare(
"SELECT id, column1, column2, column3 FROM %i WHERE column1 LIKE %s OR id LIKE %s",
$table_name,
'%' . $wpdb->esc_like($filter) . '%', // 使用 $wpdb->esc_like 处理通配符
'%' . $wpdb->esc_like($filter) . '%'
);
$results = $wpdb->get_results($query, ARRAY_A);
if ($results && count($results) > 0) {
?>
<table>
<thead>
<tr>
<th>列1</th>
<th>列2</th>
<th>列3</th>
</tr>
</thead>
<tbody>
<?php foreach ($results as $row) : ?>
<tr>
<td>
<a href="<?php echo esc_url(site_url('/displayjobs?id=' . $row['id'])); ?>">
<?php echo esc_html($row['column1']); ?>
</a>
</td>
<td><?php echo esc_html($row['column2']); ?></td>
<td><?php echo esc_html($row['column3']); ?></td>
</tr>
<?php endforeach; ?>
</tbody>
</table>
<?php
} else {
echo '<p>未找到匹配的结果。</p>';
}
} else {
// 如果没有筛选条件,可以显示提示信息
echo '<p>请输入搜索条件以查找信息。</p>';
}
?>
</div>
<?php
// 获取缓冲区内容并返回
return ob_get_clean();
}
?>对应的 form.html 文件示例:
<form method="POST" class="my-custom-search-form"> <input type="text" name="filter" placeholder="请输入搜索关键词..." value="<?php echo isset($_POST['filter']) ? esc_attr(sanitize_text_field($_POST['filter'])) : ''; ?>"/> <input type="submit" value="搜索"/> </form>
注意事项:
通过遵循以下核心原则,可以有效避免 WordPress 短代码中的“无效 JSON 响应”问题,并提升代码质量和安全性:
遵循这些最佳实践,你将能够构建出健壮、安全且兼容性良好的 WordPress 自定义短代码。
以上就是WordPress 短代码导致“无效 JSON 响应”的调试与最佳实践的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号