* @subpackage Template
*/
+/**
+ * Whether a child theme is in use.
+ *
+ * @since 3.0.0
+ *
+ * @return bool true if a child theme is in use, false otherwise.
+ **/
+function is_child_theme() {
+ return ( TEMPLATEPATH !== STYLESHEETPATH );
+}
+
/**
* Retrieve name of the current stylesheet.
*
* The description will have the tags filtered with the following HTML elements
* whitelisted. The <b>'a'</b> element with the <em>href</em> and <em>title</em>
* attributes. The <b>abbr</b> element with the <em>title</em> attribute. The
- * <b>acronym<b> element with the <em>title</em> attribute allowed. The
+ * <b>acronym</b> element with the <em>title</em> attribute allowed. The
* <b>code</b>, <b>em</b>, and <b>strong</b> elements also allowed.
*
* The style.css file must contain theme name, theme URI, and description. The
* @return array Theme data.
*/
function get_theme_data( $theme_file ) {
- $default_headers = array(
- 'Name' => 'Theme Name',
- 'URI' => 'Theme URI',
- 'Description' => 'Description',
- 'Author' => 'Author',
+ $default_headers = array(
+ 'Name' => 'Theme Name',
+ 'URI' => 'Theme URI',
+ 'Description' => 'Description',
+ 'Author' => 'Author',
'AuthorURI' => 'Author URI',
- 'Version' => 'Version',
- 'Template' => 'Template',
- 'Status' => 'Status',
+ 'Version' => 'Version',
+ 'Template' => 'Template',
+ 'Status' => 'Status',
'Tags' => 'Tags'
);
$theme_data['Tags'] = array_map( 'trim', explode( ',', wp_kses( $theme_data['Tags'], array() ) ) );
if ( $theme_data['Author'] == '' ) {
- $theme_data['Author'] = __('Anonymous');
+ $theme_data['Author'] = $theme_data['AuthorName'] = __('Anonymous');
} else {
+ $theme_data['AuthorName'] = wp_kses( $theme_data['Author'], $themes_allowed_tags );
if ( empty( $theme_data['AuthorURI'] ) ) {
- $theme_data['Author'] = wp_kses( $theme_data['Author'], $themes_allowed_tags );
+ $theme_data['Author'] = $theme_data['AuthorName'];
} else {
- $theme_data['Author'] = sprintf( '<a href="%1$s" title="%2$s">%3$s</a>', $theme_data['AuthorURI'], __( 'Visit author homepage' ), wp_kses( $theme_data['Author'], $themes_allowed_tags ) );
+ $theme_data['Author'] = sprintf( '<a href="%1$s" title="%2$s">%3$s</a>', $theme_data['AuthorURI'], esc_attr__( 'Visit author homepage' ), $theme_data['AuthorName'] );
}
}
if ( isset($wp_themes) )
return $wp_themes;
- /* Register the default root as a theme directory */
- register_theme_directory( get_theme_root() );
-
if ( !$theme_files = search_theme_directories() )
return false;
$title = $name;
}
+ $parent_template = $template;
+
if ( empty($template) ) {
if ( file_exists("$theme_root/$stylesheet/index.php") )
$template = $stylesheet;
if ( isset($theme_files[$template]) && file_exists( $theme_files[$template]['theme_root'] . "/$template/index.php" ) ) {
$template_directory = $theme_files[$template]['theme_root'] . "/$template";
} else {
- $wp_broken_themes[$name] = array('Name' => $name, 'Title' => $title, 'Description' => __('Template is missing.'));
+ if ( empty( $parent_template) )
+ $wp_broken_themes[$name] = array('Name' => $name, 'Title' => $title, 'Description' => __('Template is missing.'), 'error' => 'no_template');
+ else
+ $wp_broken_themes[$name] = array('Name' => $name, 'Title' => $title, 'Description' => sprintf( __('The parent theme is missing. Please install the "%s" parent theme.'), $parent_template ), 'error' => 'no_parent', 'parent' => $parent_template );
continue;
}
//Make unique and remove duplicates when stylesheet and template are the same i.e. most themes
$template_files = array_unique($template_files);
$stylesheet_files = array_unique($stylesheet_files);
-
- $template_dir = dirname($template_files[0]);
- $stylesheet_dir = dirname($stylesheet_files[0]);
+
+ $template_dir = $template_directory;
+ $stylesheet_dir = $theme_root . '/' . $stylesheet;
if ( empty($template_dir) )
$template_dir = '/';
// Check for theme name collision. This occurs if a theme is copied to
// a new theme directory and the theme header is not updated. Whichever
// theme is first keeps the name. Subsequent themes get a suffix applied.
- // The Default and Classic themes always trump their pretenders.
+ // The Twenty Ten, Default and Classic themes always trump their pretenders.
if ( isset($wp_themes[$name]) ) {
- if ( ('WordPress Default' == $name || 'WordPress Classic' == $name) &&
- ('default' == $stylesheet || 'classic' == $stylesheet) ) {
+ $trump_cards = array(
+ 'classic' => 'WordPress Classic',
+ 'default' => 'WordPress Default',
+ 'twentyten' => 'Twenty Ten',
+ );
+ if ( isset( $trump_cards[ $stylesheet ] ) && $name == $trump_cards[ $stylesheet ] ) {
// If another theme has claimed to be one of our default themes, move
// them aside.
$suffix = $wp_themes[$name]['Stylesheet'];
}
$theme_roots[$stylesheet] = str_replace( WP_CONTENT_DIR, '', $theme_root );
- $wp_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'], 'Theme Root' => $theme_root, 'Theme Root URI' => str_replace( WP_CONTENT_DIR, content_url(), $theme_root ) );
+ $wp_themes[$name] = array(
+ 'Name' => $name,
+ 'Title' => $title,
+ 'Description' => $description,
+ 'Author' => $author,
+ 'Author Name' => $theme_data['AuthorName'],
+ 'Author URI' => $theme_data['AuthorURI'],
+ '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'],
+ 'Theme Root' => $theme_root,
+ 'Theme Root URI' => str_replace( WP_CONTENT_DIR, content_url(), $theme_root ),
+ );
}
unset($theme_files);
*
* @since 2.9.0
*
- * @return array Theme roots
+ * @return array|string An arry of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root.
*/
function get_theme_roots() {
+ global $wp_theme_directories;
+
+ if ( count($wp_theme_directories) <= 1 )
+ return '/themes';
+
$theme_roots = get_site_transient( 'theme_roots' );
if ( false === $theme_roots ) {
get_themes();
$theme_names = array_keys($themes);
$current_template = get_option('template');
$current_stylesheet = get_option('stylesheet');
- $current_theme = 'WordPress Default';
+ $current_theme = 'Twenty Ten';
if ( $themes ) {
foreach ( (array) $theme_names as $theme_name ) {
while ( ($theme_dir = readdir($themes_dir)) !== false ) {
if ( is_dir($theme_root . '/' . $theme_dir) && is_readable($theme_root . '/' . $theme_dir) ) {
- if ( $theme_dir{0} == '.' || $theme_dir == 'CVS' )
+ if ( $theme_dir[0] == '.' || $theme_dir == 'CVS' )
continue;
$stylish_dir = @opendir($theme_root . '/' . $theme_dir);
$found_subdir_themes = false;
while ( ($theme_subdir = readdir($theme_subdirs)) !== false ) {
if ( is_dir( $subdir . '/' . $theme_subdir) && is_readable($subdir . '/' . $theme_subdir) ) {
- if ( $theme_subdir{0} == '.' || $theme_subdir == 'CVS' )
+ if ( $theme_subdir[0] == '.' || $theme_subdir == 'CVS' )
continue;
$stylish_dir = @opendir($subdir . '/' . $theme_subdir);
@closedir($stylish_dir);
}
}
- @closedir($theme_subdir);
+ @closedir($theme_subdirs);
if ( !$found_subdir_themes )
$wp_broken_themes[$theme_dir] = array('Name' => $theme_dir, 'Title' => $theme_dir, 'Description' => __('Stylesheet is missing.'));
}
}
}
- if ( is_dir( $theme_dir ) )
- @closedir( $theme_dir );
+ @closedir( $themes_dir );
}
return $theme_files;
}
* Does not have trailing slash.
*
* @since 1.5.0
- * @param $stylesheet_or_template The stylesheet or template name of the theme
* @uses apply_filters() Calls 'theme_root' filter on path.
*
+ * @param string $stylesheet_or_template The stylesheet or template name of the theme
* @return string Theme path.
*/
function get_theme_root( $stylesheet_or_template = false ) {
- if ($stylesheet_or_template) {
- $theme_roots = get_theme_roots();
-
- if ( $theme_roots[$stylesheet_or_template] )
- $theme_root = WP_CONTENT_DIR . $theme_roots[$stylesheet_or_template];
+ if ( $stylesheet_or_template ) {
+ if ( $theme_root = get_raw_theme_root($stylesheet_or_template) )
+ $theme_root = WP_CONTENT_DIR . $theme_root;
else
$theme_root = WP_CONTENT_DIR . '/themes';
} else {
* Does not have trailing slash.
*
* @since 1.5.0
- * @param $stylesheet_or_template The stylesheet or template name of the theme
*
+ * @param string $stylesheet_or_template The stylesheet or template name of the theme
* @return string Themes URI.
*/
function get_theme_root_uri( $stylesheet_or_template = false ) {
- $theme_roots = get_theme_roots();
-
- if ( $theme_roots[$stylesheet_or_template] )
- $theme_root_uri = content_url( $theme_roots[$stylesheet_or_template] );
- else
+ if ( $stylesheet_or_template ) {
+ if ( $theme_root = get_raw_theme_root($stylesheet_or_template) )
+ $theme_root_uri = content_url( $theme_root );
+ else
+ $theme_root_uri = content_url( 'themes' );
+ } else {
$theme_root_uri = content_url( 'themes' );
+ }
return apply_filters( 'theme_root_uri', $theme_root_uri, get_option('siteurl'), $stylesheet_or_template );
}
/**
- * Retrieve path to file without the use of extension.
+ * Get the raw theme root relative to the content directory with no filters applied.
*
- * 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.
+ * @since 3.1.0
*
- * Can be used with include() or require() to retrieve path.
- * <code>
- * if( '' != get_query_template( '404' ) )
- * include( get_query_template( '404' ) );
- * </code>
- * or the same can be accomplished with
- * <code>
- * if( '' != get_404_template() )
- * include( get_404_template() );
- * </code>
+ * @param string $stylesheet_or_template The stylesheet or template name of the theme
+ * @return string Theme root
+ */
+function get_raw_theme_root( $stylesheet_or_template, $no_cache = false ) {
+ global $wp_theme_directories;
+
+ if ( count($wp_theme_directories) <= 1 )
+ return '/themes';
+
+ $theme_root = false;
+
+ // If requesting the root for the current theme, consult options to avoid calling get_theme_roots()
+ if ( !$no_cache ) {
+ if ( get_option('stylesheet') == $stylesheet_or_template )
+ $theme_root = get_option('stylesheet_root');
+ elseif ( get_option('template') == $stylesheet_or_template )
+ $theme_root = get_option('template_root');
+ }
+
+ if ( empty($theme_root) ) {
+ $theme_roots = get_theme_roots();
+ if ( !empty($theme_roots[$stylesheet_or_template]) )
+ $theme_root = $theme_roots[$stylesheet_or_template];
+ }
+
+ return $theme_root;
+}
+
+/**
+ * Retrieve path to a template
+ *
+ * Used to quickly retrieve the path of a template without including the file
+ * extension. It will also check the parent theme, if the file exists, with
+ * the use of {@link locate_template()}. Allows for more generic template location
+ * without the use of the other get_*_template() functions.
*
* @since 1.5.0
*
* @param string $type Filename without extension.
+ * @param array $templates An optional list of template candidates
* @return string Full path to file.
*/
-function get_query_template($type) {
+function get_query_template( $type, $templates = array() ) {
$type = preg_replace( '|[^a-z0-9-]+|', '', $type );
- return apply_filters("{$type}_template", locate_template(array("{$type}.php")));
+
+ if ( empty( $templates ) )
+ $templates = array("{$type}.php");
+
+ return apply_filters( "{$type}_template", locate_template( $templates ) );
+}
+
+/**
+ * Retrieve path of index template in current or parent template.
+ *
+ * @since 3.0.0
+ *
+ * @return string
+ */
+function get_index_template() {
+ return get_query_template('index');
}
/**
* @return string
*/
function get_archive_template() {
- return get_query_template('archive');
+ $post_type = get_query_var( 'post_type' );
+
+ $templates = array();
+
+ if ( $post_type )
+ $templates[] = "archive-{$post_type}.php";
+ $templates[] = 'archive.php';
+
+ return get_query_template( 'archive', $templates );
}
/**
* @return string
*/
function get_author_template() {
- return get_query_template('author');
+ $author = get_queried_object();
+
+ $templates = array();
+
+ $templates[] = "author-{$author->user_nicename}.php";
+ $templates[] = "author-{$author->ID}.php";
+ $templates[] = 'author.php';
+
+ return get_query_template( 'author', $templates );
}
/**
* @return string
*/
function get_category_template() {
- $cat_ID = absint( get_query_var('cat') );
- $category = get_category( $cat_ID );
+ $category = get_queried_object();
$templates = array();
- if ( !is_wp_error($category) )
- $templates[] = "category-{$category->slug}.php";
-
- $templates[] = "category-$cat_ID.php";
+ $templates[] = "category-{$category->slug}.php";
+ $templates[] = "category-{$category->term_id}.php";
$templates[] = "category.php";
- $template = locate_template($templates);
- return apply_filters('category_template', $template);
+ return get_query_template( 'category', $templates );
}
/**
* @return string
*/
function get_tag_template() {
- $tag_id = absint( get_query_var('tag_id') );
- $tag_name = get_query_var('tag');
+ $tag = get_queried_object();
$templates = array();
- if ( $tag_name )
- $templates[] = "tag-$tag_name.php";
- if ( $tag_id )
- $templates[] = "tag-$tag_id.php";
+ $templates[] = "tag-{$tag->slug}.php";
+ $templates[] = "tag-{$tag->term_id}.php";
$templates[] = "tag.php";
- $template = locate_template($templates);
- return apply_filters('tag_template', $template);
+ return get_query_template( 'tag', $templates );
}
/**
* 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)
+ * @since 2.5.0
* @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');
+ $term = get_queried_object();
+ $taxonomy = $term->taxonomy;
$templates = array();
- if ( $taxonomy && $term )
- $templates[] = "taxonomy-$taxonomy-$term.php";
- if ( $taxonomy )
- $templates[] = "taxonomy-$taxonomy.php";
+ $templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
+ $templates[] = "taxonomy-$taxonomy.php";
$templates[] = "taxonomy.php";
- $template = locate_template($templates);
- return apply_filters('taxonomy_template', $template);
+ return get_query_template( 'taxonomy', $templates );
}
/**
/**
* Retrieve path of home template in current or parent template.
*
+ * This is the template used for the page containing the blog posts
+ *
* Attempts to locate 'home.php' first before falling back to 'index.php'.
*
* @since 1.5.0
* @return string
*/
function get_home_template() {
- $template = locate_template(array('home.php', 'index.php'));
- return apply_filters('home_template', $template);
+ $templates = array( 'home.php', 'index.php' );
+
+ return get_query_template( 'home', $templates );
+}
+
+/**
+ * Retrieve path of front-page template in current or parent template.
+ *
+ * Looks for 'front-page.php'.
+ *
+ * @since 3.0.0
+ * @uses apply_filters() Calls 'front_page_template' on file path of template.
+ *
+ * @return string
+ */
+function get_front_page_template() {
+ $templates = array('front-page.php');
+
+ return get_query_template( 'front_page', $templates );
}
/**
* @return string
*/
function get_page_template() {
- global $wp_query;
-
- $id = (int) $wp_query->post->ID;
+ $id = get_queried_object_id();
$template = get_post_meta($id, '_wp_page_template', true);
$pagename = get_query_var('pagename');
+ if ( !$pagename && $id > 0 ) {
+ // If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
+ $post = get_queried_object();
+ $pagename = $post->post_name;
+ }
+
if ( 'default' == $template )
$template = '';
$templates[] = "page-$id.php";
$templates[] = "page.php";
- return apply_filters('page_template', locate_template($templates));
+ return get_query_template( 'page', $templates );
}
/**
* @return string
*/
function get_single_template() {
- return get_query_template('single');
+ $object = get_queried_object();
+
+ $templates = array();
+
+ $templates[] = "single-{$object->post_type}.php";
+ $templates[] = "single.php";
+
+ return get_query_template( 'single', $templates );
}
/**
* 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.
+ * parent template.
*
* @since 1.5.0
* @uses apply_filters() Calls 'comments_popup_template' filter on path.
* @return string
*/
function get_comments_popup_template() {
- $template = locate_template(array("comments-popup.php"));
+ $template = get_query_template( 'comments_popup', array( 'comments-popup.php' ) );
+
+ // Backward compat code will be removed in a future release
if ('' == $template)
- $template = get_theme_root() . '/default/comments-popup.php';
+ $template = ABSPATH . WPINC . '/theme-compat/comments-popup.php';
- return apply_filters('comments_popup_template', $template);
+ return $template;
}
/**
*
* @since 2.7.0
*
- * @param array $template_names Array of template files to search for in priority order.
+ * @param string|array $template_names Template file(s) to search for, in order.
* @param bool $load If true the template file will be loaded if it is found.
+ * @param bool $require_once Whether to require_once or require. Default true. Has no effect if $load is false.
* @return string The template filename if one is located.
*/
-function locate_template($template_names, $load = false) {
- if (!is_array($template_names))
- return '';
-
+function locate_template($template_names, $load = false, $require_once = true ) {
$located = '';
- foreach($template_names as $template_name) {
+ foreach ( (array) $template_names as $template_name ) {
+ if ( !$template_name )
+ continue;
if ( file_exists(STYLESHEETPATH . '/' . $template_name)) {
$located = STYLESHEETPATH . '/' . $template_name;
break;
}
}
- if ($load && '' != $located)
- load_template($located);
+ if ( $load && '' != $located )
+ load_template( $located, $require_once );
return $located;
}
/**
- * Require once the template file with WordPress environment.
+ * Require 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
* @since 1.5.0
*
* @param string $_template_file Path to template file.
+ * @param bool $require_once Whether to require_once or require. Default true.
*/
-function load_template($_template_file) {
+function load_template( $_template_file, $require_once = true ) {
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);
+ if ( is_array( $wp_query->query_vars ) )
+ extract( $wp_query->query_vars, EXTR_SKIP );
- require_once($_template_file);
+ if ( $require_once )
+ require_once( $_template_file );
+ else
+ require( $_template_file );
}
/**
if ( !current_user_can( 'switch_themes' ) )
return;
+ // Admin Thickbox requests
+ if ( isset( $_GET['preview_iframe'] ) )
+ show_admin_bar( false );
+
$_GET['template'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['template']);
if ( validate_file($_GET['template']) )
}
// Prevent theme mods to current theme being used on theme being previewed
- add_filter( 'pre_option_mods_' . get_current_theme(), create_function( '', "return array();" ) );
+ add_filter( 'pre_option_mods_' . get_current_theme(), '__return_empty_array' );
ob_start( 'preview_theme_ob_filter' );
}
if (
( false !== strpos($matches[3], '/wp-admin/') )
||
- ( false !== strpos($matches[3], '://') && 0 !== strpos($matches[3], get_option('home')) )
+ ( false !== strpos( $matches[3], '://' ) && 0 !== strpos( $matches[3], home_url() ) )
||
( false !== strpos($matches[3], '/feed/') )
||
/**
* Switches current theme to new template and stylesheet names.
*
- * @since unknown
+ * @since 2.5.0
* @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) {
+ global $wp_theme_directories;
+
update_option('template', $template);
update_option('stylesheet', $stylesheet);
+ if ( count($wp_theme_directories) > 1 ) {
+ update_option('template_root', get_raw_theme_root($template, true));
+ update_option('stylesheet_root', get_raw_theme_root($stylesheet, true));
+ }
delete_option('current_theme');
$theme = get_current_theme();
+ if ( is_admin() && false === get_option( "theme_mods_$stylesheet" ) ) {
+ $default_theme_mods = (array) get_option( "mods_$theme" );
+ add_option( "theme_mods_$stylesheet", $default_theme_mods );
+ }
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.
+ * Does not check the default theme, which is the fallback and should always exist.
+ * Will switch theme to the fallback theme 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
+ * @see WP_DEFAULT_THEME
*
* @return bool
*/
if ( defined('WP_INSTALLING') || !apply_filters( 'validate_current_theme', true ) )
return true;
- if ( get_template() != 'default' && !file_exists(get_template_directory() . '/index.php') ) {
- switch_theme('default', 'default');
+ if ( get_template() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/index.php') ) {
+ switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME );
+ return false;
+ }
+
+ if ( get_stylesheet() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/style.css') ) {
+ switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME );
return false;
}
- if ( get_stylesheet() != 'default' && !file_exists(get_template_directory() . '/style.css') ) {
- switch_theme('default', 'default');
+ if ( is_child_theme() && ! file_exists( get_stylesheet_directory() . '/style.css' ) ) {
+ switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME );
return false;
}
return true;
}
+/**
+ * Retrieve all theme modifications.
+ *
+ * @since 3.1.0
+ *
+ * @return array Theme modifications.
+ */
+function get_theme_mods() {
+ $theme_slug = get_option( 'stylesheet' );
+ if ( false === ( $mods = get_option( "theme_mods_$theme_slug" ) ) ) {
+ $theme_name = get_current_theme();
+ $mods = get_option( "mods_$theme_name" ); // Deprecated location.
+ if ( is_admin() && false !== $mods ) {
+ update_option( "theme_mods_$theme_slug", $mods );
+ delete_option( "mods_$theme_name" );
+ }
+ }
+ return $mods;
+}
+
/**
* Retrieve theme modification value for the current theme.
*
* @param bool|string $default
* @return string
*/
-function get_theme_mod($name, $default = false) {
- $theme = get_current_theme();
-
- $mods = get_option("mods_$theme");
+function get_theme_mod( $name, $default = false ) {
+ $mods = get_theme_mods();
- if ( isset($mods[$name]) )
- return apply_filters( "theme_mod_$name", $mods[$name] );
+ if ( isset( $mods[ $name ] ) )
+ return apply_filters( "theme_mod_$name", $mods[ $name ] );
- return apply_filters( "theme_mod_$name", sprintf($default, get_template_directory_uri(), get_stylesheet_directory_uri()) );
+ return apply_filters( "theme_mod_$name", sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() ) );
}
/**
* @param string $name Theme modification name.
* @param string $value theme modification value.
*/
-function set_theme_mod($name, $value) {
- $theme = get_current_theme();
-
- $mods = get_option("mods_$theme");
+function set_theme_mod( $name, $value ) {
+ $mods = get_theme_mods();
- $mods[$name] = $value;
+ $mods[ $name ] = $value;
- update_option("mods_$theme", $mods);
- wp_cache_delete("mods_$theme", 'options');
+ $theme = get_option( 'stylesheet' );
+ update_option( "theme_mods_$theme", $mods );
}
/**
* @return null
*/
function remove_theme_mod( $name ) {
- $theme = get_current_theme();
-
- $mods = get_option("mods_$theme");
+ $mods = get_theme_mods();
- if ( !isset($mods[$name]) )
+ if ( ! isset( $mods[ $name ] ) )
return;
- unset($mods[$name]);
+ unset( $mods[ $name ] );
- if ( empty($mods) )
+ if ( empty( $mods ) )
return remove_theme_mods();
- update_option("mods_$theme", $mods);
- wp_cache_delete("mods_$theme", 'options');
+ $theme = get_option( 'stylesheet' );
+ update_option( "theme_mods_$theme", $mods );
}
/**
* @since 2.1.0
*/
function remove_theme_mods() {
- $theme = get_current_theme();
-
- delete_option("mods_$theme");
+ delete_option( 'theme_mods_' . get_option( 'stylesheet' ) );
+ delete_option( 'mods_' . get_current_theme() );
}
/**
* @return string
*/
function get_header_textcolor() {
- return get_theme_mod('header_textcolor', HEADER_TEXTCOLOR);
+ $default = defined('HEADER_TEXTCOLOR') ? HEADER_TEXTCOLOR : '';
+
+ return get_theme_mod('header_textcolor', $default);
}
/**
* @return string
*/
function get_header_image() {
- return get_theme_mod('header_image', HEADER_IMAGE);
+ $default = defined( 'HEADER_IMAGE' ) ? HEADER_IMAGE : '';
+
+ $url = get_theme_mod( 'header_image', $default );
+
+ if ( is_ssl() )
+ $url = str_replace( 'http://', 'https://', $url );
+ else
+ $url = str_replace( 'https://', 'http://', $url );
+
+ return $url;
}
/**
* @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.
+ * @param callback $admin_header_callback Call on custom header administration screen.
+ * @param callback $admin_image_div_callback Output a custom header image div on the custom header administration screen. Optional.
*/
-function add_custom_image_header($header_callback, $admin_header_callback) {
- if ( ! empty($header_callback) )
+function add_custom_image_header( $header_callback, $admin_header_callback, $admin_image_div_callback = '' ) {
+ if ( ! empty( $header_callback ) )
add_action('wp_head', $header_callback);
+ add_theme_support( 'custom-header', array( 'callback' => $header_callback ) );
+ add_theme_support( 'custom-header-uploads' );
+
+ if ( ! is_admin() )
+ return;
+
+ global $custom_image_header;
+
+ require_once( ABSPATH . 'wp-admin/custom-header.php' );
+ $custom_image_header = new Custom_Image_Header( $admin_header_callback, $admin_image_div_callback );
+ add_action( 'admin_menu', array( &$custom_image_header, 'init' ) );
+}
+
+/**
+ * Remove image header support.
+ *
+ * @since 3.1.0
+ * @see add_custom_image_header()
+ *
+ * @return bool Whether support was removed.
+ */
+function remove_custom_image_header() {
+ if ( ! current_theme_supports( 'custom-header' ) )
+ return false;
+
+ $callback = get_theme_support( 'custom-header' );
+ remove_action( 'wp_head', $callback[0]['callback'] );
+ _remove_theme_support( 'custom-header' );
+ remove_theme_support( 'custom-header-uploads' );
+
+ if ( is_admin() ) {
+ remove_action( 'admin_menu', array( &$GLOBALS['custom_image_header'], 'init' ) );
+ unset( $GLOBALS['custom_image_header'] );
+ }
+
+ return true;
+}
+
+/**
+ * Register a selection of default headers to be displayed by the custom header admin UI.
+ *
+ * @since 3.0.0
+ *
+ * @param array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys.
+ */
+function register_default_headers( $headers ) {
+ global $_wp_default_headers;
+
+ $_wp_default_headers = array_merge( (array) $_wp_default_headers, (array) $headers );
+}
+
+/**
+ * Unregister default headers.
+ *
+ * This function must be called after register_default_headers() has already added the
+ * header you want to remove.
+ *
+ * @see register_default_headers()
+ * @since 3.0.0
+ *
+ * @param string|array $header The header string id (key of array) to remove, or an array thereof.
+ * @return True on success, false on failure.
+ */
+function unregister_default_headers( $header ) {
+ global $_wp_default_headers;
+ if ( is_array( $header ) ) {
+ array_map( 'unregister_default_headers', $header );
+ } elseif ( isset( $_wp_default_headers[ $header ] ) ) {
+ unset( $_wp_default_headers[ $header ] );
+ return true;
+ } else {
+ return false;
+ }
+}
+
+/**
+ * Retrieve background image for custom background.
+ *
+ * @since 3.0.0
+ *
+ * @return string
+ */
+function get_background_image() {
+ $default = defined('BACKGROUND_IMAGE') ? BACKGROUND_IMAGE : '';
+
+ return get_theme_mod('background_image', $default);
+}
+
+/**
+ * Display background image path.
+ *
+ * @since 3.0.0
+ */
+function background_image() {
+ echo get_background_image();
+}
+
+/**
+ * Retrieve value for custom background color.
+ *
+ * @since 3.0.0
+ * @uses BACKGROUND_COLOR
+ *
+ * @return string
+ */
+function get_background_color() {
+ $default = defined('BACKGROUND_COLOR') ? BACKGROUND_COLOR : '';
+
+ return get_theme_mod('background_color', $default);
+}
+
+/**
+ * Display background color value.
+ *
+ * @since 3.0.0
+ */
+function background_color() {
+ echo get_background_color();
+}
+
+/**
+ * Add callbacks for background image 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_Background class and that will be added
+ * to the 'admin_menu' action.
+ *
+ * @since 3.0.0
+ * @uses Custom_Background 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 custom background administration screen.
+ * @param callback $admin_image_div_callback Output a custom background image div on the custom background administration screen. Optional.
+ */
+function add_custom_background( $header_callback = '', $admin_header_callback = '', $admin_image_div_callback = '' ) {
+ if ( isset( $GLOBALS['custom_background'] ) )
+ return;
+
+ if ( empty( $header_callback ) )
+ $header_callback = '_custom_background_cb';
+
+ add_action( 'wp_head', $header_callback );
+
+ add_theme_support( 'custom-background', array( 'callback' => $header_callback ) );
+
if ( ! is_admin() )
return;
- require_once(ABSPATH . 'wp-admin/custom-header.php');
- $GLOBALS['custom_image_header'] =& new Custom_Image_Header($admin_header_callback);
- add_action('admin_menu', array(&$GLOBALS['custom_image_header'], 'init'));
+ require_once( ABSPATH . 'wp-admin/custom-background.php' );
+ $GLOBALS['custom_background'] =& new Custom_Background( $admin_header_callback, $admin_image_div_callback );
+ add_action( 'admin_menu', array( &$GLOBALS['custom_background'], 'init' ) );
+}
+
+/**
+ * Remove custom background support.
+ *
+ * @since 3.1.0
+ * @see add_custom_background()
+ *
+ * @return bool Whether support was removed.
+ */
+function remove_custom_background() {
+ if ( ! current_theme_supports( 'custom-background' ) )
+ return false;
+
+ $callback = get_theme_support( 'custom-background' );
+ remove_action( 'wp_head', $callback[0]['callback'] );
+ _remove_theme_support( 'custom-background' );
+
+ if ( is_admin() ) {
+ remove_action( 'admin_menu', array( &$GLOBALS['custom_background'], 'init' ) );
+ unset( $GLOBALS['custom_background'] );
+ }
+
+ return true;
+}
+
+/**
+ * Default custom background callback.
+ *
+ * @since 3.0.0
+ * @see add_custom_background()
+ * @access protected
+ */
+function _custom_background_cb() {
+ $background = get_background_image();
+ $color = get_background_color();
+ if ( ! $background && ! $color )
+ return;
+
+ $style = $color ? "background-color: #$color;" : '';
+
+ if ( $background ) {
+ $image = " background-image: url('$background');";
+
+ $repeat = get_theme_mod( 'background_repeat', 'repeat' );
+ if ( ! in_array( $repeat, array( 'no-repeat', 'repeat-x', 'repeat-y', 'repeat' ) ) )
+ $repeat = 'repeat';
+ $repeat = " background-repeat: $repeat;";
+
+ $position = get_theme_mod( 'background_position_x', 'left' );
+ if ( ! in_array( $position, array( 'center', 'right', 'left' ) ) )
+ $position = 'left';
+ $position = " background-position: top $position;";
+
+ $attachment = get_theme_mod( 'background_attachment', 'scroll' );
+ if ( ! in_array( $attachment, array( 'fixed', 'scroll' ) ) )
+ $attachment = 'scroll';
+ $attachment = " background-attachment: $attachment;";
+
+ $style .= $image . $repeat . $position . $attachment;
+ }
+?>
+<style type="text/css">
+body { <?php echo trim( $style ); ?> }
+</style>
+<?php
+}
+
+/**
+ * Add callback for custom TinyMCE editor stylesheets.
+ *
+ * The parameter $stylesheet is the name of the stylesheet, relative to
+ * the theme root. It also accepts an array of stylesheets.
+ * It is optional and defaults to 'editor-style.css'.
+ *
+ * Supports RTL stylesheets automatically by searching for the -rtl prefix, e.g.
+ * editor-style-rtl.css. If an array of stylesheets is passed to add_editor_style(),
+ * RTL is only added for the first stylesheet.
+ *
+ * @since 3.0.0
+ *
+ * @param mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
+ * Defaults to 'editor-style.css'
+ */
+function add_editor_style( $stylesheet = 'editor-style.css' ) {
+
+ add_theme_support( 'editor-style' );
+
+ if ( ! is_admin() )
+ return;
+
+ global $editor_styles;
+ $editor_styles = (array) $editor_styles;
+ $stylesheet = (array) $stylesheet;
+ if ( is_rtl() ) {
+ $rtl_stylesheet = str_replace('.css', '-rtl.css', $stylesheet[0]);
+ $stylesheet[] = $rtl_stylesheet;
+ }
+
+ $editor_styles = array_merge( $editor_styles, $stylesheet );
+}
+
+/**
+ * Removes all visual editor stylesheets.
+ *
+ * @since 3.1.0
+ *
+ * @return bool True on success, false if there were no stylesheets to remove.
+ */
+function remove_editor_styles() {
+ if ( ! current_theme_supports( 'editor-style' ) )
+ return false;
+ _remove_theme_support( 'editor-style' );
+ if ( is_admin() )
+ $GLOBALS['editor_styles'] = array();
+ return true;
}
/**
* Allows a theme to register its support of a certain feature
- *
- * Must be called in the themes functions.php file to work.
*
- * @author Mark Jaquith
- * @since 2.9
+ * Must be called in the theme's functions.php file to work.
+ * If attached to a hook, it must be after_setup_theme.
+ * The init hook may be too late for some features.
+ *
+ * @since 2.9.0
* @param string $feature the feature being added
*/
function add_theme_support( $feature ) {
$_wp_theme_features[$feature] = true;
else
$_wp_theme_features[$feature] = array_slice( func_get_args(), 1 );
+
+ if ( $feature == 'post-formats' && is_array( $_wp_theme_features[$feature][0] ) )
+ $_wp_theme_features[$feature][0] = array_intersect( $_wp_theme_features[$feature][0], array_keys( get_post_format_slugs() ) );
+}
+
+/**
+ * Gets the theme support arguments passed when registering that support
+ *
+ * @since 3.1
+ * @param string $feature the feature to check
+ * @return array The array of extra arguments
+ */
+function get_theme_support( $feature ) {
+ global $_wp_theme_features;
+ if ( !isset( $_wp_theme_features[$feature] ) )
+ return false;
+ else
+ return $_wp_theme_features[$feature];
+}
+
+/**
+ * Allows a theme to de-register its support of a certain feature
+ *
+ * Should be called in the theme's functions.php file. Generally would
+ * be used for child themes to override support from the parent theme.
+ *
+ * @since 3.0.0
+ * @see add_theme_support()
+ * @param string $feature the feature being added
+ * @return bool Whether feature was removed.
+ */
+function remove_theme_support( $feature ) {
+ // Blacklist: for internal registrations not used directly by themes.
+ if ( in_array( $feature, array( 'custom-background', 'custom-header', 'editor-style', 'widgets', 'menus' ) ) )
+ return false;
+ return _remove_theme_support( $feature );
+}
+
+/**
+ * Do not use. Removes theme support internally, ignorant of the blacklist.
+ *
+ * @access private
+ * @since 3.1.0
+ */
+function _remove_theme_support( $feature ) {
+ global $_wp_theme_features;
+
+ if ( ! isset( $_wp_theme_features[$feature] ) )
+ return false;
+ unset( $_wp_theme_features[$feature] );
+ return true;
}
/**
* Checks a theme's support for a given feature
*
- * @author Mark Jaquith
- * @since 2.9
+ * @since 2.9.0
* @param string $feature the feature being checked
* @return boolean
*/
-
function current_theme_supports( $feature ) {
global $_wp_theme_features;
/**
* Checks a theme's support for a given feature before loading the functions which implement it.
*
- * @author Peter Westwood
- * @since 2.9
+ * @since 2.9.0
* @param string $feature the feature being checked
* @param string $include the file containing the functions that implement the feature
*/
require ( $include );
}
+/**
+ * Checks an attachment being deleted to see if it's a header or background image.
+ *
+ * If true it removes the theme modification which would be pointing at the deleted
+ * attachment
+ *
+ * @access private
+ * @since 3.0.0
+ * @param int $id the attachment id
+ */
+function _delete_attachment_theme_mod( $id ) {
+ $attachment_image = wp_get_attachment_url( $id );
+ $header_image = get_header_image();
+ $background_image = get_background_image();
+
+ if ( $header_image && $header_image == $attachment_image )
+ remove_theme_mod( 'header_image' );
+
+ if ( $background_image && $background_image == $attachment_image )
+ remove_theme_mod( 'background_image' );
+}
+
+add_action( 'delete_attachment', '_delete_attachment_theme_mod' );
+
?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff