Two Ways Of Creating WordPress Options Pages

I would strongly recommend following the Theme Review guidelines for Theme Settings and Data Security. (If you intend for your Theme to be hosted in the WPORG repository, you will be required to follow these guidelines.

Here’s a brief summary:

  • Themes are required to prefix all options, custom functions, custom variables, and custom constants with theme-slug (or appropriate variant).
  • Theme are required to implement Theme Options and Theme Settings pages deliberately, rather than relying on copy-and-paste scripts from website tutorials.
  • Themes are required to use the add_theme_page() function to add the Theme Settings Page to the Appearance menu, rather than using add_menu_page() to add a top-level menu.
  • Themes are required to use the edit_theme_options capability for add_theme_page(), rather than rely on a role (e.g. “administrator”), or a different capability (e.g. “edit_themes”, “manage_options”) for the capability to add the settings page.
  • Themes are required to save options in a single array, rather than create multiple options for its settings page. Use of set_theme_mod and get_theme_mod handles this for you, as does using the Settings API.
  • For checkboxes and select options, Themes are required to use the checked() and selected() functions for outputting checked=”checked” and selected=”selected”, respectively.
  • Themes are required to validate and sanitize all untrusted data before entering data into the database, and to escape all untrusted data before being output in the Settings form fields or in the Theme template files (see: Data Validation)
  • Themes are required to use esc_attr() for text inputs and esc_html() (or esc_textarea() in WP 3.1) for textareas.
  • Themes are required to provide explicit Settings-page nonce checking, if not using the Settings API (see: WordPress Nonces)
  • Themes are recommended to use the Settings API to get and save form input data rather than rely on $_POST and $_REQUEST data directly.

References

EDIT

So, to clarify: you don’t have to choose either/or here. The Settings API can handle both approaches simultaneously – and in fact, does so quite elegantly.

The add_settings_field() call can be generated dynamically, and can use a single callback, with a switch to output field-type-specific form field markup. Here’s how I implement it.

Related Posts:

  1. get_option() vs get_theme_mod(): Why is one slower?
  2. wp_editor() fields on Theme Options Page not saving
  3. Adding a checkbox to the theme customizer
  4. Theme Options Panels, What are some good examples from Frameworks or Premium Themes? [closed]
  5. Where are a theme’s options stored and can I export them to be imported into freshly installed themes?
  6. Can I install Analytics before deciding on a theme?
  7. Options Framework options not being output
  8. Using update_option() and get_option() is echoing escaped strings
  9. Theme Options page with tabs
  10. Outputting results from select box option in options panel
  11. Theme option : having the ability to select among several predefined headers
  12. Upload multiple images via theme options [closed]
  13. PHP stylesheet cannot use standard WP functions
  14. Display user HTML on website
  15. Need help understanding/coding with Settings API
  16. Setting up a members area
  17. WordPress: update_option, don’t update empty options?
  18. How to create dependent field in Customizer?
  19. How can I insert some extra validation into the theme options’ validation function using add_filter?
  20. How to add an alternative style sheet as a theme option?
  21. Disable image resizing on specific upload fields
  22. Put standard wordpress options into a theme options panel?
  23. How can I get my options in json response?
  24. Removing \\\ from Saved Data
  25. Use of check_admin_referer with theme options and options.php
  26. WordPress custom options storing?
  27. WordPress admin panel framework weird layout on server side
  28. get option framework options returns Call to undefined function of_get_option()
  29. Theme Customizier sanitize_callback not working
  30. Getting the ID of header image, even when set to random
  31. Theme Options page not saving data correctly
  32. Getting error to display radio button value in General Settings page
  33. Create an Options page with two image upload fields
  34. Only allow site url in text field using wp_kses/wp_filter_nohtml_kses?
  35. Additional custom header image
  36. Options Theme – WordPress [closed]
  37. Settings API settings section not appearing
  38. Is there a function to add additional options to the Twentyeleven option page?
  39. How to set a default theme option after installing theme?
  40. How to get of_get_option() inside the inc folder file
  41. Retrieve uploaded image attibutes value from option tree theme options
  42. WordPress theme options framework, I can’t read them in my templates
  43. Display and hide content using checkbox in Options Framework Theme
  44. How do I remove the page listing menu in the header in the Twenty Ten Theme?
  45. My title won’t update
  46. Multiple options in the options_value field of the wp_options table
  47. Shorter admin url for options page
  48. How to use WP Theme Option: Custom_Backgrounds on specific element?
  49. How can I create a rearrangeable list of items like OptionTree offers with the Theme Customization API?
  50. WordPress Theme Settings Page
  51. Theme options are they necessary
  52. The best place of the code for creating a robots.txt file
  53. How do I display a WP Option from an array?
  54. Blogname and Blogdescription in Pagelines DMS Options Panel
  55. Can Settings API setting generate other settings?
  56. Cannot modify headers
  57. How to get functions.php to talk to options.php
  58. Options Framework not saving options correctly
  59. How to use checked() function with multiple check box group? How to properly sanitize that checkbox group?
  60. Admin menus and submenus
  61. Theme Options Page – Select, Radio, Tabs
  62. WordPress karma theme shortcodes not working
  63. WordPress built-in Custom Background
  64. Weird undefined index: id,std notices. How to fix it?
  65. Splitting an eCommerce store from the WordPress Theme
  66. How do I have my widgets in a Sidebar for my http://localhost/wordpress/
  67. Theme options period being replaced
  68. Do not want to display random category. Want to exclude a few or make post show only the category I want [closed]
  69. Theme options on CPT
  70. Can’t save multiple sections on one page with register_setting
  71. Moving wordpress site from one machine into another
  72. What should I use to store options for a single blog on a network site?
  73. Delete Transient when clicking ‘Save Changes’ on options page
  74. Build Form on Dashboard
  75. How to make a hyperlink conditional according to whether you are logged in or not
  76. How to give site owner the ability to change to footer text via theme options (1 post)
  77. Changing the layout of a custom options page
  78. Make Theme Options Menu item more easily / directly accessible
  79. Is there a better way to define options for custom fields in an admin panel?
  80. File input returns null in theme options array
  81. Cloning/replicating/copying dashboard admin settings
  82. Can’t add options to db
  83. Activating a Theme Options page to Editor – not working [closed]
  84. Slightly modified options framework Colour picker
  85. Set option to show the slider in post – WP
  86. Cannot retrieve theme options on index.php
  87. IF statement not falling over to ELSE with Options Framework
  88. Theme options: Display ID of page options
  89. Trouble saving wp_dropdown_pages()
  90. Notice: Undefined index: in options-framework.php
  91. Notice: Trying to get property of non-object in options.php
  92. Is it good idea to combine Options FrameWork with Hybrid Core Framework
  93. wordpress theme option in other templates
  94. Need some PHP schoolin’! passing var to url and the old options table
  95. How to support special characters in text field?
  96. Multiple Custom Headers
  97. Why has my WordPress theme disappeared from my WordPress site?
  98. Multiple instances of Redux WP Framework [closed]
  99. Can I call Options Framework in footer.php?
  100. Theme Options wp_editor breaks with 6.0.2 update

Leave a Comment