WordPress插件：实现单个设置字段保存多个值的方法

WordPress设置字段多值保存的挑战

在wordpress插件开发中，我们经常需要为插件创建设置页面，以便用户配置各种选项。通常，一个设置字段（例如，一个文本输入框）对应数据库中保存的一个单一值。然而，在某些场景下，我们需要为同一个设置项存储多个相关联的值，例如，一个插件可能需要记录多个分类别名及其对应的折扣百分比。默认的wordpress设置api在处理单个字段时非常直接，但要实现多值保存，则需要一些特定的技巧。

核心实现：利用数组结构保存多值

要使一个设置字段能够保存多个值，关键在于利用HTML表单 input 标签的 name 属性的命名约定。通过在 name 属性的末尾添加 []，我们可以指示WordPress（以及PHP本身）将提交的数据作为数组来处理。当表单提交时，即使是同一个 name 属性的多个输入框，其值也会被收集到一个数组中，并保存到数据库。

以下是修改后的 cat_slug_render 函数示例，它将 cat_slug 设置保存为一个数组：

function cat_slug_render() {
    // 从数据库获取现有选项，如果不存在则返回空数组
    $options = get_option( 'slug-configuration', array() );
    ?>
    <!-- 关键在于 name='slug-configuration[cat_slug][]' -->
    <input type='text' size="50" name='slug-configuration[cat_slug][]' value='<?php echo esc_html( $options['cat_slug'][0] ?? '' ); ?>'>
    <?php
}

解释：

• name='slug-configuration[cat_slug][]' 是实现多值保存的关键。当用户在设置页面输入值并保存时，WordPress的设置API会识别 []，并将 cat_slug 视为一个数组来处理。
• get_option( 'slug-configuration', array() )：这是一个良好的实践，确保在选项不存在时返回一个空数组，避免潜在的PHP警告。
• esc_html( $options['cat_slug'][0] ?? '' )：这里展示了如何预填充输入框。由于 cat_slug 现在是一个数组，我们必须决定显示数组中的哪个值。在这个例子中，我们选择了显示数组的第一个元素 [0]。?? '' 是PHP 7+的空合并运算符，用于在 $options['cat_slug'][0] 不存在时返回空字符串，防止报错。

多值设置的显示与预填充

当一个设置保存了多个值时，在一个单一的输入字段中预填充值是一个需要考虑的问题。通常，你需要根据业务逻辑决定显示数组中的哪个特定值。

1. 显示第一个值

如上例所示，最简单的方法是显示数组的第一个元素：

function cat_slug_render() {
    $options = get_option( 'slug-configuration', array() );
    ?>
    <input type='text' size="50" name='slug-configuration[cat_slug][]' value='<?php echo esc_html( $options['cat_slug'][0] ?? '' ); ?>'>
    <?php
}

2. 显示最后一个值（最新添加的值）

如果你希望显示最近添加或修改的值，可以获取数组的最后一个元素。这通常适用于用户希望看到他们最新操作的结果。

function cat_slug_render() {
    $options = get_option( 'slug-configuration', array() );
    // 确保 $options['cat_slug'] 存在且为数组，否则返回空数组
    $category_slugs = $options['cat_slug'] ?? [];
    $last_key = array_key_last( $category_slugs ); // 获取数组最后一个键名
    ?>
    <input type='text' size="50" name='slug-configuration[cat_slug][]' value='<?php echo esc_html( $category_slugs[$last_key] ?? '' ); ?>'>
    <?php
}

注意： array_key_last() 函数需要 PHP 7.3 或更高版本。对于旧版本PHP，你可能需要使用 end() 和 key() 组合来获取最后一个元素。

存了个图

视频图片解析/字幕/剪辑，视频高清保存/图片源图提取

17

查看详情

检索与遍历已保存的多值

一旦你成功保存了多个值，你可以像获取任何其他选项一样获取它们，然后使用循环遍历数组中的每个值。

// 获取完整的选项数组
$options = get_option( 'slug-configuration', array() );

// 安全地获取 'cat_slug' 数组，如果不存在则默认为空数组
$category_slugs = $options['cat_slug'] ?? array();

// 遍历每个分类别名并进行处理
foreach( $category_slugs as $slug ) {
    // 在这里处理每个分类别名，例如显示它、应用折扣逻辑等
    echo "已保存的分类别名: " . esc_html( $slug ) . "<br>";
    // 示例：假设还有一个 discount_percentage 数组与此对应
    // $discount_percentage = $options['discount_percentage'][ $key ] ?? 0;
    // echo "对应折扣: " . esc_html( $discount_percentage ) . "%<br>";
}

注意事项与最佳实践

1. 数据清洗（Sanitization）： 当你的设置值变为数组时，对应的 sanitize_callback 函数也必须进行更新，以正确处理数组数据。你需要遍历数组中的每个元素，并对每个元素进行适当的清洗，而不是直接对整个数组进行字符串清洗。

   // 示例：假设你的 sanitization 回调函数
   function my_plugin_settings_sanitize( $input ) {
       $new_input = array();
       if ( isset( $input['cat_slug'] ) && is_array( $input['cat_slug'] ) ) {
           foreach ( $input['cat_slug'] as $key => $slug ) {
               // 对每个分类别名进行清洗
               $new_input['cat_slug'][$key] = sanitize_text_field( $slug );
           }
       }
       // 其他设置项的清洗...
       return $new_input;
   }

   登录后复制

2. 安全性（Security）： 始终使用 esc_html() 或其他合适的 esc_ 函数来转义任何输出到HTML中的数据，以防止跨站脚本（XSS）攻击。这在显示用户输入的数据时尤为重要。

3. 兼容性： PHP的空合并运算符 ?? 和 array_key_last() 函数分别需要 PHP 7.0 和 7.3 或更高版本。如果你的插件需要兼容旧版本的PHP，请使用 isset() 检查变量是否存在，并使用 end() 或其他方法来获取数组的最后一个元素。

4. 用户体验（UX）： 如果你的目标是每次保存都“添加新记录”，仅仅使用一个带有 [] 的输入框可能不是最佳的用户界面。用户可能期望每次输入一个值后，该值能被添加到列表中，并且可以继续添加新的值。在这种情况下，你可能需要：

   • 动态添加输入框： 使用JavaScript在用户界面上动态添加新的输入框，每个输入框都带有 name='setting_name[]'。
   • 追加保存逻辑： 在 sanitize_callback 或保存逻辑中，将新提交的值追加到现有数组中，而不是替换它。这需要更复杂的逻辑来管理值的添加、编辑和删除。

总结

通过在HTML input 标签的 name 属性中使用 [] 后缀，WordPress插件可以轻松实现单个设置字段保存多个值。理解如何在设置页面预填充这些值（例如，显示第一个或最后一个）、如何安全地检索和遍历它们，以及如何正确地进行数据清洗和安全转义，是开发健壮和用户友好的多值设置插件的关键。同时，根据用户体验需求，可能需要进一步考虑前端界面的交互设计。

以上就是WordPress插件：实现单个设置字段保存多个值的方法的详细内容，更多请关注php中文网其它相关文章！