X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..8cc0f04ca22ffd9449495b3e0240603309c9932c:/wp-includes/theme.php diff --git a/wp-includes/theme.php b/wp-includes/theme.php index 3362c1d4..9d56a640 100644 --- a/wp-includes/theme.php +++ b/wp-includes/theme.php @@ -1,30 +1,92 @@ 'a' element with the href and title + * attributes. The abbr element with the title attribute. The + * acronym element with the title attribute allowed. The + * code, em, and strong elements also allowed. + * + * The style.css file must contain theme name, theme URI, and description. The + * data can also contain author URI, author, template (parent template), + * version, status, and finally tags. Some of these are not used by WordPress + * administration panels, but are used by theme directory web sites which list + * the theme. + * + * @since 1.5.0 + * + * @param string $theme_file Theme file path. + * @return array Theme data. + */ function get_theme_data( $theme_file ) { $themes_allowed_tags = array( 'a' => array( @@ -73,39 +179,74 @@ function get_theme_data( $theme_file ) { $theme_data = implode( '', file( $theme_file ) ); $theme_data = str_replace ( '\r', '\n', $theme_data ); - preg_match( '|Theme Name:(.*)$|mi', $theme_data, $theme_name ); - preg_match( '|Theme URI:(.*)$|mi', $theme_data, $theme_uri ); - preg_match( '|Description:(.*)$|mi', $theme_data, $description ); - preg_match( '|Author:(.*)$|mi', $theme_data, $author_name ); - preg_match( '|Author URI:(.*)$|mi', $theme_data, $author_uri ); - preg_match( '|Template:(.*)$|mi', $theme_data, $template ); + if ( preg_match( '|Theme Name:(.*)$|mi', $theme_data, $theme_name ) ) + $name = $theme = wp_kses( _cleanup_header_comment($theme_name[1]), $themes_allowed_tags ); + else + $name = $theme = ''; + + if ( preg_match( '|Theme URI:(.*)$|mi', $theme_data, $theme_uri ) ) + $theme_uri = esc_url( _cleanup_header_comment($theme_uri[1]) ); + else + $theme_uri = ''; + + if ( preg_match( '|Description:(.*)$|mi', $theme_data, $description ) ) + $description = wptexturize( wp_kses( _cleanup_header_comment($description[1]), $themes_allowed_tags ) ); + else + $description = ''; + + if ( preg_match( '|Author URI:(.*)$|mi', $theme_data, $author_uri ) ) + $author_uri = esc_url( _cleanup_header_comment($author_uri[1]) ); + else + $author_uri = ''; + + if ( preg_match( '|Template:(.*)$|mi', $theme_data, $template ) ) + $template = wp_kses( _cleanup_header_comment($template[1]), $themes_allowed_tags ); + else + $template = ''; if ( preg_match( '|Version:(.*)|i', $theme_data, $version ) ) - $version = wp_kses( trim( $version[1] ), $themes_allowed_tags ); + $version = wp_kses( _cleanup_header_comment($version[1]), $themes_allowed_tags ); else $version = ''; if ( preg_match('|Status:(.*)|i', $theme_data, $status) ) - $status = wp_kses( trim( $status[1] ), $themes_allowed_tags ); + $status = wp_kses( _cleanup_header_comment($status[1]), $themes_allowed_tags ); else $status = 'publish'; - $name = $theme = wp_kses( trim( $theme_name[1] ), $themes_allowed_tags ); - $theme_uri = clean_url( trim( $theme_uri[1] ) ); - $description = wptexturize( wp_kses( trim( $description[1] ), $themes_allowed_tags ) ); - $template = wp_kses( trim( $template[1] ), $themes_allowed_tags ); - - $author_uri = clean_url( trim( $author_uri[1] ) ); + if ( preg_match('|Tags:(.*)|i', $theme_data, $tags) ) + $tags = array_map( 'trim', explode( ',', wp_kses( _cleanup_header_comment($tags[1]), array() ) ) ); + else + $tags = array(); - if ( empty( $author_uri[1] ) ) { - $author = wp_kses( trim( $author_name[1] ), $themes_allowed_tags ); + if ( preg_match( '|Author:(.*)$|mi', $theme_data, $author_name ) ) { + if ( empty( $author_uri ) ) { + $author = wp_kses( _cleanup_header_comment($author_name[1]), $themes_allowed_tags ); + } else { + $author = sprintf( '%3$s', $author_uri, __( 'Visit author homepage' ), wp_kses( _cleanup_header_comment($author_name[1]), $themes_allowed_tags ) ); + } } else { - $author = sprintf( '%3$s', $author_uri, __( 'Visit author homepage' ), wp_kses( trim( $author_name[1] ), $themes_allowed_tags ) ); + $author = __('Anonymous'); } - return array( 'Name' => $name, 'Title' => $theme, 'URI' => $theme_uri, 'Description' => $description, 'Author' => $author, 'Version' => $version, 'Template' => $template, 'Status' => $status ); + return array( 'Name' => $name, 'Title' => $theme, 'URI' => $theme_uri, 'Description' => $description, 'Author' => $author, 'Version' => $version, 'Template' => $template, 'Status' => $status, 'Tags' => $tags ); } +/** + * Retrieve list of themes with theme data in theme directory. + * + * The theme is broken, if it doesn't have a parent theme and is missing either + * style.css and, or index.php. If the theme has a parent theme then it is + * broken, if it is missing style.css; index.php is optional. The broken theme + * list is saved in the {@link $wp_broken_themes} global, which is displayed on + * the theme list in the administration panels. + * + * @since 1.5.0 + * @global array $wp_broken_themes Stores the broken themes. + * @global array $wp_themes Stores the working themes. + * + * @return array Theme list with theme data. + */ function get_themes() { global $wp_themes, $wp_broken_themes; @@ -115,8 +256,8 @@ function get_themes() { $themes = array(); $wp_broken_themes = array(); $theme_loc = $theme_root = get_theme_root(); - if ( '/' != ABSPATH ) // don't want to replace all forward slashes, see Trac #4541 - $theme_loc = str_replace(ABSPATH, '', $theme_root); + if ( '/' != WP_CONTENT_DIR ) // don't want to replace all forward slashes, see Trac #4541 + $theme_loc = str_replace(WP_CONTENT_DIR, '', $theme_root); // Files in wp-content/themes directory and one subdir down $themes_dir = @ opendir($theme_root); @@ -162,7 +303,8 @@ function get_themes() { } } } - @closedir($theme_dir); + if ( is_dir( $theme_dir ) ) + @closedir( $theme_dir ); if ( !$themes_dir || !$theme_files ) return $themes; @@ -218,21 +360,40 @@ function get_themes() { } $stylesheet_files = array(); + $template_files = array(); + $stylesheet_dir = @ dir("$theme_root/$stylesheet"); if ( $stylesheet_dir ) { while ( ($file = $stylesheet_dir->read()) !== false ) { - if ( !preg_match('|^\.+$|', $file) && preg_match('|\.css$|', $file) ) - $stylesheet_files[] = "$theme_loc/$stylesheet/$file"; + if ( !preg_match('|^\.+$|', $file) ) { + if ( preg_match('|\.css$|', $file) ) + $stylesheet_files[] = "$theme_loc/$stylesheet/$file"; + elseif ( preg_match('|\.php$|', $file) ) + $template_files[] = "$theme_loc/$stylesheet/$file"; + } } + @ $stylesheet_dir->close(); } - $template_files = array(); $template_dir = @ dir("$theme_root/$template"); if ( $template_dir ) { - while(($file = $template_dir->read()) !== false) { - if ( !preg_match('|^\.+$|', $file) && preg_match('|\.php$|', $file) ) + while ( ($file = $template_dir->read()) !== false ) { + if ( preg_match('|^\.+$|', $file) ) + continue; + if ( preg_match('|\.php$|', $file) ) { $template_files[] = "$theme_loc/$template/$file"; + } elseif ( is_dir("$theme_root/$template/$file") ) { + $template_subdir = @ dir("$theme_root/$template/$file"); + while ( ($subfile = $template_subdir->read()) !== false ) { + if ( preg_match('|^\.+$|', $subfile) ) + continue; + if ( preg_match('|\.php$|', $subfile) ) + $template_files[] = "$theme_loc/$template/$file/$subfile"; + } + @ $template_subdir->close(); + } } + @ $template_dir->close(); } $template_dir = dirname($template_files[0]); @@ -261,7 +422,7 @@ function get_themes() { } } - $themes[$name] = array('Name' => $name, 'Title' => $title, 'Description' => $description, 'Author' => $author, 'Version' => $version, 'Template' => $template, 'Stylesheet' => $stylesheet, 'Template Files' => $template_files, 'Stylesheet Files' => $stylesheet_files, 'Template Dir' => $template_dir, 'Stylesheet Dir' => $stylesheet_dir, 'Status' => $theme_data['Status'], 'Screenshot' => $screenshot); + $themes[$name] = array('Name' => $name, 'Title' => $title, 'Description' => $description, 'Author' => $author, 'Version' => $version, 'Template' => $template, 'Stylesheet' => $stylesheet, 'Template Files' => $template_files, 'Stylesheet Files' => $stylesheet_files, 'Template Dir' => $template_dir, 'Stylesheet Dir' => $stylesheet_dir, 'Status' => $theme_data['Status'], 'Screenshot' => $screenshot, 'Tags' => $theme_data['Tags']); } // Resolve theme dependencies. @@ -284,16 +445,38 @@ function get_themes() { return $themes; } +/** + * Retrieve theme data. + * + * @since 1.5.0 + * + * @param string $theme Theme name. + * @return array|null Null, if theme name does not exist. Theme data, if exists. + */ function get_theme($theme) { $themes = get_themes(); if ( array_key_exists($theme, $themes) ) return $themes[$theme]; - return NULL; + return null; } +/** + * Retrieve current theme display name. + * + * If the 'current_theme' option has already been set, then it will be returned + * instead. If it is not set, then each theme will be iterated over until both + * the current stylesheet and current template name. + * + * @since 1.5.0 + * + * @return string + */ function get_current_theme() { + if ( $theme = get_option('current_theme') ) + return $theme; + $themes = get_themes(); $theme_names = array_keys($themes); $current_template = get_option('template'); @@ -310,73 +493,203 @@ function get_current_theme() { } } + update_option('current_theme', $current_theme); + return $current_theme; } +/** + * Retrieve path to themes directory. + * + * Does not have trailing slash. + * + * @since 1.5.0 + * @uses apply_filters() Calls 'theme_root' filter on path. + * + * @return string Theme path. + */ function get_theme_root() { - return apply_filters('theme_root', ABSPATH . "wp-content/themes"); + return apply_filters('theme_root', WP_CONTENT_DIR . "/themes"); } +/** + * Retrieve URI for themes directory. + * + * Does not have trailing slash. + * + * @since 1.5.0 + * + * @return string Themes URI. + */ function get_theme_root_uri() { - return apply_filters('theme_root_uri', get_option('siteurl') . "/wp-content/themes", get_option('siteurl')); + return apply_filters('theme_root_uri', content_url('themes'), get_option('siteurl')); } +/** + * Retrieve path to file without the use of extension. + * + * Used to quickly retrieve the path of file without including the file + * extension. It will also check the parent template, if the file exists, with + * the use of {@link locate_template()}. Allows for more generic file location + * without the use of the other get_*_template() functions. + * + * Can be used with include() or require() to retrieve path. + * + * if( '' != get_query_template( '404' ) ) + * include( get_query_template( '404' ) ); + * + * or the same can be accomplished with + * + * if( '' != get_404_template() ) + * include( get_404_template() ); + * + * + * @since 1.5.0 + * + * @param string $type Filename without extension. + * @return string Full path to file. + */ function get_query_template($type) { - $template = ''; - if ( file_exists(TEMPLATEPATH . "/{$type}.php") ) - $template = TEMPLATEPATH . "/{$type}.php"; - - return apply_filters("{$type}_template", $template); + $type = preg_replace( '|[^a-z0-9-]+|', '', $type ); + return apply_filters("{$type}_template", locate_template(array("{$type}.php"))); } +/** + * Retrieve path of 404 template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_404_template() { return get_query_template('404'); } +/** + * Retrieve path of archive template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_archive_template() { return get_query_template('archive'); } +/** + * Retrieve path of author template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_author_template() { return get_query_template('author'); } +/** + * Retrieve path of category template in current or parent template. + * + * Works by retrieving the current category ID, for example 'category-1.php' and + * will fallback to category.php template, if the ID category file doesn't + * exist. + * + * @since 1.5.0 + * @uses apply_filters() Calls 'category_template' on file path of category template. + * + * @return string + */ function get_category_template() { - $template = ''; - if ( file_exists(TEMPLATEPATH . "/category-" . get_query_var('cat') . '.php') ) - $template = TEMPLATEPATH . "/category-" . get_query_var('cat') . '.php'; - elseif ( file_exists(TEMPLATEPATH . "/category.php") ) - $template = TEMPLATEPATH . "/category.php"; - + $template = locate_template(array("category-" . absint( get_query_var('cat') ) . '.php', 'category.php')); return apply_filters('category_template', $template); } +/** + * Retrieve path of tag template in current or parent template. + * + * Works by retrieving the current tag name, for example 'tag-wordpress.php' and will + * fallback to tag.php template, if the name tag file doesn't exist. + * + * @since 2.3.0 + * @uses apply_filters() Calls 'tag_template' on file path of tag template. + * + * @return string + */ function get_tag_template() { - $template = ''; - if ( file_exists(TEMPLATEPATH . "/tag-" . get_query_var('tag') . '.php') ) - $template = TEMPLATEPATH . "/tag-" . get_query_var('tag') . '.php'; - elseif ( file_exists(TEMPLATEPATH . "/tag.php") ) - $template = TEMPLATEPATH . "/tag.php"; - + $template = locate_template(array("tag-" . get_query_var('tag') . '.php', 'tag.php')); return apply_filters('tag_template', $template); } +/** + * Retrieve path of taxonomy template in current or parent template. + * + * Retrieves the taxonomy and term, if term is available. The template is + * prepended with 'taxonomy-' and followed by both the taxonomy string and + * the taxonomy string followed by a dash and then followed by the term. + * + * The taxonomy and term template is checked and used first, if it exists. + * Second, just the taxonomy template is checked, and then finally, taxonomy.php + * template is used. If none of the files exist, then it will fall back on to + * index.php. + * + * @since unknown (2.6.0 most likely) + * @uses apply_filters() Calls 'taxonomy_template' filter on found path. + * + * @return string + */ +function get_taxonomy_template() { + $taxonomy = get_query_var('taxonomy'); + $term = get_query_var('term'); + + $templates = array(); + if ( $taxonomy && $term ) + $templates[] = "taxonomy-$taxonomy-$term.php"; + if ( $taxonomy ) + $templates[] = "taxonomy-$taxonomy.php"; + $templates[] = "taxonomy.php"; + + $template = locate_template($templates); + return apply_filters('taxonomy_template', $template); +} + +/** + * Retrieve path of date template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_date_template() { return get_query_template('date'); } +/** + * Retrieve path of home template in current or parent template. + * + * Attempts to locate 'home.php' first before falling back to 'index.php'. + * + * @since 1.5.0 + * @uses apply_filters() Calls 'home_template' on file path of home template. + * + * @return string + */ function get_home_template() { - $template = ''; - - if ( file_exists(TEMPLATEPATH . "/home.php") ) - $template = TEMPLATEPATH . "/home.php"; - elseif ( file_exists(TEMPLATEPATH . "/index.php") ) - $template = TEMPLATEPATH . "/index.php"; - + $template = locate_template(array('home.php', 'index.php')); return apply_filters('home_template', $template); } +/** + * Retrieve path of page template in current or parent template. + * + * First attempt is to look for the file in the '_wp_page_template' page meta + * data. The second attempt, if the first has a file and is not empty, is to + * look for 'page.php'. + * + * @since 1.5.0 + * + * @return string + */ function get_page_template() { global $wp_query; @@ -386,28 +699,63 @@ function get_page_template() { if ( 'default' == $template ) $template = ''; - if ( !empty($template) && file_exists(TEMPLATEPATH . "/$template") ) - $template = TEMPLATEPATH . "/$template"; - elseif ( file_exists(TEMPLATEPATH . "/page.php") ) - $template = TEMPLATEPATH . "/page.php"; - else - $template = ''; + $templates = array(); + if ( !empty($template) && !validate_file($template) ) + $templates[] = $template; - return apply_filters('page_template', $template); + $templates[] = "page.php"; + + return apply_filters('page_template', locate_template($templates)); } +/** + * Retrieve path of paged template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_paged_template() { return get_query_template('paged'); } +/** + * Retrieve path of search template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_search_template() { return get_query_template('search'); } +/** + * Retrieve path of single template in current or parent template. + * + * @since 1.5.0 + * + * @return string + */ function get_single_template() { return get_query_template('single'); } +/** + * Retrieve path of attachment template in current or parent template. + * + * The attachment path first checks if the first part of the mime type exists. + * The second check is for the second part of the mime type. The last check is + * for both types separated by an underscore. If neither are found then the file + * 'attachment.php' is checked and returned. + * + * Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and + * finally 'text_plain.php'. + * + * @since 2.0.0 + * + * @return string + */ function get_attachment_template() { global $posts; $type = explode('/', $posts[0]->post_mime_type); @@ -421,18 +769,73 @@ function get_attachment_template() { return get_query_template('attachment'); } +/** + * Retrieve path of comment popup template in current or parent template. + * + * Checks for comment popup template in current template, if it exists or in the + * parent template. If it doesn't exist, then it retrieves the comment-popup.php + * file from the default theme. The default theme must then exist for it to + * work. + * + * @since 1.5.0 + * @uses apply_filters() Calls 'comments_popup_template' filter on path. + * + * @return string + */ function get_comments_popup_template() { - if ( file_exists( TEMPLATEPATH . '/comments-popup.php') ) - $template = TEMPLATEPATH . '/comments-popup.php'; - else + $template = locate_template(array("comments-popup.php")); + if ('' == $template) $template = get_theme_root() . '/default/comments-popup.php'; return apply_filters('comments_popup_template', $template); } +/** + * Retrieve the name of the highest priority template file that exists. + * + * Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which + * inherit from a parent theme can just overload one file. + * + * @since 2.7.0 + * + * @param array $template_names Array of template files to search for in priority order. + * @param bool $load If true the template file will be loaded if it is found. + * @return string The template filename if one is located. + */ +function locate_template($template_names, $load = false) { + if (!is_array($template_names)) + return ''; + + $located = ''; + foreach($template_names as $template_name) { + if ( file_exists(STYLESHEETPATH . '/' . $template_name)) { + $located = STYLESHEETPATH . '/' . $template_name; + break; + } else if ( file_exists(TEMPLATEPATH . '/' . $template_name) ) { + $located = TEMPLATEPATH . '/' . $template_name; + break; + } + } + + if ($load && '' != $located) + load_template($located); + + return $located; +} + +/** + * Require once the template file with WordPress environment. + * + * The globals are set up for the template file to ensure that the WordPress + * environment is available from within the function. The query variables are + * also available. + * + * @since 1.5.0 + * + * @param string $_template_file Path to template file. + */ function load_template($_template_file) { - global $posts, $post, $wp_did_header, $wp_did_template_redirect, $wp_query, - $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID; + global $posts, $post, $wp_did_header, $wp_did_template_redirect, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID; if ( is_array($wp_query->query_vars) ) extract($wp_query->query_vars, EXTR_SKIP); @@ -440,6 +843,11 @@ function load_template($_template_file) { require_once($_template_file); } +/** + * Display localized stylesheet link element. + * + * @since 2.1.0 + */ function locale_stylesheet() { $stylesheet = get_locale_stylesheet_uri(); if ( empty($stylesheet) ) @@ -447,28 +855,149 @@ function locale_stylesheet() { echo ''; } +/** + * Start preview theme output buffer. + * + * Will only preform task if the user has permissions and template and preview + * query variables exist. + * + * @since 2.5.0 + */ +function preview_theme() { + if ( ! (isset($_GET['template']) && isset($_GET['preview'])) ) + return; + + if ( !current_user_can( 'switch_themes' ) ) + return; + + $_GET['template'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['template']); + + if ( validate_file($_GET['template']) ) + return; + + add_filter( 'template', create_function('', "return '{$_GET['template']}';") ); + + if ( isset($_GET['stylesheet']) ) { + $_GET['stylesheet'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['stylesheet']); + if ( validate_file($_GET['stylesheet']) ) + return; + add_filter( 'stylesheet', create_function('', "return '{$_GET['stylesheet']}';") ); + } + + // Prevent theme mods to current theme being used on theme being previewed + add_filter( 'pre_option_mods_' . get_current_theme(), create_function( '', "return array();" ) ); + + ob_start( 'preview_theme_ob_filter' ); +} +add_action('setup_theme', 'preview_theme'); + +/** + * Callback function for ob_start() to capture all links in the theme. + * + * @since unknown + * @access private + * + * @param string $content + * @return string + */ +function preview_theme_ob_filter( $content ) { + return preg_replace_callback( "|()|", 'preview_theme_ob_filter_callback', $content ); +} + +/** + * Manipulates preview theme links in order to control and maintain location. + * + * Callback function for preg_replace_callback() to accept and filter matches. + * + * @since unknown + * @access private + * + * @param array $matches + * @return string + */ +function preview_theme_ob_filter_callback( $matches ) { + if ( strpos($matches[4], 'onclick') !== false ) + $matches[4] = preg_replace('#onclick=([\'"]).*?(?. (? 1, 'template' => $_GET['template'], 'stylesheet' => @$_GET['stylesheet'] ), $matches[3] ); + if ( 0 === strpos($link, 'preview=1') ) + $link = "?$link"; + return $matches[1] . esc_attr( $link ) . $matches[4]; +} + +/** + * Switches current theme to new template and stylesheet names. + * + * @since unknown + * @uses do_action() Calls 'switch_theme' action on updated theme display name. + * + * @param string $template Template name + * @param string $stylesheet Stylesheet name. + */ +function switch_theme($template, $stylesheet) { + update_option('template', $template); + update_option('stylesheet', $stylesheet); + delete_option('current_theme'); + $theme = get_current_theme(); + do_action('switch_theme', $theme); +} + +/** + * Checks that current theme files 'index.php' and 'style.css' exists. + * + * Does not check the 'default' theme. The 'default' theme should always exist + * or should have another theme renamed to that template name and directory + * path. Will switch theme to default if current theme does not validate. + * You can use the 'validate_current_theme' filter to return FALSE to + * disable this functionality. + * + * @since 1.5.0 + * + * @return bool + */ function validate_current_theme() { // Don't validate during an install/upgrade. - if ( defined('WP_INSTALLING') ) + if ( defined('WP_INSTALLING') || !apply_filters( 'validate_current_theme', true ) ) return true; if ( get_template() != 'default' && !file_exists(get_template_directory() . '/index.php') ) { - update_option('template', 'default'); - update_option('stylesheet', 'default'); - do_action('switch_theme', 'Default'); + switch_theme('default', 'default'); return false; } if ( get_stylesheet() != 'default' && !file_exists(get_template_directory() . '/style.css') ) { - update_option('template', 'default'); - update_option('stylesheet', 'default'); - do_action('switch_theme', 'Default'); + switch_theme('default', 'default'); return false; } return true; } +/** + * Retrieve theme modification value for the current theme. + * + * If the modification name does not exist, then the $default will be passed + * through {@link http://php.net/sprintf sprintf()} PHP function with the first + * string the template directory URI and the second string the stylesheet + * directory URI. + * + * @since 2.1.0 + * @uses apply_filters() Calls 'theme_mod_$name' filter on the value. + * + * @param string $name Theme modification name. + * @param bool|string $default + * @return string + */ function get_theme_mod($name, $default = false) { $theme = get_current_theme(); @@ -477,9 +1006,17 @@ function get_theme_mod($name, $default = false) { if ( isset($mods[$name]) ) return apply_filters( "theme_mod_$name", $mods[$name] ); - return apply_filters( "theme_mod_$name", sprintf($default, get_template_directory_uri()) ); + return apply_filters( "theme_mod_$name", sprintf($default, get_template_directory_uri(), get_stylesheet_directory_uri()) ); } +/** + * Update theme modification value for the current theme. + * + * @since 2.1.0 + * + * @param string $name Theme modification name. + * @param string $value theme modification value. + */ function set_theme_mod($name, $value) { $theme = get_current_theme(); @@ -491,6 +1028,17 @@ function set_theme_mod($name, $value) { wp_cache_delete("mods_$theme", 'options'); } +/** + * Remove theme modification name from current theme list. + * + * If removing the name also removes all elements, then the entire option will + * be removed. + * + * @since 2.1.0 + * + * @param string $name Theme modification name. + * @return null + */ function remove_theme_mod( $name ) { $theme = get_current_theme(); @@ -508,28 +1056,73 @@ function remove_theme_mod( $name ) { wp_cache_delete("mods_$theme", 'options'); } +/** + * Remove theme modifications option for current theme. + * + * @since 2.1.0 + */ function remove_theme_mods() { $theme = get_current_theme(); delete_option("mods_$theme"); } +/** + * Retrieve text color for custom header. + * + * @since 2.1.0 + * @uses HEADER_TEXTCOLOR + * + * @return string + */ function get_header_textcolor() { return get_theme_mod('header_textcolor', HEADER_TEXTCOLOR); } +/** + * Display text color for custom header. + * + * @since 2.1.0 + */ function header_textcolor() { echo get_header_textcolor(); } +/** + * Retrieve header image for custom header. + * + * @since 2.1.0 + * @uses HEADER_IMAGE + * + * @return string + */ function get_header_image() { return get_theme_mod('header_image', HEADER_IMAGE); } +/** + * Display header image path. + * + * @since 2.1.0 + */ function header_image() { echo get_header_image(); } +/** + * Add callbacks for image header display. + * + * The parameter $header_callback callback will be required to display the + * content for the 'wp_head' action. The parameter $admin_header_callback + * callback will be added to Custom_Image_Header class and that will be added + * to the 'admin_menu' action. + * + * @since 2.1.0 + * @uses Custom_Image_Header Sets up for $admin_header_callback for administration panel display. + * + * @param callback $header_callback Call on 'wp_head' action. + * @param callback $admin_header_callback Call on administration panels. + */ function add_custom_image_header($header_callback, $admin_header_callback) { if ( ! empty($header_callback) ) add_action('wp_head', $header_callback);