Я использую книгу разработки плагинов Wrox WordPress в качестве основного справочника для начала работы с новым плагином, и я понимаю, что все настройки могут быть сохранены как 1 массив, но книга не дает пример этого и всех вещей, которые я поиск в Интернете, кажется, сильно отличается от одного примера к другому. Вторая половина поста Константина приближает меня, но мне бы очень хотелось увидеть более полный пример с несколькими полями.
Краткий ответ: nameзначения вашего атрибута должны использовать схему 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(для проверки). Не вызывайте весь следующий код на каждый запрос. Большинство уроков и почти все плагины ошибаются.
Хорошо, давайте регистрироваться как сумасшедшие:
Мы выбираем значения параметров для нашей страницы и сравниваем их с некоторыми значениями по умолчанию. Довольно простой.
Мы регистрируем группу настроек с именем plugin:t5_sae_option_group. Мне нравятся префиксные имена, их легче сортировать и понимать таким образом.
Затем мы регистрируем два раздела, 1 и 2.
И мы добавляем три раздела, два для первого раздела, один для второго. Мы передаем имя опции и экранированное значение в функции обратного вызова для каждого поля. Обработчики вывода не должны изменять данные, просто добавьте немного 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 настроек там не работает.
Есть также некоторые крайние случаи и неполные части, которые я не упомянул здесь - вы найдете их, когда они понадобятся. :)
basename( $_SERVER['REQUEST_URI'] ).