Ustawienia API z przykładem tablic

Korzystam z książki programistów wtyczek Wrox WordPress jako głównego źródła informacji na temat rozpoczynania pracy z nową wtyczką i rozumiem, że wszystkie ustawienia można zapisać jako 1 tablicę, ale książka nie podaje żadnego przykładu tego i wszystkich innych rzeczy znajdowanie w sieci wydaje się tak różne w różnych przykładach. Druga połowa postu Konstantina przybliża mnie, ale naprawdę chciałbym zobaczyć pełniejszy przykład z wieloma polami.

Krótka odpowiedź: namewartości atrybutów muszą korzystać ze schematu option_name[array_key]. Więc kiedy używasz…

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

… Otrzymujesz tablicę jako wartość opcji w swojej funkcji sprawdzania poprawności:

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

PHP robi to za Ciebie, nie jest to funkcja WordPress. :)

Jak sprawić, by działało z interfejsem API ustawień?

Powiedzmy, że chcemy tej strony opcji, a wszystkie wartości powinny być przechowywane w jednej opcji i sprawdzane w jednej funkcji.

Strona opcji

Potrzebujemy haka admin_menui dwóch funkcji: jednej do zarejestrowania strony, drugiej do renderowania wyniku.

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
}

Formularz actionmusi być options.php, inaczej walidacja nie zostanie wywołana. Spójrz na źródło PHP wp-admin/options-permalink.php- jest ukryta pułapka do_settings_sections('permalink');- ale nie może działać, ponieważ formularz actionjest nieprawidłowy.

Teraz wróć do naszej niestandardowej strony. Robimy to lepiej niż WordPress.

Zarejestruj ustawienia, sekcje i pola

Wchodzimy w to, admin_init kiedy go potrzebujemy i wywołujemy funkcję rejestracji.

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

Ważną częścią tutaj jest: $GLOBALS['pagenow']musi być options-general.php(dla danych wyjściowych) lub options.php(dla weryfikacji). Nie należy wywoływać całego następującego kodu przy każdym żądaniu. Większość samouczków i prawie wszystkie wtyczki źle to robią.

Ok, zarejestrujmy się jak szalony:

1. Pobieramy wartości opcji dla naszej strony i analizujemy je względem niektórych wartości domyślnych. Całkiem proste.

2. Rejestrujemy grupę ustawień o nazwie plugin:t5_sae_option_group. Lubię prefiksy, łatwiej je sortować i rozumieć w ten sposób.

3. Następnie rejestrujemy dwie sekcje, 1 i 2.

4. I dodajemy trzy sekcje, dwie dla pierwszej sekcji, jedną dla drugiej. Mijamy nazwę opcji i uciekł wartość do funkcji wywołania zwrotnego dla każdego pola. Procedury obsługi danych wyjściowych nie powinny zmieniać danych, wystarczy dodać trochę 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
        )
    );
}

Wszystkie te procedury obsługi oddzwaniania dla sekcji i pól będą wywoływane automatycznie, gdy zadzwonimy do_settings_sections( 't5_sae_slug' );na naszej stronie. Już to zrobiliśmy, więc musimy tylko…

Wydrukuj pola

Zauważ, jak namebudowane są atrybuty: przekazana option_namejest pierwsza część, klawisz tablicy następuje w nawiasach kwadratowych [].

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

Och, wprowadziłem funkcję t5_sae_debug_var(). Oto on:

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

Przydatne, aby zobaczyć, czy mamy to, czego się spodziewaliśmy.

Teraz działa całkiem dobrze, potrzebujemy tylko jednej rzeczy:

Sprawdź poprawność tablicy opcji

Ponieważ użyliśmy notacji nawiasowej, naszą wartością jest tablica. Musimy tylko przejść przez każdy element i zweryfikować go.

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

To jest raczej brzydkie; Nie używałbym takiego kodu w produkcji. Ale robi to, co powinien: zwraca sprawdzoną tablicę wartości. WordPress serializuje tablicę, przechowuje ją pod naszą nazwą opcji w bazie danych i zwraca niezserializowaną, gdy zadzwonimy get_option().

Wszystko to działa, ale jest to niepotrzebnie skomplikowane, otrzymujemy znaczniki od 1998 roku (<tr valign="top"> ) i wiele redundancji.

W razie potrzeby użyj interfejsu API ustawień. Jako alternatywne zastosowanieadmin_url( 'admin-post.php' ) jako działanie formularza (spójrz na jego źródło) i utwórz pełną stronę ustawień z własnym, prawdopodobnie bardziej eleganckim kodem.

W rzeczywistości musisz to zrobić, pisząc wtyczkę sieciową, ponieważ interfejs API ustawień tam nie działa.

Są też niektóre przypadki krawędzi i niekompletne części, o których tu nie wspomniałem - znajdziesz je, gdy będziesz ich potrzebować. :)