Exemplo de API de configurações com matrizes

Estou usando o livro de desenvolvimento de plugins do Wrox WordPress como referência principal para começar a usar um novo plug-in e entendo que todas as configurações podem ser salvas como 1 matriz, mas o livro não fornece um exemplo disso e de todas as coisas que estou encontrar na web parece tão diferente de um exemplo para outro. A segunda metade de um post de Konstantin me aproxima, mas eu realmente gostaria de ver um exemplo mais completo com vários campos.

Resposta curta: seus namevalores de atributo devem usar o esquema option_name[array_key]. Então, quando você usa ...

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

… Você obtém uma matriz como valor da opção na sua função de validação:

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

O PHP faz isso por você, esse não é um recurso do WordPress. :)

Como fazer isso funcionar com a API de configurações?

Digamos, queremos essa página de opções e todos os valores devem ser armazenados em uma opção e validados em uma função.

A página de opções

Precisamos do gancho admin_menue duas funções: uma para registrar a página e outra para renderizar a saída.

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
}

O formulário actiondeve ser options.phpou a validação não será chamada. Veja a fonte PHP de wp-admin/options-permalink.php- existe uma armadilha oculta do_settings_sections('permalink');- mas ela não funciona porque o formulário actionestá errado.

Agora, volte para a nossa página personalizada. Tornamos isso melhor que o WordPress.

Registrar configurações, seções e campos

Ligamos admin_init quando precisamos e chamamos uma função de registro.

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

A parte importante aqui é: $GLOBALS['pagenow']deve ser options-general.php(para a saída) ou options.php(para a validação). Não chame todo o código a seguir em cada solicitação. A maioria dos tutoriais e quase todos os plugins entendem errado.

Ok, vamos registrar como um louco:

1. Buscamos os valores das opções para nossa página e os analisamos em relação a alguns padrões. Bastante básico.

2. Registramos um grupo de configurações com o nome plugin:t5_sae_option_group. Eu gosto de nomes prefixados, eles são mais fáceis de classificar e entender dessa maneira.

3. Em seguida, registramos duas seções, 1 e 2.

4. E adicionamos três seções, duas para a primeira seção e uma para a segunda. Passamos o nome da opção e o valor escapado para as funções de retorno de chamada para cada campo. Os manipuladores de saída não devem alterar os dados, basta adicionar um pouco de 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
        )
    );
}

Todos os manipuladores de retorno de chamada para as seções e campos serão chamados automaticamente quando ligarmos do_settings_sections( 't5_sae_slug' );em nossa página. Já fizemos isso, então precisamos apenas…

Imprimir os campos

Observe como os nameatributos são construídos: o passado option_nameé a primeira parte, a chave do array segue entre colchetes [].

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']
    );
}

Eu introduzi uma função t5_sae_debug_var(). Aqui está:

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

Útil para ver se conseguimos o que esperávamos.

Agora, isso funciona muito bem, precisamos de apenas uma coisa:

Validar a matriz de opções

Como usamos a notação entre colchetes, nosso valor é uma matriz. Nós apenas temos que percorrer cada elemento e validá-lo.

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;
}

Isso é feio; Eu não usaria esse código na produção. Mas faz o que deveria: retorna uma matriz validada de valores. O WordPress serializa a matriz, armazena-a sob o nome de nossa opção no banco de dados e a retorna sem serialização, quando chamamos get_option().

Tudo isso funciona, mas é desnecessário e complicado, recebemos marcação de 1998 ( <tr valign="top">) e muitos redundâncias.

Use a API de configurações quando precisar. Como alternativa, use admin_url( 'admin-post.php' )como ação de formulário (veja a fonte) e crie a página de configurações completa com seu próprio código, provavelmente mais elegante.

Na verdade, você precisa fazer isso quando escreve um plug-in de rede, porque a API de configurações não funciona lá.

Existem também alguns casos extremos e partes incompletas que não mencionei aqui - você os encontrará quando precisar deles. :)