The Settings API
7 likes•11,342 views
The document discusses the WordPress Settings API, which provides functions for creating admin settings pages. It explains how to register plugin settings, add sections and fields to the settings page, sanitize and validate settings values, and reuse form controls. Key functions covered include add_options_page(), register_setting(), add_settings_section(), add_settings_field(), settings_fields(), do_settings_sections(), and submit_button().
![add_action( 'admin_init', 'my_admin_init' );
function my_admin_init() {
register_setting( 'my-settings-group', 'my-setting' );
add_settings_section( 'section-one', 'Section One',
'section_one_callback', 'my-plugin' );
add_settings_field( 'field-one', 'Field One',
'field_one_callback', 'my-plugin', 'section-one' );
}
[...]
get_option( 'my-setting' );
update_option( 'my-setting', ‘my value’ );](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-18-320.jpg)
![add_action( 'admin_init', 'my_admin_init' );
function my_admin_init() {
register_setting( 'my-settings-group', 'my-setting' );
add_settings_section( 'section-one', 'Section One',
'section_one_callback', 'my-plugin' );
add_settings_field( 'field-one', 'Field One',
'field_one_callback', 'my-plugin', 'section-one' );
}
[...]
add_options_page( ..., 'my-plugin', ... );](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-22-320.jpg)
![add_action( 'admin_init', 'my_admin_init' );
function my_admin_init() {
register_setting( 'my-settings-group', 'my-setting' );
add_settings_section( 'section-one', 'Section One',
'section_one_callback', 'my-plugin' );
add_settings_field( 'field-one', 'Field One',
'field_one_callback', 'my-plugin', 'section-one' );
}
[...]
add_options_page( ..., 'my-plugin', ... );](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-26-320.jpg)
![function field_one_callback() {
$setting = esc_attr( get_option( 'my-setting' ) );
echo "<input type='text' name='my-setting' value='$setting' />";
}
[...]
register_setting( 'my-settings-group', 'my-setting' );](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-30-320.jpg)
![function my_options_page() {
?>
<div class="wrap">
<h2>My Plugin Options</h2>
<form action="options.php" method="POST">
<?php settings_fields( 'my-settings-group' ); ?>
<?php do_settings_sections( 'my-plugin' ); ?>
<?php submit_button(); ?>
</form>
</div>
<?php
}
[...]
register_setting( 'my-settings-group', 'my-setting' );](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-34-320.jpg)
![function my_options_page() {
?>
<div class="wrap">
<h2>My Plugin Options</h2>
<form action="options.php" method="POST">
<?php settings_fields( 'my-settings-group' ); ?>
<?php do_settings_sections( 'my-plugin' ); ?>
<?php submit_button(); ?>
</form>
</div>
<?php
}
[...]
add_options_page( ..., 'my-plugin', ... );](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-35-320.jpg)
![function field_one_callback() {
$settings = (array) get_option( 'my-settings' );
$color = esc_attr( $settings['color'] );
echo "<input type='text' name='my-settings[color]'
value='$color' />";
}](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-45-320.jpg)
![function my_settings_sanitize( $input ) {
$input['quantity'] = absint( $input['quantity'] );
return $input;
}](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-48-320.jpg)
![function my_settings_validate( $input ) {
$output = get_option( 'my-settings' );
if ( is_email( $input['email'] ) )
$output['email'] = $input['email'];
else
add_settings_error( 'my-settings', 'invalid-email',
'You have entered an invalid e-mail address.' );
return $output;
}](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-50-320.jpg)
![add_settings_field( 'email', 'E-mail', 'my_text_input',
'my-plugin', 'section-one', array(
'name' => 'my-settings[email]',
'value' => $settings['email'],
)
);](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-52-320.jpg)
![function my_text_input( $args ) {
$name = esc_attr( $args['name'] );
$value = esc_attr( $args['value'] );
echo "<input type='text' name='$name' value='$value' />";
}](https://image.slidesharecdn.com/settings-api-3-121023051935-phpapp01/85/The-Settings-API-53-320.jpg)
The Settings API
- 1. The Settings API Konstantin Kovshenin kovshenin.com
- 2. Setting Field Section
- 8. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 9. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 10. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 11. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); } ref: http://codex.wordpress.org/Roles_and_Capabilities
- 12. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 13. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 14. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 15. register_setting() add_settings_section() add_settings_field() ref: http://codex.wordpress.org/Settings_API
- 16. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 17. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); } ref: http://codex.wordpress.org/Function_Reference/register_setting
- 18. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); } [...] get_option( 'my-setting' ); update_option( 'my-setting', ‘my value’ );
- 19. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); } ref: http://codex.wordpress.org/Function_Reference/add_settings_section
- 20. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 21. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 22. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); } [...] add_options_page( ..., 'my-plugin', ... );
- 23. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); } ref: http://codex.wordpress.org/Function_Reference/add_settings_field
- 24. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 25. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 26. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); } [...] add_options_page( ..., 'my-plugin', ... );
- 27. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 28. add_action( 'admin_init', 'my_admin_init' ); function my_admin_init() { register_setting( 'my-settings-group', 'my-setting' ); add_settings_section( 'section-one', 'Section One', 'section_one_callback', 'my-plugin' ); add_settings_field( 'field-one', 'Field One', 'field_one_callback', 'my-plugin', 'section-one' ); }
- 29. function section_one_callback() { echo 'Some help text goes here.'; }
- 30. function field_one_callback() { $setting = esc_attr( get_option( 'my-setting' ) ); echo "<input type='text' name='my-setting' value='$setting' />"; } [...] register_setting( 'my-settings-group', 'my-setting' );
- 31. add_action( 'admin_menu', 'my_admin_menu' ); function my_admin_menu() { add_options_page( 'My Plugin', 'My Plugin', 'manage_options', 'my-plugin', 'my_options_page' ); }
- 32. function my_options_page() { ?> <div class="wrap"> <h2>My Plugin Options</h2> <form action="options.php" method="POST"> <?php settings_fields( 'my-settings-group' ); ?> <?php do_settings_sections( 'my-plugin' ); ?> <?php submit_button(); ?> </form> </div> <?php }
- 33. function my_options_page() { ?> <div class="wrap"> <h2>My Plugin Options</h2> <form action="options.php" method="POST"> <?php settings_fields( 'my-settings-group' ); ?> <?php do_settings_sections( 'my-plugin' ); ?> <?php submit_button(); ?> </form> </div> <?php }
- 34. function my_options_page() { ?> <div class="wrap"> <h2>My Plugin Options</h2> <form action="options.php" method="POST"> <?php settings_fields( 'my-settings-group' ); ?> <?php do_settings_sections( 'my-plugin' ); ?> <?php submit_button(); ?> </form> </div> <?php } [...] register_setting( 'my-settings-group', 'my-setting' );
- 35. function my_options_page() { ?> <div class="wrap"> <h2>My Plugin Options</h2> <form action="options.php" method="POST"> <?php settings_fields( 'my-settings-group' ); ?> <?php do_settings_sections( 'my-plugin' ); ?> <?php submit_button(); ?> </form> </div> <?php } [...] add_options_page( ..., 'my-plugin', ... );
- 36. function my_options_page() { ?> <div class="wrap"> <h2>My Plugin Options</h2> <form action="options.php" method="POST"> <?php settings_fields( 'my-settings-group' ); ?> <?php do_settings_sections( 'my-plugin' ); ?> <?php submit_button(); ?> </form> </div> <?php } ref: http://codex.wordpress.org/Function_Reference/submit_button
- 38. Recap
- 42. Using Arrays with the Settings API
- 43. register_setting( 'my-settings-group', 'color' ); register_setting( 'my-settings-group', 'size' ); register_setting( 'my-settings-group', 'quantity' );
- 45. function field_one_callback() { $settings = (array) get_option( 'my-settings' ); $color = esc_attr( $settings['color'] ); echo "<input type='text' name='my-settings[color]' value='$color' />"; }
- 46. Sanitization
- 47. register_setting( 'my-settings-group', 'my-settings', 'my_settings_sanitize' );
- 48. function my_settings_sanitize( $input ) { $input['quantity'] = absint( $input['quantity'] ); return $input; }
- 49. Validation
- 50. function my_settings_validate( $input ) { $output = get_option( 'my-settings' ); if ( is_email( $input['email'] ) ) $output['email'] = $input['email']; else add_settings_error( 'my-settings', 'invalid-email', 'You have entered an invalid e-mail address.' ); return $output; }
- 51. Reusing Controls with the Settings API
- 52. add_settings_field( 'email', 'E-mail', 'my_text_input', 'my-plugin', 'section-one', array( 'name' => 'my-settings[email]', 'value' => $settings['email'], ) );
- 53. function my_text_input( $args ) { $name = esc_attr( $args['name'] ); $value = esc_attr( $args['value'] ); echo "<input type='text' name='$name' value='$value' />"; }