2011-04-26 18:52:18 -04:00
< ? php
/**
* Twenty Eleven Theme Options
*
* @ package WordPress
2011-05-18 15:06:09 -04:00
* @ subpackage Twenty_Eleven
2011-04-28 04:06:57 -04:00
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
/**
2011-04-28 04:06:57 -04:00
* Properly enqueue styles and scripts for our theme options page .
*
* This function is attached to the admin_enqueue_scripts action hook .
*
* @ since Twenty Eleven 1.0
*
2011-04-26 18:52:18 -04:00
*/
2011-04-28 04:06:57 -04:00
function twentyeleven_admin_enqueue_scripts ( $hook_suffix ) {
2011-04-28 05:32:34 -04:00
wp_enqueue_style ( 'twentyeleven-theme-options' , get_template_directory_uri () . '/inc/theme-options.css' , false , '2011-04-28' );
2011-06-10 09:41:51 -04:00
wp_enqueue_script ( 'twentyeleven-theme-options' , get_template_directory_uri () . '/inc/theme-options.js' , array ( 'farbtastic' ), '2011-06-10' );
2011-04-26 18:52:18 -04:00
wp_enqueue_style ( 'farbtastic' );
}
2011-06-10 19:01:16 -04:00
add_action ( 'admin_print_styles-appearance_page_theme_options' , 'twentyeleven_admin_enqueue_scripts' );
2011-04-26 18:52:18 -04:00
/**
2011-04-28 04:06:57 -04:00
* Register the form setting for our twentyeleven_options array .
*
* This function is attached to the admin_init action hook .
*
* This call to register_setting () registers a validation callback , twentyeleven_theme_options_validate (),
* which is used when the option is saved , to ensure that our option values are complete , properly
* formatted , and safe .
*
2011-04-28 04:52:37 -04:00
* We also use this function to add our theme option if it doesn ' t already exist .
*
2011-04-28 04:06:57 -04:00
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
2011-04-28 04:06:57 -04:00
function twentyeleven_theme_options_init () {
2011-04-28 04:52:37 -04:00
// If we have no options in the database, let's add them now.
if ( false === twentyeleven_get_theme_options () )
add_option ( 'twentyeleven_theme_options' , twentyeleven_get_default_theme_options () );
register_setting (
'twentyeleven_options' , // Options group, see settings_fields() call in theme_options_render_page()
'twentyeleven_theme_options' , // Database option, see twentyeleven_get_theme_options()
'twentyeleven_theme_options_validate' // The sanitization callback, see twentyeleven_theme_options_validate()
);
2011-07-21 17:37:31 -04:00
// Register our settings field group
add_settings_section (
'general' , // Unique identifier for the settings section
'' , // Section title (we don't want one)
'__return_false' , // Section callback (we don't want anything)
'theme_options' // Menu slug, used to uniquely identify the page; see twentyeleven_theme_options_add_page()
);
// Register our individual settings fields
add_settings_field (
'color_scheme' , // Unique identifier for the field for this section
__ ( 'Color Scheme' , 'twentyeleven' ), // Setting field label
'twentyeleven_settings_field_color_scheme' , // Function that renders the settings field
'theme_options' , // Menu slug, used to uniquely identify the page; see twentyeleven_theme_options_add_page()
'general' // Settings section. Same as the first argument in the add_settings_section() above
);
add_settings_field ( 'link_color' , __ ( 'Link Color' , 'twentyeleven' ), 'twentyeleven_settings_field_link_color' , 'theme_options' , 'general' );
add_settings_field ( 'layout' , __ ( 'Layout' , 'twentyeleven' ), 'twentyeleven_settings_field_layout' , 'theme_options' , 'general' );
2011-04-26 18:52:18 -04:00
}
2011-04-28 04:06:57 -04:00
add_action ( 'admin_init' , 'twentyeleven_theme_options_init' );
2011-04-26 18:52:18 -04:00
2011-05-22 17:32:44 -04:00
/**
* Change the capability required to save the 'twentyeleven_options' options group .
*
* @ see twentyeleven_theme_options_init () First parameter to register_setting () is the name of the options group .
* @ see twentyeleven_theme_options_add_page () The edit_theme_options capability is used for viewing the page .
*
* By default , the options groups for all registered settings require the manage_options capability .
* This filter is required to change our theme options page to edit_theme_options instead .
* By default , only administrators have either of these capabilities , but the desire here is
* to allow for finer - grained control for roles and users .
*
* @ param string $capability The capability used for the page , which is manage_options by default .
* @ return string The capability to actually use .
*/
function twentyeleven_option_page_capability ( $capability ) {
return 'edit_theme_options' ;
}
add_filter ( 'option_page_capability_twentyeleven_options' , 'twentyeleven_option_page_capability' );
2011-04-26 18:52:18 -04:00
/**
2011-06-01 15:28:42 -04:00
* Add our theme options page to the admin menu , including some help documentation .
2011-04-28 04:06:57 -04:00
*
* This function is attached to the admin_menu action hook .
*
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
2011-04-28 04:06:57 -04:00
function twentyeleven_theme_options_add_page () {
2011-06-01 15:28:42 -04:00
$theme_page = add_theme_page (
2011-07-11 16:15:37 -04:00
__ ( 'Theme Options' , 'twentyeleven' ), // Name of page
__ ( 'Theme Options' , 'twentyeleven' ), // Label in menu
'edit_theme_options' , // Capability required
'theme_options' , // Menu slug, used to uniquely identify the page
'twentyeleven_theme_options_render_page' // Function that renders the options page
2011-04-28 04:06:57 -04:00
);
2011-06-03 18:37:13 -04:00
if ( ! $theme_page )
return ;
2011-06-10 13:13:23 -04:00
$help = '<p>' . __ ( 'Some themes provide customization options that are grouped together on a Theme Options screen. If you change themes, options may change or disappear, as they are theme-specific. Your current theme, Twenty Eleven, provides the following Theme Options:' , 'twentyeleven' ) . '</p>' .
2011-06-01 15:28:42 -04:00
'<ol>' .
2011-06-10 13:13:23 -04:00
'<li>' . __ ( '<strong>Color Scheme</strong>: You can choose a color palette of "Light" (light background with dark text) or "Dark" (dark background with light text) for your site.' , 'twentyeleven' ) . '</li>' .
'<li>' . __ ( '<strong>Link Color</strong>: You can choose the color used for text links on your site. You can enter the HTML color or hex code, or you can choose visually by clicking the "Select a Color" button to pick from a color wheel.' , 'twentyeleven' ) . '</li>' .
'<li>' . __ ( '<strong>Default Layout</strong>: You can choose if you want your site’s default layout to have a sidebar on the left, the right, or not at all.' , 'twentyeleven' ) . '</li>' .
2011-06-01 15:28:42 -04:00
'</ol>' .
2011-06-10 13:13:23 -04:00
'<p>' . __ ( 'Remember to click "Save Changes" to save any changes you have made to the theme options.' , 'twentyeleven' ) . '</p>' .
'<p><strong>' . __ ( 'For more information:' , 'twentyeleven' ) . '</strong></p>' .
'<p>' . __ ( '<a href="http://codex.wordpress.org/Appearance_Theme_Options_Screen" target="_blank">Documentation on Theme Options</a>' , 'twentyeleven' ) . '</p>' .
'<p>' . __ ( '<a href="http://wordpress.org/support/" target="_blank">Support Forums</a>' , 'twentyeleven' ) . '</p>' ;
2011-06-01 15:28:42 -04:00
add_contextual_help ( $theme_page , $help );
2011-04-26 18:52:18 -04:00
}
2011-04-28 04:06:57 -04:00
add_action ( 'admin_menu' , 'twentyeleven_theme_options_add_page' );
2011-04-26 18:52:18 -04:00
/**
2011-04-28 04:06:57 -04:00
* Returns an array of color schemes registered for Twenty Eleven .
*
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
function twentyeleven_color_schemes () {
$color_scheme_options = array (
'light' => array (
'value' => 'light' ,
2011-04-28 04:06:57 -04:00
'label' => __ ( 'Light' , 'twentyeleven' ),
2011-04-28 04:59:42 -04:00
'thumbnail' => get_template_directory_uri () . '/inc/images/light.png' ,
2011-06-08 13:39:12 -04:00
'default_link_color' => '#1b8be0' ,
2011-04-26 18:52:18 -04:00
),
'dark' => array (
'value' => 'dark' ,
2011-04-28 04:06:57 -04:00
'label' => __ ( 'Dark' , 'twentyeleven' ),
2011-04-28 04:59:42 -04:00
'thumbnail' => get_template_directory_uri () . '/inc/images/dark.png' ,
2011-06-08 13:39:12 -04:00
'default_link_color' => '#e4741f' ,
2011-04-26 18:52:18 -04:00
),
);
2011-04-28 04:06:57 -04:00
return apply_filters ( 'twentyeleven_color_schemes' , $color_scheme_options );
2011-04-26 18:52:18 -04:00
}
/**
2011-04-28 04:06:57 -04:00
* Returns an array of layout options registered for Twenty Eleven .
*
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
function twentyeleven_layouts () {
$layout_options = array (
'content-sidebar' => array (
'value' => 'content-sidebar' ,
'label' => __ ( 'Content on left' , 'twentyeleven' ),
2011-04-28 04:59:42 -04:00
'thumbnail' => get_template_directory_uri () . '/inc/images/content-sidebar.png' ,
2011-04-26 18:52:18 -04:00
),
'sidebar-content' => array (
'value' => 'sidebar-content' ,
2011-04-28 04:06:57 -04:00
'label' => __ ( 'Content on right' , 'twentyeleven' ),
2011-04-28 04:59:42 -04:00
'thumbnail' => get_template_directory_uri () . '/inc/images/sidebar-content.png' ,
2011-04-26 18:52:18 -04:00
),
'content' => array (
'value' => 'content' ,
2011-06-01 15:28:42 -04:00
'label' => __ ( 'One-column, no sidebar' , 'twentyeleven' ),
2011-04-28 04:59:42 -04:00
'thumbnail' => get_template_directory_uri () . '/inc/images/content.png' ,
2011-04-26 18:52:18 -04:00
),
);
2011-04-28 04:06:57 -04:00
return apply_filters ( 'twentyeleven_layouts' , $layout_options );
2011-04-26 18:52:18 -04:00
}
/**
2011-04-28 04:06:57 -04:00
* Returns the default options for Twenty Eleven .
*
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
2011-04-27 19:03:27 -04:00
function twentyeleven_get_default_theme_options () {
2011-04-28 04:06:57 -04:00
$default_theme_options = array (
2011-04-26 18:52:18 -04:00
'color_scheme' => 'light' ,
2011-06-08 13:39:12 -04:00
'link_color' => twentyeleven_get_default_link_color ( 'light' ),
2011-04-26 18:52:18 -04:00
'theme_layout' => 'content-sidebar' ,
);
2011-04-28 04:06:57 -04:00
2011-06-30 17:57:50 -04:00
if ( is_rtl () )
2011-06-25 16:24:07 -04:00
$default_theme_options [ 'theme_layout' ] = 'sidebar-content' ;
2011-04-28 04:06:57 -04:00
return apply_filters ( 'twentyeleven_default_theme_options' , $default_theme_options );
2011-04-27 19:03:27 -04:00
}
2011-06-08 13:39:12 -04:00
/**
* Returns the default link color for Twenty Eleven , based on color scheme .
*
* @ since Twenty Eleven 1.0
*
* @ param $string $color_scheme Color scheme . Defaults to the active color scheme .
* @ return $string Color .
*/
function twentyeleven_get_default_link_color ( $color_scheme = null ) {
if ( null === $color_scheme ) {
$options = twentyeleven_get_theme_options ();
$color_scheme = $options [ 'color_scheme' ];
}
$color_schemes = twentyeleven_color_schemes ();
if ( ! isset ( $color_schemes [ $color_scheme ] ) )
return false ;
return $color_schemes [ $color_scheme ][ 'default_link_color' ];
}
2011-04-27 19:03:27 -04:00
/**
2011-04-28 04:06:57 -04:00
* Returns the options array for Twenty Eleven .
*
* @ since Twenty Eleven 1.0
2011-04-27 19:03:27 -04:00
*/
function twentyeleven_get_theme_options () {
2011-06-05 15:53:31 -04:00
return get_option ( 'twentyeleven_theme_options' , twentyeleven_get_default_theme_options () );
2011-04-26 18:52:18 -04:00
}
2011-07-21 17:37:31 -04:00
/**
* Renders the Color Scheme setting field .
*
2011-07-21 17:44:47 -04:00
* @ since Twenty Eleven 1.3
2011-07-21 17:37:31 -04:00
*/
function twentyeleven_settings_field_color_scheme () {
$options = twentyeleven_get_theme_options ();
foreach ( twentyeleven_color_schemes () as $scheme ) {
?>
< div class = " layout image-radio-option color-scheme " >
< label class = " description " >
< input type = " radio " name = " twentyeleven_theme_options[color_scheme] " value = " <?php echo esc_attr( $scheme['value'] ); ?> " < ? php checked ( $options [ 'color_scheme' ], $scheme [ 'value' ] ); ?> />
< input type = " hidden " id = " default-color-<?php echo esc_attr( $scheme['value'] ); ?> " value = " <?php echo esc_attr( $scheme['default_link_color'] ); ?> " />
< span >
< img src = " <?php echo esc_url( $scheme['thumbnail'] ); ?> " width = " 136 " height = " 122 " alt = " " />
< ? php echo $scheme [ 'label' ]; ?>
</ span >
</ label >
</ div >
< ? php
}
}
/**
* Renders the Link Color setting field .
*
2011-07-21 17:44:47 -04:00
* @ since Twenty Eleven 1.3
2011-07-21 17:37:31 -04:00
*/
function twentyeleven_settings_field_link_color () {
$options = twentyeleven_get_theme_options ();
?>
< input type = " text " name = " twentyeleven_theme_options[link_color] " id = " link-color " value = " <?php echo esc_attr( $options['link_color'] ); ?> " />
< a href = " # " class = " pickcolor hide-if-no-js " id = " link-color-example " ></ a >
< input type = " button " class = " pickcolor button hide-if-no-js " value = " <?php esc_attr_e( 'Select a Color', 'twentyeleven' ); ?> " />
< div id = " colorPickerDiv " style = " z-index: 100; background:#eee; border:1px solid #ccc; position:absolute; display:none; " ></ div >
< br />
< span >< ? php printf ( __ ( 'Default color: %s' , 'twentyeleven' ), '<span id="default-color">' . twentyeleven_get_default_link_color ( $options [ 'color_scheme' ] ) . '</span>' ); ?> </span>
< ? php
}
/**
* Renders the Layout setting field .
*
2011-07-21 17:44:47 -04:00
* @ since Twenty Eleven 1.3
2011-07-21 17:37:31 -04:00
*/
function twentyeleven_settings_field_layout () {
$options = twentyeleven_get_theme_options ();
foreach ( twentyeleven_layouts () as $layout ) {
?>
< div class = " layout image-radio-option theme-layout " >
< label class = " description " >
< input type = " radio " name = " twentyeleven_theme_options[theme_layout] " value = " <?php echo esc_attr( $layout['value'] ); ?> " < ? php checked ( $options [ 'theme_layout' ], $layout [ 'value' ] ); ?> />
< span >
< img src = " <?php echo esc_url( $layout['thumbnail'] ); ?> " width = " 136 " height = " 122 " alt = " " />
< ? php echo $layout [ 'label' ]; ?>
</ span >
</ label >
</ div >
< ? php
}
}
2011-04-26 18:52:18 -04:00
/**
2011-04-28 04:06:57 -04:00
* Returns the options array for Twenty Eleven .
*
2011-07-11 16:15:37 -04:00
* @ since Twenty Eleven 1.2
2011-04-26 18:52:18 -04:00
*/
2011-07-11 16:15:37 -04:00
function twentyeleven_theme_options_render_page () {
2011-04-26 18:52:18 -04:00
?>
< div class = " wrap " >
2011-04-28 04:06:57 -04:00
< ? php screen_icon (); ?>
< h2 >< ? php printf ( __ ( '%s Theme Options' , 'twentyeleven' ), get_current_theme () ); ?> </h2>
< ? php settings_errors (); ?>
2011-04-26 18:52:18 -04:00
< form method = " post " action = " options.php " >
2011-04-28 04:06:57 -04:00
< ? php
settings_fields ( 'twentyeleven_options' );
2011-07-21 17:37:31 -04:00
do_settings_sections ( 'theme_options' );
submit_button ();
?>
2011-04-26 18:52:18 -04:00
</ form >
</ div >
< ? php
}
/**
2011-04-28 04:06:57 -04:00
* Sanitize and validate form input . Accepts an array , return a sanitized array .
2011-04-27 19:03:27 -04:00
*
2011-04-28 04:06:57 -04:00
* @ see twentyeleven_theme_options_init ()
* @ todo set up Reset Options action
*
2011-04-28 04:52:37 -04:00
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
function twentyeleven_theme_options_validate ( $input ) {
2011-04-28 04:52:37 -04:00
$output = $defaults = twentyeleven_get_default_theme_options ();
2011-04-27 19:03:27 -04:00
// Color scheme must be in our array of color scheme options
2011-04-28 04:06:57 -04:00
if ( isset ( $input [ 'color_scheme' ] ) && array_key_exists ( $input [ 'color_scheme' ], twentyeleven_color_schemes () ) )
$output [ 'color_scheme' ] = $input [ 'color_scheme' ];
2011-06-11 11:44:06 -04:00
// Our defaults for the link color may have changed, based on the color scheme.
2011-06-08 13:39:12 -04:00
$output [ 'link_color' ] = $defaults [ 'link_color' ] = twentyeleven_get_default_link_color ( $output [ 'color_scheme' ] );
2011-04-27 19:03:27 -04:00
// Link color must be 3 or 6 hexadecimal characters
2011-04-28 04:06:57 -04:00
if ( isset ( $input [ 'link_color' ] ) && preg_match ( '/^#?([a-f0-9]{3}){1,2}$/i' , $input [ 'link_color' ] ) )
2011-06-10 19:01:16 -04:00
$output [ 'link_color' ] = '#' . strtolower ( ltrim ( $input [ 'link_color' ], '#' ) );
2011-04-26 18:52:18 -04:00
2011-04-27 19:03:27 -04:00
// Theme layout must be in our array of theme layout options
2011-04-28 04:06:57 -04:00
if ( isset ( $input [ 'theme_layout' ] ) && array_key_exists ( $input [ 'theme_layout' ], twentyeleven_layouts () ) )
$output [ 'theme_layout' ] = $input [ 'theme_layout' ];
2011-04-26 18:52:18 -04:00
2011-04-28 04:52:37 -04:00
return apply_filters ( 'twentyeleven_theme_options_validate' , $output , $input , $defaults );
2011-04-26 18:52:18 -04:00
}
/**
2011-04-28 04:52:37 -04:00
* Enqueue the styles for the current color scheme .
*
* @ since Twenty Eleven 1.0
2011-04-26 18:52:18 -04:00
*/
2011-04-28 07:05:53 -04:00
function twentyeleven_enqueue_color_scheme () {
2011-04-26 18:52:18 -04:00
$options = twentyeleven_get_theme_options ();
2011-04-28 04:06:57 -04:00
$color_scheme = $options [ 'color_scheme' ];
2011-04-26 18:52:18 -04:00
2011-04-28 04:06:57 -04:00
if ( 'dark' == $color_scheme )
2011-04-28 07:05:53 -04:00
wp_enqueue_style ( 'dark' , get_template_directory_uri () . '/colors/dark.css' , array (), null );
2011-04-26 18:52:18 -04:00
2011-04-28 07:05:53 -04:00
do_action ( 'twentyeleven_enqueue_color_scheme' , $color_scheme );
2011-04-26 18:52:18 -04:00
}
2011-04-28 07:05:53 -04:00
add_action ( 'wp_enqueue_scripts' , 'twentyeleven_enqueue_color_scheme' );
2011-04-26 18:52:18 -04:00
/**
2011-04-28 04:06:57 -04:00
* Add a style block to the theme for the current link color .
*
* This function is attached to the wp_head action hook .
2011-04-26 18:52:18 -04:00
*
* @ since Twenty Eleven 1.0
*/
2011-04-28 07:05:53 -04:00
function twentyeleven_print_link_color_style () {
2011-04-26 18:52:18 -04:00
$options = twentyeleven_get_theme_options ();
2011-04-28 04:06:57 -04:00
$link_color = $options [ 'link_color' ];
$default_options = twentyeleven_get_default_theme_options ();
2011-04-28 15:01:51 -04:00
2011-04-28 04:06:57 -04:00
// Don't do anything if the current link color is the default.
if ( $default_options [ 'link_color' ] == $link_color )
return ;
?>
< style >
/* Link color */
a ,
2011-05-26 14:41:35 -04:00
#site-title a:focus,
#site-title a:hover,
#site-title a:active,
2011-04-28 18:04:39 -04:00
. entry - title a : hover ,
2011-05-26 14:41:35 -04:00
. entry - title a : focus ,
. entry - title a : active ,
2011-04-28 18:04:39 -04:00
. widget_twentyeleven_ephemera . comments - link a : hover ,
section . recent - posts . other - recent - posts a [ rel = " bookmark " ] : hover ,
2011-05-04 18:54:50 -04:00
section . recent - posts . other - recent - posts . comments - link a : hover ,
2011-05-12 19:13:56 -04:00
. format - image footer . entry - meta a : hover ,
#site-generator a:hover {
2011-04-28 04:06:57 -04:00
color : < ? php echo $link_color ; ?> ;
}
2011-04-28 18:04:39 -04:00
section . recent - posts . other - recent - posts . comments - link a : hover {
border - color : < ? php echo $link_color ; ?> ;
2011-06-11 11:44:06 -04:00
}
2011-05-29 21:29:55 -04:00
article . feature - image . small . entry - summary p a : hover ,
. entry - header . comments - link a : hover ,
. entry - header . comments - link a : focus ,
2011-06-07 17:28:56 -04:00
. entry - header . comments - link a : active ,
. feature - slider a . active {
2011-06-10 19:10:23 -04:00
background - color : < ? php echo $link_color ; ?> ;
2011-05-29 21:29:55 -04:00
}
2011-04-28 04:06:57 -04:00
</ style >
< ? php
2011-04-26 18:52:18 -04:00
}
2011-04-28 07:05:53 -04:00
add_action ( 'wp_head' , 'twentyeleven_print_link_color_style' );
2011-04-26 18:52:18 -04:00
/**
2011-04-28 04:52:37 -04:00
* Adds Twenty Eleven layout classes to the array of body classes .
2011-04-26 18:52:18 -04:00
*
* @ since Twenty Eleven 1.0
*/
2011-04-28 07:05:53 -04:00
function twentyeleven_layout_classes ( $existing_classes ) {
2011-04-28 04:06:57 -04:00
$options = twentyeleven_get_theme_options ();
$current_layout = $options [ 'theme_layout' ];
2011-04-28 07:05:53 -04:00
if ( in_array ( $current_layout , array ( 'content-sidebar' , 'sidebar-content' ) ) )
$classes = array ( 'two-column' );
2011-04-28 04:06:57 -04:00
else
2011-04-28 07:05:53 -04:00
$classes = array ( 'one-column' );
2011-04-28 04:06:57 -04:00
2011-06-25 16:24:07 -04:00
if ( 'content-sidebar' == $current_layout )
$classes [] = 'right-sidebar' ;
elseif ( 'sidebar-content' == $current_layout )
$classes [] = 'left-sidebar' ;
else
$classes [] = $current_layout ;
2011-04-28 04:06:57 -04:00
2011-04-28 07:05:53 -04:00
$classes = apply_filters ( 'twentyeleven_layout_classes' , $classes , $current_layout );
2011-04-26 18:52:18 -04:00
2011-04-28 07:05:53 -04:00
return array_merge ( $existing_classes , $classes );
2011-04-26 18:52:18 -04:00
}
2011-04-28 04:06:57 -04:00
add_filter ( 'body_class' , 'twentyeleven_layout_classes' );