{"id":2426,"date":"2012-07-25T14:04:04","date_gmt":"2012-07-25T20:04:04","guid":{"rendered":"http:\/\/bililite.com\/blog\/?p=2426"},"modified":"2012-07-31T14:28:57","modified_gmt":"2012-07-31T20:28:57","slug":"simplifying-the-settings-api-for-wordpress","status":"publish","type":"post","link":"https:\/\/bililite.com\/blog\/2012\/07\/25\/simplifying-the-settings-api-for-wordpress\/","title":{"rendered":"Simplifying the Settings API for WordPress"},"content":{"rendered":"

They suckered me into helping redesign the website for my daughter's school<\/a> (don't worry—if you're looking at it before July 27, 2012 it's not my design), and they wanted to go with a WordPress site so lots of people could edit it easily. It seemed like a good idea, but it took 4 weeks of tweaking to get it to the point that everyone liked it.<\/p>\r\n

One thing I wanted to do was have a single settings page<\/a> for all the relevant options (secretary's email, reCaptcha<\/a> info for forms), etc. While there are tutorials<\/a> out there, nothing really hung together for me until I started playing with it. To make it simple, I created a single function that would implement all the settings. It uses PHP 5.3, with namespaces<\/a> and closures<\/a> (both of which make life much easier by not polluting the global namespace).<\/p>\r\n

The key is to put all the plugin's code under a single unique namespace, and use that namespace as the index for all the options.<\/p>\r\n

Calling it is simple:<\/p>\r\n

namespace MyUniqueName;\r\n$title=\"Title for the Plugins Page (short enough to fit in the settings menu)\";\r\nplugin_settings($title, $defaults);\r\n<\/code><\/pre>\r\n
$defaults<\/code> is an array of 'key' => $array<\/code>, where the $array<\/code> is array('default value', 'descriptive text', 'callback function')<\/code>, where 'callback function' is the callable<\/a> used to display the input element<\/a> for that option. It can be a string representing the name of the function (prepended with the namespace!) or an anonymous function itself. It is passed a single argument, array('key' => $key)<\/code>, where $key<\/code> is the key used in the original array.<\/p>\r\n
Use the options as $options = get_option(__NAMESPACE__); $my_option = $options[$key];<\/code>.<\/p>\r\n
A simple callback function for a text box is:<\/p>\r\n
function text_callback($args){\r\n\t$name = $args['key'];\r\n\t$ns = __NAMESPACE__; \/\/ note that __NAMESPACE__ is used as the index for the options in the database\r\n\t$options = get_option($ns);\r\n\techo "<input name='{$ns}[$name]' value='{$options[$name]}' \/>";\t\t\r\n};<\/code><\/pre>\r\n
And to make it simpler, I created a function generator to do exactly this: textbox($size=40)<\/code> returns a callback function to output a text box of $size<\/code> characters.<\/p>\r\n
So a sample $defaults<\/code> would be:<\/p>\r\n
$defaults = array(\r\n  'email' => array('info@example.org', 'Main Email Address', textbox()),\r\n  'principal' => array('Ed Rooney', 'Principal\\'s Full name', textbox(80))\r\n);<\/code><\/pre>\r\n\r\n
The code for the function is (note that it has to go in the main plugin file<\/a>, since it uses __FILE__<\/code>) (unfortunately it mixes HTML and PHP and confuses the syntax highighter terribly):<\/p>\r\n
function plugin_settings ($title, $defaults){\r\n\r\n\tregister_activation_hook(__FILE__, function() use ($defaults) {\r\n\t\t$options = get_option(__NAMESPACE__);\r\n\t\tif (empty($options)) $options = array();\r\n\t\tforeach ($defaults as $key => $option){\r\n\t\t\tif (!isset($options[$key])) $options[$key] = $option[0];\r\n\t\t}\r\n\t\tupdate_option (__NAMESPACE__, $options);\r\n\t});\r\n\r\n\t\/\/ this gets put in the database, so it can't use a closure\r\n\tregister_uninstall_hook(__FILE__, create_function('', 'delete_option('.__NAMESPACE__.');'));\r\n\r\n\tadd_action('admin_menu', function () use ($title, $defaults) {\r\n\t\tif (wp_verify_nonce($_POST['_wpnonce'], __NAMESPACE__.'-reset')){\r\n\t\t\t$options = get_option(__NAMESPACE__);\r\n\t\t\tforeach ($defaults as $key=>$option){\r\n\t\t\t\t$options[$key] = $option[0];\r\n\t\t\t}\r\n\t\t\tupdate_option(__NAMESPACE__, $options);\r\n\t\t}\r\n\t\tadd_options_page($title, $title, 'manage_options', __NAMESPACE__, function() use ($title){\r\n\t\t\t?><h2><?=$title?><\/h2>\r\n\t\t\t<form method=POST action="options.php">\r\n\t\t\t\t<? settings_fields(__NAMESPACE__); ?>\r\n\t\t\t\t<? do_settings_sections(__NAMESPACE__); ?>\r\n\t\t\t\t<input name="Submit" type="submit" value="<? esc_attr_e('Save Changes'); ?>" \/>\r\n\t\t\t<\/form>\r\n\t\t\t<form method=POST>\r\n\t\t\t\t<? wp_nonce_field(__NAMESPACE__.'-reset'); ?>\r\n\t\t\t\t<input name="Reset" type="submit" value="<? esc_attr_e('Revert to Defaults'); ?>" \/>\r\n\t\t\t<\/form><?\r\n\t\t});\r\n\t});\r\n\r\n\tadd_action('admin_init', function () use ($defaults) {\r\n\t\t$ns = __NAMESPACE__; \/\/ to save typing and allow in-string replacement\r\n\t\tregister_setting($ns, $ns);\r\n\t\tadd_settings_section('', '', function(){}, $ns);\r\n\t\tforeach ($defaults as $key => $option){\r\n\t\t\tif (isset($option[2])){\r\n\t\t\t\tadd_settings_field("$ns_$key", $option[1], $option[2], $ns, '', array('label_for'=>"$ns_$key", 'key'=>$key));\r\n\t\t\t}\r\n\t\t}\r\n\t});\r\n}\r\n\r\nfunction textbox($size=40){\r\n\t\/\/ returns a textbox generator\r\n\treturn function($args) use ($size) {\r\n\t\t$name = $args['key'];\r\n\t\t$ns = __NAMESPACE__;\r\n\t\t$options = get_option($ns);\r\n\t\techo "<input name='{$ns}[$name]' value='{$options[$name]}' size=$size \/>";\t\t\r\n\t};\r\n}\r\n<\/code><\/pre>","protected":false},"excerpt":{"rendered":"They suckered me into helping redesign the website for my daughter's school (don't worry—if you're looking at it before July 27, 2012 it's not my design), and they wanted to go with a WordPress site so lots of people could edit it easily. It seemed like a good idea, but it took 4 weeks of […]","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[9],"tags":[],"_links":{"self":[{"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/posts\/2426"}],"collection":[{"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/comments?post=2426"}],"version-history":[{"count":16,"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/posts\/2426\/revisions"}],"predecessor-version":[{"id":2444,"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/posts\/2426\/revisions\/2444"}],"wp:attachment":[{"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/media?parent=2426"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/categories?post=2426"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bililite.com\/blog\/wp-json\/wp\/v2\/tags?post=2426"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}