{"id":1451,"date":"2009-12-19T20:16:23","date_gmt":"2009-12-20T01:16:23","guid":{"rendered":"http:\/\/judykat.com\/ken\/?p=1451"},"modified":"2012-03-31T20:41:46","modified_gmt":"2012-04-01T00:41:46","slug":"how-to-add-an-options-form-to-a-wordpress-theme-using-settings_fields","status":"publish","type":"post","link":"https:\/\/judykat.com\/ken-judy\/how-to-add-an-options-form-to-a-wordpress-theme-using-settings_fields\/","title":{"rendered":"How to add an options form to a wordpress theme using settings_fields"},"content":{"rendered":"

I spent some time today modifying a WordPress theme<\/a> to take configuration properties. <\/p>\n

I want one theme that I can quickly re-configure to create multiple blogs along different topics with different color\/graphic schemes. I want easy maintenance so I’d love to share one instance of the theme across these different instances. <\/p>\n

We’re using enough different plugins that WordPress Mu<\/a> isn’t yet worth fighting. So database options and the Settings API<\/a> seemed the best way.<\/p>\n

The documentation on how to extend a theme this way is not so easy to find but there are plenty of examples. They tend to break the process into steps but don’t give as much sense of what you actually get and how to use it.<\/p>\n

I based my code on this example: http:\/\/blog.starscapetheme.com\/2008\/05\/31\/create-settings-page-for-theme\/<\/span><\/p>\n

After the fact, I found this description which seems well written: http:\/\/www.pixelace.com\/2009\/theme-options-for-wordpress-27\/<\/span><\/p>\n

I created a menu item and a corresponding properties form:<\/p>\n

\n\"Wordpress\"Wordpress\n<\/div>\n
 <\/div>\n

My form adds three properties which are stored in the WordPress wp_options table and easily exposed on template pages<\/p>\n

<link rel=\"stylesheet\" href=\"<?php $options = get_option('vertical'); echo $options['vertical_custom_css_url']; ?>\" type=\"text\/css\" media=\"screen\" \/><\/code><\/p>\n

Here’s the actual code I added to the functions.php page of the theme. If you don’t have a functions.php you can just create one in your theme folder. You need to make sure the code below is wrapped in “<?php” “?>” tags.<\/p>\n

\/\/encapsulate the logic into a class<\/span>
$cpanel = new ControlPanel();<\/p>\n

class<\/span> ControlPanel<\/span> {
\/* static array to contain default values
the values set an additional css to override standard css in the theme
as well as an image and link that is rendered in the sidebar. These
three settings allow me to use the same theme with minor variations
on different blogs on different topics but with very similar looks and feels *\/<\/span>
var<\/span> $default_settings = Array(
‘vertical_custom_css_url’<\/span> => ”<\/span>,
‘topic_banner_img’<\/span> => ‘\/images\/banner.jpg’<\/span>,
‘topic_url’<\/span> => ‘http:\/\/www.judykat.com\/ken’<\/span><\/p>\n

);
\/\/constructor<\/span>
function<\/span> ControlPanel()<\/span>
{
\/\/hook to add a menu item in the Theme’s area of the admin sidebar<\/span>
add_action(‘admin_menu’<\/span>, array(&<\/span>$this, ‘vertical_admin_menu’<\/span>));
\/* if options are not already created in the database, add them and set to default values
this creates a single database entry in wp_options with key vertical and
values a hash of key\/value pairs *\/<\/span>
if<\/span> (!<\/span>is_array(get_option(‘vertical’<\/span>)))
add_option(‘vertical’<\/span>, $this->default_settings);
\/\/load the existing options into an array accessible as a property of this instance of ControlPanel<\/span>
$this->options = get_option(‘vertical’<\/span>);
}
\/\/the function that ties an html form to the hook defined in the constructor.<\/span>
function<\/span> vertical_admin_menu() {
add_theme_page(‘Vertical Theme Control Panel’<\/span>, ‘Customize Theme’<\/span>, ‘edit_themes’<\/span>, “vertical”<\/span>, array(&<\/span>$this, ‘vertical_theme_page’<\/span>));
}
\/\/function that defines the form for viewing and setting properties for the theme.<\/span>
function<\/span> vertical_theme_page() {
\/\/if the form is being submitted, update the options in the database<\/span>
if<\/span> ( isset( $_POST[‘submit’<\/span>] ) ) {
\/\/if the “Save Changes”<\/span> button was clicked, set the user entered values from the form<\/span>
if<\/span> (‘Save Changes’<\/span> ==<\/span> $_POST[‘submit’<\/span>]) {
$this->options[“vertical_custom_css_url”<\/span>] = $_POST[‘vertical_custom_css_url’<\/span>];
$this->options[“topic_banner_img”<\/span>] = $_POST[‘topic_banner_img’<\/span>];
$this->options[“topic_url”<\/span>] = $_POST[‘topic_url’<\/span>];
$state=“saved”<\/span>;
} \/\/else if “Defaults”<\/span> was clicked, reset values to default<\/span>
else<\/span> if<\/span> (‘Defaults’<\/span> ==<\/span> $_POST[‘submit’<\/span>]) {
$this->options[“vertical_custom_css_url”<\/span>] = $this->default_settings[‘vertical_custom_css_url’<\/span>];
$this->options[“topic_banner_img”<\/span>] = $this->default_settings[‘topic_banner_img’<\/span>];
$this->options[“topic_url”<\/span>] = $this->default_settings[‘topic_url’<\/span>];
$state=“reverted to defaults”<\/span>;
} \/\/commit the changes to the database<\/span>
update_option(‘vertical’<\/span>, $this->options);
\/\/render a status message of the above actions in the standard WordPress admin dialog box at the top of the form.<\/span>
echo ‘<div class=“updated fade”<\/span> id=“message”<\/span> style=“background-color: rgb(255, 251, 204); width: 300px; margin-left: 20px”<\/span>><\/span><p><\/span>Settings <strong><\/span>‘.$state.’<\/strong><\/span>.<\/p><\/span><\/div><\/span>‘;
}
\/\/the actual html form in standard markup to appear standard in the WordPress Admin<\/span>
?>
<div class=‘wrap’<\/span>><\/span>
<h2><\/span><?php _e(‘Customize Vertical Theme’<\/span>); ?><\/span><\/h2><\/span>
<div id=“header”<\/span>><\/span>
<div id=“headwrap”<\/span>><\/span>
<div id=“header”<\/span>><\/span>
<div id=“headerimg”<\/span>><\/span>
<h1><\/span><?php bloginfo(‘name’<\/span>); ?><\/span><\/h1><\/span>
<div class=“description”<\/span>><\/span><?php bloginfo(‘description’<\/span>); ?><\/span><\/div><\/span>
<\/div><\/span>
<\/div><\/span>
<\/div><\/span>
<\/div><\/span>
<br><\/span>
<form id=“vertical-settings-form”<\/span> method=“post”<\/span> action=“”<\/span>><\/span>
<?php settings_fields( ‘vertical-settings’<\/span> ); ?><\/span>
<table class=“form-table”<\/span>><\/span>
<tr valign=“top”<\/span>><\/span>
<th scope=“row”<\/span>><\/span>Path to Vertical CSS file:<\/th><\/span>
<td><\/span>
<input size=“70”<\/span> type=“text”<\/span> name=“vertical_custom_css_url”<\/span> id=“vertical_custom_css_url”<\/span> value=“<?php echo $this-><\/span>options[“vertical_custom_css_url”]; ?>”<\/span> \/>
<br\/><\/span><small><\/span>example: <?php echo(str_replace(get_bloginfo(‘url’<\/span>),“”<\/span>,get_bloginfo(‘template_url’<\/span>).‘\/’<\/span>.str_replace(” “<\/span>, “-“<\/span>,strtolower(wptexturize(get_bloginfo( ‘name’<\/span> )))))); ?>\/style.css<\/small><\/span>
<\/td><\/span>
<\/tr><\/span>
<tr valign=“top”<\/span>><\/span>
<th scope=“row”<\/span>><\/span>Path to Category Page:<\/th><\/span>
<td><\/span>
<input size=“70”<\/span> type=“text”<\/span> name=“topic_url”<\/span> id=“topic_url”<\/span> value=“<?php echo $this-><\/span>options[“topic_url”]; ?>”<\/span> \/>
<br\/><\/span><small><\/span>example: http:\/\/www.judykat.com\/ken<\/small><\/span>
<\/td><\/span>
<\/tr><\/span>
<tr valign=“top”<\/span>><\/span>
<th scope=“row”<\/span>><\/span>Path to Category Banner:<\/th><\/span>
<td><\/span>
<input size=“70”<\/span> type=“text”<\/span> name=“topic_banner_img”<\/span> id=“topic_banner_img”<\/span> value=“<?php echo $this-><\/span>options[“topic_banner_img”]; ?>”<\/span> \/>
<br\/><\/span><small><\/span>example: <?php echo(str_replace(get_bloginfo(‘url’<\/span>),“”<\/span>,get_bloginfo(‘template_url’<\/span>).‘\/’<\/span>.str_replace(” “<\/span>, “-“<\/span>,strtolower(wptexturize(get_bloginfo( ‘name’<\/span> )))))); ?>\/images\/banner.jpg<\/small><\/span>
<\/td><\/span>
<\/tr><\/span>
<\/table><\/span>
<p class=“submit”<\/span>><\/span>
<input type=“submit”<\/span> name=“submit”<\/span> class=“button-primary”<\/span> value=“<?php _e(‘Save Changes’) ?><\/span>“<\/span> \/>
<input type=“submit”<\/span> name=“submit”<\/span> class=“button-primary”<\/span> value=“<?php _e(‘Defaults’) ?><\/span>“<\/span> \/>
<\/p><\/span>
<input type=“hidden”<\/span> name=“saved”<\/span> value=“true”<\/span>><\/span>
<\/form><\/span>
<\/div><\/span>
<?php
}
}<\/div>\n","protected":false},"excerpt":{"rendered":"

I spent some time today modifying a WordPress theme to take configuration properties. I want one theme that I can quickly re-configure to create multiple blogs along different topics with different color\/graphic schemes. I want easy maintenance so I’d love … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[30],"tags":[687,109,101,108,107,96],"class_list":["post-1451","post","type-post","status-publish","format-standard","hentry","category-software-development","tag-html","tag-options","tag-php","tag-settings","tag-themes","tag-wordpress"],"aioseo_notices":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/posts\/1451","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/comments?post=1451"}],"version-history":[{"count":35,"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/posts\/1451\/revisions"}],"predecessor-version":[{"id":2362,"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/posts\/1451\/revisions\/2362"}],"wp:attachment":[{"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/media?parent=1451"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/categories?post=1451"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/judykat.com\/ken-judy\/wp-json\/wp\/v2\/tags?post=1451"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}