false, 'allowed' => null, 'blog_id' => 0 );
$args = wp_parse_args( $args, $defaults );
static $_theme_directories, $_themes = array();
if ( ! isset( $_theme_directories ) ) {
$_theme_directories = search_theme_directories();
if ( count( $wp_theme_directories ) > 1 ) {
// Make sure the current theme wins out, in case search_theme_directories() picks the wrong
// one in the case of a conflict. (Normally, last registered theme root wins.)
$current_theme = get_stylesheet();
$root_of_current_theme = get_raw_theme_root( $current_theme );
if ( ! in_array( $root_of_current_theme, $wp_theme_directories ) )
$root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme;
$_theme_directories[ $current_theme ]['theme_root'] = $root_of_current_theme;
}
}
if ( empty( $_theme_directories ) )
return array();
$theme_directories = $_theme_directories;
if ( is_multisite() && null !== $args['allowed'] ) {
$allowed = $args['allowed'];
if ( 'network' === $allowed )
$theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_network( $args['blog_id'] ) );
elseif ( 'site' === $allowed )
$theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_site( $args['blog_id'] ) );
elseif ( $allowed )
$theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
else
$theme_directories = array_diff_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
}
$themes = array();
foreach ( $theme_directories as $theme => $theme_root ) {
if ( isset( $_themes[ $theme ] ) )
$themes[ $theme ] = $_themes[ $theme ];
else
$themes[ $theme ] = $_themes[ $theme ] = new WP_Theme( $theme, $theme_root['theme_root'] );
}
if ( null !== $args['errors'] ) {
foreach ( $themes as $theme => $wp_theme ) {
if ( $wp_theme->errors() != $args['errors'] )
unset( $themes[ $theme ] );
}
}
return $themes;
}
/**
* Gets a WP_Theme object for a theme.
*
* @since 3.4.0
*
* @param string $stylesheet Directory name for the theme. Optional. Defaults to current theme.
* @param string $theme_root Absolute path of the theme root to look in. Optional. If not specified, get_raw_theme_root()
* is used to calculate the theme root for the $stylesheet provided (or current theme).
* @return WP_Theme
*/
function wp_get_theme( $stylesheet = null, $theme_root = null ) {
global $wp_theme_directories;
if ( empty( $stylesheet ) )
$stylesheet = get_stylesheet();
if ( empty( $theme_root ) ) {
$theme_root = get_raw_theme_root( $stylesheet );
if ( ! in_array( $theme_root, (array) $wp_theme_directories ) )
$theme_root = WP_CONTENT_DIR . $theme_root;
}
return new WP_Theme( $stylesheet, $theme_root );
}
/**
* 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 theme name that the administrator has currently set the front end theme
* as.
*
* For all extensive purposes, the template name and the stylesheet name are
* going to be the same for most cases.
*
* @since 1.5.0
* @uses apply_filters() Calls 'stylesheet' filter on stylesheet name.
*
* @return string Stylesheet name.
*/
function get_stylesheet() {
return apply_filters('stylesheet', get_option('stylesheet'));
}
/**
* Retrieve stylesheet directory path for current theme.
*
* @since 1.5.0
* @uses apply_filters() Calls 'stylesheet_directory' filter on stylesheet directory and theme name.
*
* @return string Path to current theme directory.
*/
function get_stylesheet_directory() {
$stylesheet = get_stylesheet();
$theme_root = get_theme_root( $stylesheet );
$stylesheet_dir = "$theme_root/$stylesheet";
return apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root );
}
/**
* Retrieve stylesheet directory URI.
*
* @since 1.5.0
*
* @return string
*/
function get_stylesheet_directory_uri() {
$stylesheet = get_stylesheet();
$theme_root_uri = get_theme_root_uri( $stylesheet );
$stylesheet_dir_uri = "$theme_root_uri/$stylesheet";
return apply_filters( 'stylesheet_directory_uri', $stylesheet_dir_uri, $stylesheet, $theme_root_uri );
}
/**
* Retrieve URI of current theme stylesheet.
*
* The stylesheet file name is 'style.css' which is appended to {@link
* get_stylesheet_directory_uri() stylesheet directory URI} path.
*
* @since 1.5.0
* @uses apply_filters() Calls 'stylesheet_uri' filter on stylesheet URI path and stylesheet directory URI.
*
* @return string
*/
function get_stylesheet_uri() {
$stylesheet_dir_uri = get_stylesheet_directory_uri();
$stylesheet_uri = $stylesheet_dir_uri . '/style.css';
return apply_filters('stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri);
}
/**
* Retrieve localized stylesheet URI.
*
* The stylesheet directory for the localized stylesheet files are located, by
* default, in the base theme directory. The name of the locale file will be the
* locale followed by '.css'. If that does not exist, then the text direction
* stylesheet will be checked for existence, for example 'ltr.css'.
*
* The theme may change the location of the stylesheet directory by either using
* the 'stylesheet_directory_uri' filter or the 'locale_stylesheet_uri' filter.
* If you want to change the location of the stylesheet files for the entire
* WordPress workflow, then change the former. If you just have the locale in a
* separate folder, then change the latter.
*
* @since 2.1.0
* @uses apply_filters() Calls 'locale_stylesheet_uri' filter on stylesheet URI path and stylesheet directory URI.
*
* @return string
*/
function get_locale_stylesheet_uri() {
global $wp_locale;
$stylesheet_dir_uri = get_stylesheet_directory_uri();
$dir = get_stylesheet_directory();
$locale = get_locale();
if ( file_exists("$dir/$locale.css") )
$stylesheet_uri = "$stylesheet_dir_uri/$locale.css";
elseif ( !empty($wp_locale->text_direction) && file_exists("$dir/{$wp_locale->text_direction}.css") )
$stylesheet_uri = "$stylesheet_dir_uri/{$wp_locale->text_direction}.css";
else
$stylesheet_uri = '';
return apply_filters('locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri);
}
/**
* Retrieve name of the current theme.
*
* @since 1.5.0
* @uses apply_filters() Calls 'template' filter on template option.
*
* @return string Template name.
*/
function get_template() {
return apply_filters('template', get_option('template'));
}
/**
* Retrieve current theme directory.
*
* @since 1.5.0
* @uses apply_filters() Calls 'template_directory' filter on template directory path and template name.
*
* @return string Template directory path.
*/
function get_template_directory() {
$template = get_template();
$theme_root = get_theme_root( $template );
$template_dir = "$theme_root/$template";
return apply_filters( 'template_directory', $template_dir, $template, $theme_root );
}
/**
* Retrieve theme directory URI.
*
* @since 1.5.0
* @uses apply_filters() Calls 'template_directory_uri' filter on template directory URI path and template name.
*
* @return string Template directory URI.
*/
function get_template_directory_uri() {
$template = get_template();
$theme_root_uri = get_theme_root_uri( $template );
$template_dir_uri = "$theme_root_uri/$template";
return apply_filters( 'template_directory_uri', $template_dir_uri, $template, $theme_root_uri );
}
/**
* Retrieve theme data from parsed theme file.
*
* The description will have the tags filtered with the following HTML elements
* whitelisted. The '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 ) {
$default_headers = array(
'Name' => 'Theme Name',
'URI' => 'Theme URI',
'Description' => 'Description',
'Author' => 'Author',
'AuthorURI' => 'Author URI',
'Version' => 'Version',
'Template' => 'Template',
'Status' => 'Status',
'Tags' => 'Tags'
);
$themes_allowed_tags = array(
'a' => array(
'href' => array(),'title' => array()
),
'abbr' => array(
'title' => array()
),
'acronym' => array(
'title' => array()
),
'code' => array(),
'em' => array(),
'strong' => array()
);
$theme_data = get_file_data( $theme_file, $default_headers, 'theme' );
$theme_data['Name'] = $theme_data['Title'] = wp_kses( $theme_data['Name'], $themes_allowed_tags );
$theme_data['URI'] = esc_url( $theme_data['URI'] );
$theme_data['Description'] = wptexturize( wp_kses( $theme_data['Description'], $themes_allowed_tags ) );
$theme_data['AuthorURI'] = esc_url( $theme_data['AuthorURI'] );
$theme_data['Template'] = wp_kses( $theme_data['Template'], $themes_allowed_tags );
$theme_data['Version'] = wp_kses( $theme_data['Version'], $themes_allowed_tags );
if ( $theme_data['Status'] == '' )
$theme_data['Status'] = 'publish';
else
$theme_data['Status'] = wp_kses( $theme_data['Status'], $themes_allowed_tags );
if ( $theme_data['Tags'] == '' )
$theme_data['Tags'] = array();
else
$theme_data['Tags'] = array_map( 'trim', explode( ',', wp_kses( $theme_data['Tags'], array() ) ) );
if ( $theme_data['Author'] == '' ) {
$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'] = $theme_data['AuthorName'];
} else {
$theme_data['Author'] = sprintf( '%3$s', $theme_data['AuthorURI'], esc_attr__( 'Visit author homepage' ), $theme_data['AuthorName'] );
}
}
return $theme_data;
}
/**
* Retrieve theme roots.
*
* @since 2.9.0
*
* @return array|string An array 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 ) {
search_theme_directories(); // Regenerate the transient.
$theme_roots = get_site_transient( 'theme_roots' );
}
return $theme_roots;
}
/**
* Register a directory that contains themes.
*
* @since 2.9.0
*
* @param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR
* @return bool
*/
function register_theme_directory( $directory ) {
global $wp_theme_directories;
if ( ! file_exists( $directory ) ) {
// Try prepending as the theme directory could be relative to the content directory
$directory = WP_CONTENT_DIR . '/' . $directory;
// If this directory does not exist, return and do not register
if ( ! file_exists( $directory ) )
return false;
}
$wp_theme_directories[] = $directory;
return true;
}
/**
* Search all registered theme directories for complete and valid themes.
*
* @since 2.9.0
*
* @return array Valid themes found
*/
function search_theme_directories() {
global $wp_theme_directories;
if ( empty( $wp_theme_directories ) )
return false;
static $found_themes;
if ( isset( $found_themes ) )
return $found_themes;
$found_themes = array();
// Set up maybe-relative, maybe-absolute array of theme directories.
// We always want to return absolute, but we need to cache relative
// use in for get_theme_root().
foreach ( $wp_theme_directories as $theme_root ) {
if ( 0 === strpos( $theme_root, WP_CONTENT_DIR ) )
$relative_theme_roots[ str_replace( WP_CONTENT_DIR, '', $theme_root ) ] = $theme_root;
else
$relative_theme_roots[ $theme_root ] = $theme_root;
}
if ( $cache_expiration = apply_filters( 'wp_cache_themes_persistently', false, 'search_theme_directories' ) ) {
$cached_roots = get_site_transient( 'theme_roots' );
if ( is_array( $cached_roots ) ) {
foreach ( $cached_roots as $theme_dir => $theme_root ) {
$found_themes[ $theme_dir ] = array(
'theme_file' => $theme_dir . '/style.css',
'theme_root' => $relative_theme_roots[ $theme_root ], // Convert relative to absolute.
);
}
return $found_themes;
}
if ( ! is_int( $cache_expiration ) )
$cache_expiration = 7200;
} else {
// Two hours is the default.
$cache_expiration = 7200;
}
/* Loop the registered theme directories and extract all themes */
foreach ( $wp_theme_directories as $theme_root ) {
// Start with directories in the root of the current theme directory.
$dirs = @ scandir( $theme_root );
if ( ! $dirs )
return false;
foreach ( $dirs as $dir ) {
if ( ! is_dir( $theme_root . '/' . $dir ) || $dir[0] == '.' || $dir == 'CVS' )
continue;
if ( file_exists( $theme_root . '/' . $dir . '/style.css' ) ) {
// wp-content/themes/a-single-theme
// wp-content/themes is $theme_root, a-single-theme is $dir
$found_themes[ $dir ] = array(
'theme_file' => $dir . '/style.css',
'theme_root' => $theme_root,
);
} else {
$found_theme = false;
// wp-content/themes/a-folder-of-themes/*
// wp-content/themes is $theme_root, a-folder-of-themes is $dir, then themes are $sub_dirs
$sub_dirs = @ scandir( $theme_root . '/' . $dir );
if ( ! $sub_dirs )
return false;
foreach ( $sub_dirs as $sub_dir ) {
if ( ! is_dir( $theme_root . '/' . $dir ) || $dir[0] == '.' || $dir == 'CVS' )
continue;
if ( ! file_exists( $theme_root . '/' . $dir . '/' . $sub_dir . '/style.css' ) )
continue;
$found_themes[ $dir . '/' . $sub_dir ] = array(
'theme_file' => $dir . '/' . $sub_dir . '/style.css',
'theme_root' => $theme_root,
);
$found_theme = true;
}
// Never mind the above, it's just a theme missing a style.css.
// Return it; WP_Theme will catch the error.
if ( ! $found_theme )
$found_themes[ $dir ] = array(
'theme_file' => $dir . '/style.css',
'theme_root' => $theme_root,
);
}
}
}
asort( $found_themes );
$theme_roots = array();
$relative_theme_roots = array_flip( $relative_theme_roots );
foreach ( $found_themes as $theme_dir => $theme_data ) {
$theme_roots[ $theme_dir ] = $relative_theme_roots[ $theme_data['theme_root'] ]; // Convert absolute to relative.
}
if ( $theme_roots != get_site_transient( 'theme_roots' ) )
set_site_transient( 'theme_roots', $theme_roots, $cache_expiration );
return $found_themes;
}
/**
* Retrieve path to themes directory.
*
* Does not have trailing slash.
*
* @since 1.5.0
* @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 ) {
global $wp_theme_directories;
if ( $stylesheet_or_template && $theme_root = get_raw_theme_root( $stylesheet_or_template ) ) {
// Always prepend WP_CONTENT_DIR unless the root currently registered as a theme directory.
// This gives relative theme roots the benefit of the doubt when things go haywire.
if ( ! in_array( $theme_root, (array) $wp_theme_directories ) )
$theme_root = WP_CONTENT_DIR . $theme_root;
} else {
$theme_root = WP_CONTENT_DIR . '/themes';
}
return apply_filters( 'theme_root', $theme_root );
}
/**
* Retrieve URI for themes directory.
*
* Does not have trailing slash.
*
* @since 1.5.0
*
* @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 ) {
global $wp_theme_directories;
if ( $stylesheet_or_template && $theme_root = get_raw_theme_root( $stylesheet_or_template ) ) {
if ( in_array( $theme_root, (array) $wp_theme_directories ) ) {
// Absolute path. Make an educated guess. YMMV -- but note the filter below.
if ( 0 === strpos( $theme_root, WP_CONTENT_DIR ) )
$theme_root_uri = content_url( str_replace( WP_CONTENT_DIR, '', $theme_root ) );
elseif ( 0 === strpos( $theme_root, ABSPATH ) )
$theme_root_uri = site_url( str_replace( ABSPATH, '', $theme_root ) );
elseif ( 0 === strpos( $theme_root, WP_PLUGIN_DIR ) || 0 === strpos( $theme_root, WPMU_PLUGIN_DIR ) )
$theme_root_uri = plugins_url( basename( $theme_root ), $theme_root );
else
$theme_root_uri = $theme_root;
} else {
$theme_root_uri = content_url( $theme_root );
}
} else {
$theme_root_uri = content_url( 'themes' );
}
return apply_filters( 'theme_root_uri', $theme_root_uri, get_option('siteurl'), $stylesheet_or_template );
}
/**
* Get the raw theme root relative to the content directory with no filters applied.
*
* @since 3.1.0
*
* @param string $stylesheet_or_template The stylesheet or template name of the theme
* @param bool $skip_cache Optional. Whether to skip the cache. Defaults to false, meaning the cache is used.
* @return string Theme root
*/
function get_raw_theme_root( $stylesheet_or_template, $skip_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 ( ! $skip_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;
}
/**
* Display localized stylesheet link element.
*
* @since 2.1.0
*/
function locale_stylesheet() {
$stylesheet = get_locale_stylesheet_uri();
if ( empty($stylesheet) )
return;
echo '';
}
/**
* Start preview theme output buffer.
*
* Will only preform task if the user has permissions and template and preview
* query variables exist.
*
* @since 2.6.0
*/
function preview_theme() {
if ( ! (isset($_GET['template']) && isset($_GET['preview'])) )
return;
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']) )
return;
add_filter( 'template', '_preview_theme_template_filter' );
if ( isset($_GET['stylesheet']) ) {
$_GET['stylesheet'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['stylesheet']);
if ( validate_file($_GET['stylesheet']) )
return;
add_filter( 'stylesheet', '_preview_theme_stylesheet_filter' );
}
// Prevent theme mods to current theme being used on theme being previewed
add_filter( 'pre_option_theme_mods_' . get_option( 'stylesheet' ), '__return_empty_array' );
ob_start( 'preview_theme_ob_filter' );
}
add_action('setup_theme', 'preview_theme');
/**
* Private function to modify the current template when previewing a theme
*
* @since 2.9.0
* @access private
*
* @return string
*/
function _preview_theme_template_filter() {
return isset($_GET['template']) ? $_GET['template'] : '';
}
/**
* Private function to modify the current stylesheet when previewing a theme
*
* @since 2.9.0
* @access private
*
* @return string
*/
function _preview_theme_stylesheet_filter() {
return isset($_GET['stylesheet']) ? $_GET['stylesheet'] : '';
}
/**
* Callback function for ob_start() to capture all links in the theme.
*
* @since 2.6.0
* @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 2.6.0
* @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'], 'preview_iframe' => 1 ), $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 2.5.0
* @uses do_action() Calls 'switch_theme' action, passing the new theme.
*
* @param string $template Template name
* @param string $stylesheet Stylesheet name.
*/
function switch_theme( $template, $stylesheet ) {
global $wp_theme_directories, $sidebars_widgets;
if ( is_array( $sidebars_widgets ) )
set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $sidebars_widgets ) );
$old_theme = wp_get_theme();
$new_theme = wp_get_theme( $stylesheet );
$new_name = $new_theme->get('Name');
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 ) );
}
update_option( 'current_theme', $new_name );
if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
$default_theme_mods = (array) get_option( 'mods_' . $new_name );
add_option( "theme_mods_$stylesheet", $default_theme_mods );
}
update_option( 'theme_switched', $old_theme->get('Name') );
do_action( 'switch_theme', $new_name, $new_theme );
}
/**
* Checks that current theme files 'index.php' and 'style.css' exists.
*
* 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
*/
function validate_current_theme() {
// Don't validate during an install/upgrade.
if ( defined('WP_INSTALLING') || !apply_filters( 'validate_current_theme', true ) )
return true;
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 ( 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_option( 'current_theme' );
if ( false === $theme_name )
$theme_name = wp_get_theme()->get('Name');
$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.
*
* 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 ) {
$mods = get_theme_mods();
if ( isset( $mods[ $name ] ) )
return apply_filters( "theme_mod_$name", $mods[ $name ] );
if ( is_string( $default ) )
$default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
return apply_filters( "theme_mod_$name", $default );
}
/**
* 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 ) {
$mods = get_theme_mods();
$mods[ $name ] = $value;
$theme = get_option( 'stylesheet' );
update_option( "theme_mods_$theme", $mods );
}
/**
* 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 ) {
$mods = get_theme_mods();
if ( ! isset( $mods[ $name ] ) )
return;
unset( $mods[ $name ] );
if ( empty( $mods ) )
return remove_theme_mods();
$theme = get_option( 'stylesheet' );
update_option( "theme_mods_$theme", $mods );
}
/**
* Remove theme modifications option for current theme.
*
* @since 2.1.0
*/
function remove_theme_mods() {
delete_option( 'theme_mods_' . get_option( 'stylesheet' ) );
// Old style.
$theme_name = get_option( 'current_theme' );
if ( false === $theme_name )
$theme_name = wp_get_theme()->get('Name');
delete_option( 'mods_' . $theme_name );
}
/**
* Retrieve text color for custom header.
*
* @since 2.1.0
* @uses HEADER_TEXTCOLOR
*
* @return string
*/
function get_header_textcolor() {
$default = defined('HEADER_TEXTCOLOR') ? HEADER_TEXTCOLOR : '';
return get_theme_mod('header_textcolor', $default);
}
/**
* 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() {
$default = defined( 'HEADER_IMAGE' ) ? HEADER_IMAGE : '';
$url = get_theme_mod( 'header_image', $default );
if ( 'remove-header' == $url )
return false;
if ( is_random_header_image() )
$url = get_random_header_image();
if ( is_ssl() )
$url = str_replace( 'http://', 'https://', $url );
else
$url = str_replace( 'https://', 'http://', $url );
return esc_url_raw( $url );
}
/**
* Get random header image data from registered images in theme.
*
* @since 3.4.0
*
* @access private
*
* @return string Path to header image
*/
function _get_random_header_data() {
static $_wp_random_header;
if ( empty( $_wp_random_header ) ) {
global $_wp_default_headers;
$header_image_mod = get_theme_mod( 'header_image', '' );
$headers = array();
if ( 'random-uploaded-image' == $header_image_mod )
$headers = get_uploaded_header_images();
elseif ( ! empty( $_wp_default_headers ) ) {
if ( 'random-default-image' == $header_image_mod ) {
$headers = $_wp_default_headers;
} else {
$is_random = get_theme_support( 'custom-header' );
if ( isset( $is_random[ 0 ] ) && !empty( $is_random[ 0 ][ 'random-default' ] ) )
$headers = $_wp_default_headers;
}
}
if ( empty( $headers ) )
return new stdClass;
$_wp_random_header = (object) $headers[ array_rand( $headers ) ];
$_wp_random_header->url = sprintf( $_wp_random_header->url, get_template_directory_uri(), get_stylesheet_directory_uri() );
$_wp_random_header->thumbnail_url = sprintf( $_wp_random_header->thumbnail_url, get_template_directory_uri(), get_stylesheet_directory_uri() );
}
return $_wp_random_header;
}
/**
* Get random header image url from registered images in theme.
*
* @since 3.2.0
*
* @return string Path to header image
*/
function get_random_header_image() {
$random_image = _get_random_header_data();
if ( empty( $random_image->url ) )
return '';
return $random_image->url;
}
/**
* Check if random header image is in use.
*
* Always true if user expressly chooses the option in Appearance > Header.
* Also true if theme has multiple header images registered, no specific header image
* is chosen, and theme turns on random headers with add_theme_support().
*
* @since 3.2.0
* @uses HEADER_IMAGE
*
* @param string $type The random pool to use. any|default|uploaded
* @return boolean
*/
function is_random_header_image( $type = 'any' ) {
$default = defined( 'HEADER_IMAGE' ) ? HEADER_IMAGE : '';
$header_image_mod = get_theme_mod( 'header_image', $default );
if ( 'any' == $type ) {
if ( 'random-default-image' == $header_image_mod || 'random-uploaded-image' == $header_image_mod || ( '' != get_random_header_image() && empty( $header_image_mod ) ) )
return true;
} else {
if ( "random-$type-image" == $header_image_mod )
return true;
elseif ( 'default' == $type && empty( $header_image_mod ) && '' != get_random_header_image() )
return true;
}
return false;
}
/**
* Display header image path.
*
* @since 2.1.0
*/
function header_image() {
echo get_header_image();
}
/**
* Get the header images uploaded for the current theme.
*
* @since 3.2.0
*
* @return array
*/
function get_uploaded_header_images() {
$header_images = array();
// @todo caching
$headers = get_posts( array( 'post_type' => 'attachment', 'meta_key' => '_wp_attachment_is_custom_header', 'meta_value' => get_option('stylesheet'), 'orderby' => 'none', 'nopaging' => true ) );
if ( empty( $headers ) )
return array();
foreach ( (array) $headers as $header ) {
$url = esc_url_raw( $header->guid );
$header_data = wp_get_attachment_metadata( $header->ID );
$header_index = basename($url);
$header_images[$header_index] = array();
$header_images[$header_index]['attachment_id'] = $header->ID;
$header_images[$header_index]['url'] = $url;
$header_images[$header_index]['thumbnail_url'] = $url;
$header_images[$header_index]['width'] = $header_data['width'];
$header_images[$header_index]['height'] = $header_data['height'];
}
return $header_images;
}
/**
* Get the header image data.
*
* @since 3.4.0
*
* @return object
*/
function get_current_header_data() {
$data = is_random_header_image()? _get_random_header_data() : get_theme_mod( 'header_image_data' );
$default = array(
'url' => '',
'thumbnail_url' => '',
'width' => '',
'height' => '',
);
return (object) wp_parse_args( $data, $default );
}
/**
* Get the header image width.
*
* @since 3.4.0
*
* @return int
*/
function get_header_image_width() {
return empty( get_current_header_data()->width )? HEADER_IMAGE_WIDTH : get_current_header_data()->width;
}
/**
* Get the header image height.
*
* @since 3.4.0
*
* @return int
*/
function get_header_image_height() {
return empty( get_current_header_data()->height )? HEADER_IMAGE_HEIGHT : get_current_header_data()->height;
}
/**
* 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 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, $admin_image_div_callback = '' ) {
if ( ! empty( $header_callback ) )
add_action('wp_head', $header_callback);
$support = array( 'callback' => $header_callback );
$theme_support = get_theme_support( 'custom-header' );
if ( ! empty( $theme_support ) && is_array( $theme_support[ 0 ] ) )
$support = array_merge( $theme_support[ 0 ], $support );
add_theme_support( 'custom-header', $support );
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-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;
}
?>