带有数组的设置API示例

我将Wrox WordPress插件开发书用作开始使用新插件的主要参考资料，并且我了解所有设置都可以另存为1个数组，但是书中并未提供有关此示例以及我所从事的所有工作的示例从一个例子到另一个例子，在网络上查找似乎是如此不同。康斯坦丁（Konstantin）发表的文章的后半部分让我很接近，但是我真的很想看到一个包含多个字段的更完整的示例。

简短答案：您的name属性值必须使用schema option_name[array_key]。因此，当您使用...

<input name="option_name[key1]">
<input name="option_name[key2]">

…您在验证函数中获得一个数组作为选项值：

array (
    'key1' => 'some value',
    'key2' => 'some other value'
)

PHP为您做到了，这不是WordPress功能。:)

如何使它与设置API一起使用？

假设，我们需要这个选项页面，并且所有值都应存储在一个选项中并在一个函数中进行验证。

选项页面

我们需要钩子admin_menu和两个函数：一个用于注册页面，一个用于呈现输出。

add_action( 'admin_menu', 't5_sae_add_options_page' );

function t5_sae_add_options_page()
{
    add_options_page(
        'T5 Settings API Example', // $page_title,
        'T5 SAE',                  // $menu_title,
        'manage_options',          // $capability,
        't5_sae_slug',             // $menu_slug
        't5_sae_render_page'       // Callback
    );
}

function t5_sae_render_page()
{
    ?>
    <div class="wrap">
        <h2><?php print $GLOBALS['title']; ?></h2>
        <form action="options.php" method="POST">
            <?php 
            settings_fields( 'plugin:t5_sae_option_group' );
            do_settings_sections( 't5_sae_slug' ); 
            submit_button(); 
            ?>
        </form>
    </div>
    <?php
}

表单action必须为options.php，否则将不会调用验证。看一下PHP的源代码wp-admin/options-permalink.php-有一个隐藏的陷阱do_settings_sections('permalink');-但它不能工作，因为格式action错误。

现在，回到我们的自定义页面。我们使它比WordPress更好。

注册设置，部分和字段

我们admin_init 在需要时挂入并调用注册函数。

if ( ! empty ( $GLOBALS['pagenow'] )
    and ( 'options-general.php' === $GLOBALS['pagenow']
        or 'options.php' === $GLOBALS['pagenow']
    )
)
{
    add_action( 'admin_init', 't5_sae_register_settings' );
}

这里的重要部分是：$GLOBALS['pagenow']必须为options-general.php（对于输出）或options.php（对于验证）。不要在每个请求上调用以下所有代码。大多数教程和几乎所有插件都将其弄错了。

好吧，让我们疯狂地注册：

1. 我们获取页面的选项值，并根据一些默认值解析它们。很基本。

2. 我们使用名称注册设置组plugin:t5_sae_option_group。我喜欢带前缀的名称，它们更易于排序和理解。

3. 然后我们注册两个部分1和2。

4. 我们添加了三个部分，第一部分为两个，第二部分为一个。我们将选项名称和转义值传递给每个字段的回调函数。输出处理程序不应更改数据，而只需添加一些HTML。

function t5_sae_register_settings()
{
    $option_name   = 'plugin:t5_sae_option_name';

    // Fetch existing options.
    $option_values = get_option( $option_name );

    $default_values = array (
        'number' => 500,
        'color'  => 'blue',
        'long'   => ''
    );

    // Parse option values into predefined keys, throw the rest away.
    $data = shortcode_atts( $default_values, $option_values );

    register_setting(
        'plugin:t5_sae_option_group', // group, used for settings_fields()
        $option_name,  // option name, used as key in database
        't5_sae_validate_option'      // validation callback
    );

    /* No argument has any relation to the prvious register_setting(). */
    add_settings_section(
        'section_1', // ID
        'Some text fields', // Title
        't5_sae_render_section_1', // print output
        't5_sae_slug' // menu slug, see t5_sae_add_options_page()
    );

    add_settings_field(
        'section_1_field_1',
        'A Number',
        't5_sae_render_section_1_field_1',
        't5_sae_slug',  // menu slug, see t5_sae_add_options_page()
        'section_1',
        array (
            'label_for'   => 'label1', // makes the field name clickable,
            'name'        => 'number', // value for 'name' attribute
            'value'       => esc_attr( $data['number'] ),
            'option_name' => $option_name
        )
    );
    add_settings_field(
        'section_1_field_2',
        'Select',
        't5_sae_render_section_1_field_2',
        't5_sae_slug',  // menu slug, see t5_sae_add_options_page()
        'section_1',
        array (
            'label_for'   => 'label2', // makes the field name clickable,
            'name'        => 'color', // value for 'name' attribute
            'value'       => esc_attr( $data['color'] ),
            'options'     => array (
                'blue'  => 'Blue',
                'red'   => 'Red',
                'black' => 'Black'
            ),
            'option_name' => $option_name
        )
    );

    add_settings_section(
        'section_2', // ID
        'Textarea', // Title
        't5_sae_render_section_2', // print output
        't5_sae_slug' // menu slug, see t5_sae_add_options_page()
    );

    add_settings_field(
        'section_2_field_1',
        'Notes',
        't5_sae_render_section_2_field_1',
        't5_sae_slug',  // menu slug, see t5_sae_add_options_page()
        'section_2',
        array (
            'label_for'   => 'label3', // makes the field name clickable,
            'name'        => 'long', // value for 'name' attribute
            'value'       => esc_textarea( $data['long'] ),
            'option_name' => $option_name
        )
    );
}

当我们do_settings_sections( 't5_sae_slug' );在页面中调用时，将自动调用这些节和字段的所有回调处理程序。我们已经做到了，所以我们只需要...

打印字段

请注意name属性的构建方式：传递的option_name是第一部分，数组键在方括号中[]。

function t5_sae_render_section_1()
{
    print '<p>Pick a number between 1 and 1000, and choose a color.</p>';
}
function t5_sae_render_section_1_field_1( $args )
{
    /* Creates this markup:
    /* <input name="plugin:t5_sae_option_name[number]"
     */
    printf(
        '<input name="%1$s[%2$s]" id="%3$s" value="%4$s" class="regular-text">',
        $args['option_name'],
        $args['name'],
        $args['label_for'],
        $args['value']
    );
    // t5_sae_debug_var( func_get_args(), __FUNCTION__ );
}
function t5_sae_render_section_1_field_2( $args )
{
    printf(
        '<select name="%1$s[%2$s]" id="%3$s">',
        $args['option_name'],
        $args['name'],
        $args['label_for']
    );

    foreach ( $args['options'] as $val => $title )
        printf(
            '<option value="%1$s" %2$s>%3$s</option>',
            $val,
            selected( $val, $args['value'], FALSE ),
            $title
        );

    print '</select>';

    // t5_sae_debug_var( func_get_args(), __FUNCTION__ );
}
function t5_sae_render_section_2()
{
    print '<p>Makes some notes.</p>';
}

function t5_sae_render_section_2_field_1( $args )
{
    printf(
        '<textarea name="%1$s[%2$s]" id="%3$s" rows="10" cols="30" class="code">%4$s</textarea>',
        $args['option_name'],
        $args['name'],
        $args['label_for'],
        $args['value']
    );
}

哦，我介绍了一个功能t5_sae_debug_var()。这里是：

function t5_sae_debug_var( $var, $before = '' )
{
    $export = esc_html( var_export( $var, TRUE ) );
    print "<pre>$before = $export</pre>";
}

有用的看看我们是否达到了预期。

现在，这很好用，我们只需要一件事：

验证选项数组

因为我们使用了括号符号，所以我们的值是一个数组。我们只需要遍历每个元素并进行验证。

function t5_sae_validate_option( $values )
{
    $default_values = array (
        'number' => 500,
        'color'  => 'blue',
        'long'   => ''
    );

    if ( ! is_array( $values ) ) // some bogus data
        return $default_values;

    $out = array ();

    foreach ( $default_values as $key => $value )
    {
        if ( empty ( $values[ $key ] ) )
        {
            $out[ $key ] = $value;
        }
        else
        {
            if ( 'number' === $key )
            {
                if ( 0 > $values[ $key ] )
                    add_settings_error(
                        'plugin:t5_sae_option_group',
                        'number-too-low',
                        'Number must be between 1 and 1000.'
                    );
                elseif ( 1000 < $values[ $key ] )
                    add_settings_error(
                        'plugin:t5_sae_option_group',
                        'number-too-high',
                        'Number must be between 1 and 1000.'
                    );
                else
                    $out[ $key ] = $values[ $key ];
            }
            elseif ( 'long' === $key )
            {
                $out[ $key ] = trim( $values[ $key ] );
            }
            else
            {
                $out[ $key ] = $values[ $key ];
            }
        }
    }

    return $out;
}

这很丑陋。我不会在生产中使用这样的代码。但是它做了它应该做的：返回一个经过验证的值数组。WordPress将序列化该数组，将其以我们的选项名称存储在数据库中，并在我们调用时将其以非序列化形式返回get_option()。

所有这些都有效，但是不必要的复杂，我们从1998年开始获得标记（<tr valign="top">），并且有很多冗余。

必要时使用设置API。作为一种替代admin_url( 'admin-post.php' )形式，用作表单操作（请查看其源代码），并使用您自己的（可能更精美的）代码创建完整的设置页面。

实际上，编写网络插件时必须这样做，因为设置API在那里不起作用。

还有一些我没有在这里提到的边缘情况和不完整的部分–您将在需要时找到它们。:)