2006-04-18 04:44:33 +00:00
<? php
2008-08-12 20:18:05 +00:00
/**
2008-09-01 05:44:16 +00:00
* Theme, template, and stylesheet functions.
*
2008-08-12 20:18:05 +00:00
* @package WordPress
2012-02-28 01:49:49 +00:00
* @subpackage Theme
2008-09-01 05:44:16 +00:00
*/
2012-02-28 21:24:44 +00:00
/**
* Returns an array of WP_Theme objects based on the arguments.
*
2012-03-15 15:39:21 +00:00
* Despite advances over get_themes(), this function is quite expensive, and grows
2012-02-28 21:24:44 +00:00
* linearly with additional themes. Stick to wp_get_theme() if possible.
*
* @since 3.4.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
* @staticvar array $_themes
*
2012-03-15 15:39:21 +00:00
* @param array $args The search arguments. Optional.
* - errors mixed True to return themes with errors, false to return themes without errors, null
* to return all themes. Defaults to false.
* - allowed mixed (Multisite) True to return only allowed themes for a site. False to return only
* disallowed themes for a site. 'site' to return only site-allowed themes. 'network'
* to return only network-allowed themes. Null to return all themes. Defaults to null.
* - blog_id int (Multisite) The blog ID used to calculate which themes are allowed. Defaults to 0,
* synonymous for the current blog.
2015-05-27 22:21:25 +00:00
* @return array Array of WP_Theme objects.
2012-02-28 21:24:44 +00:00
*/
function wp_get_themes ( $args = array () ) {
global $wp_theme_directories ;
$defaults = array ( 'errors' => false , 'allowed' => null , 'blog_id' => 0 );
$args = wp_parse_args ( $args , $defaults );
2012-03-15 15:39:21 +00:00
$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 ();
if ( isset ( $theme_directories [ $current_theme ] ) ) {
2012-03-08 07:46:39 +00:00
$root_of_current_theme = get_raw_theme_root ( $current_theme );
if ( ! in_array ( $root_of_current_theme , $wp_theme_directories ) )
2012-03-08 18:00:11 +00:00
$root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme ;
2012-03-15 15:39:21 +00:00
$theme_directories [ $current_theme ][ 'theme_root' ] = $root_of_current_theme ;
2012-02-28 21:24:44 +00:00
}
}
2012-03-15 15:39:21 +00:00
if ( empty ( $theme_directories ) )
2012-03-08 07:46:39 +00:00
return array ();
2012-02-28 21:24:44 +00:00
if ( is_multisite () && null !== $args [ 'allowed' ] ) {
2012-03-08 07:46:39 +00:00
$allowed = $args [ 'allowed' ];
if ( 'network' === $allowed )
2012-03-21 17:32:28 +00:00
$theme_directories = array_intersect_key ( $theme_directories , WP_Theme :: get_allowed_on_network () );
2012-03-08 07:46:39 +00:00
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 ();
2012-03-21 17:32:28 +00:00
static $_themes = array ();
2012-03-08 07:46:39 +00:00
foreach ( $theme_directories as $theme => $theme_root ) {
2012-04-05 20:38:42 +00:00
if ( isset ( $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ] ) )
$themes [ $theme ] = $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ];
2012-03-08 07:46:39 +00:00
else
2012-04-05 20:38:42 +00:00
$themes [ $theme ] = $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ] = new WP_Theme ( $theme , $theme_root [ 'theme_root' ] );
2012-03-08 07:46:39 +00:00
}
if ( null !== $args [ 'errors' ] ) {
foreach ( $themes as $theme => $wp_theme ) {
if ( $wp_theme -> errors () != $args [ 'errors' ] )
unset ( $themes [ $theme ] );
2012-02-28 21:24:44 +00:00
}
}
return $themes ;
}
/**
* Gets a WP_Theme object for a theme.
*
* @since 3.4.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
*
2012-02-28 21:24:44 +00:00
* @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()
2015-05-27 22:21:25 +00:00
* is used to calculate the theme root for the $stylesheet provided (or current theme).
2012-04-05 01:05:49 +00:00
* @return WP_Theme Theme object. Be sure to check the object's exists() method if you need to confirm the theme's existence.
2012-02-28 21:24:44 +00:00
*/
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 );
2012-03-29 02:59:48 +00:00
if ( false === $theme_root )
2012-06-12 15:57:11 +00:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2012-04-19 03:33:42 +00:00
elseif ( ! in_array ( $theme_root , ( array ) $wp_theme_directories ) )
2012-02-28 21:24:44 +00:00
$theme_root = WP_CONTENT_DIR . $theme_root ;
}
2012-04-05 01:05:49 +00:00
return new WP_Theme ( $stylesheet , $theme_root );
2012-02-28 21:24:44 +00:00
}
2012-06-14 14:24:25 +00:00
/**
* Clears the cache held by get_theme_roots() and WP_Theme.
*
* @since 3.5.0
2013-09-06 01:33:09 +00:00
* @param bool $clear_update_cache Whether to clear the Theme updates cache
2012-06-14 14:24:25 +00:00
*/
2013-09-06 01:33:09 +00:00
function wp_clean_themes_cache ( $clear_update_cache = true ) {
if ( $clear_update_cache )
delete_site_transient ( 'update_themes' );
2012-06-14 14:24:25 +00:00
search_theme_directories ( true );
foreach ( wp_get_themes ( array ( 'errors' => null ) ) as $theme )
$theme -> cache_delete ();
}
2010-05-03 20:56:57 +00:00
/**
* 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 () {
2014-07-09 18:07:16 +00:00
return ( TEMPLATEPATH !== STYLESHEETPATH );
2010-05-03 20:56:57 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve name of the current stylesheet.
2008-09-01 05:44:16 +00:00
*
2008-09-24 05:24:33 +00:00
* The theme name that the administrator has currently set the front end theme
2008-09-01 05:44:16 +00:00
* as.
*
2014-07-23 05:11:16 +00:00
* For all intents and purposes, the template name and the stylesheet name are
2008-09-24 05:24:33 +00:00
* going to be the same for most cases.
*
2008-09-01 05:44:16 +00:00
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string Stylesheet name.
2006-04-18 04:44:33 +00:00
*/
function get_stylesheet () {
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the name of current stylesheet.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $stylesheet Name of the current stylesheet.
*/
return apply_filters ( 'stylesheet' , get_option ( 'stylesheet' ) );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve stylesheet directory path for current theme.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string Path to current theme directory.
2008-09-01 05:44:16 +00:00
*/
2006-04-18 04:44:33 +00:00
function get_stylesheet_directory () {
$stylesheet = get_stylesheet ();
2009-10-13 19:06:35 +00:00
$theme_root = get_theme_root ( $stylesheet );
$stylesheet_dir = " $theme_root / $stylesheet " ;
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the stylesheet directory path for current theme.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
2015-12-06 21:57:24 +00:00
* @param string $stylesheet_dir Absolute path to the current theme.
2013-12-01 17:24:11 +00:00
* @param string $stylesheet Directory name of the current theme.
* @param string $theme_root Absolute path to themes directory.
*/
2009-10-13 19:06:35 +00:00
return apply_filters ( 'stylesheet_directory' , $stylesheet_dir , $stylesheet , $theme_root );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve stylesheet directory URI.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string
2008-09-01 05:44:16 +00:00
*/
2006-04-18 04:44:33 +00:00
function get_stylesheet_directory_uri () {
2014-03-25 13:07:14 +00:00
$stylesheet = str_replace ( '%2F' , '/' , rawurlencode ( get_stylesheet () ) );
2009-10-13 19:06:35 +00:00
$theme_root_uri = get_theme_root_uri ( $stylesheet );
$stylesheet_dir_uri = " $theme_root_uri / $stylesheet " ;
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the stylesheet directory URI.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $stylesheet_dir_uri Stylesheet directory URI.
* @param string $stylesheet Name of the activated theme's directory.
* @param string $theme_root_uri Themes root URI.
*/
2009-10-13 19:06:35 +00:00
return apply_filters ( 'stylesheet_directory_uri' , $stylesheet_dir_uri , $stylesheet , $theme_root_uri );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2016-05-22 17:39:28 +00:00
* Retrieves the URI of current theme stylesheet.
2008-09-01 05:44:16 +00:00
*
2016-05-22 17:39:28 +00:00
* The stylesheet file name is 'style.css' which is appended to the stylesheet directory URI path.
* See get_stylesheet_directory_uri().
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string
2008-09-01 05:44:16 +00:00
*/
2006-04-18 04:44:33 +00:00
function get_stylesheet_uri () {
$stylesheet_dir_uri = get_stylesheet_directory_uri ();
2011-05-22 22:30:05 +00:00
$stylesheet_uri = $stylesheet_dir_uri . '/style.css' ;
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the URI of the current theme stylesheet.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $stylesheet_uri Stylesheet URI for the current theme/child theme.
* @param string $stylesheet_dir_uri Stylesheet directory URI for the current theme/child theme.
*/
return apply_filters ( 'stylesheet_uri' , $stylesheet_uri , $stylesheet_dir_uri );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2016-05-23 19:02:28 +00:00
* Retrieves the localized stylesheet URI.
2008-09-01 05:44:16 +00:00
*
2008-09-25 14:12:58 +00:00
* 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
2016-05-23 19:02:28 +00:00
* the {@see 'stylesheet_directory_uri'} or {@see 'locale_stylesheet_uri'} filters.
*
2008-09-25 14:12:58 +00:00
* 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.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*
2015-05-27 22:21:25 +00:00
* @global WP_Locale $wp_locale
*
2008-09-24 05:24:33 +00:00
* @return string
2008-09-01 05:44:16 +00:00
*/
2006-09-18 23:40:19 +00:00
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" ;
2006-10-13 10:33:44 +00:00
elseif ( ! empty ( $wp_locale -> text_direction ) && file_exists ( " $dir / { $wp_locale -> text_direction } .css" ) )
2006-09-18 23:40:19 +00:00
$stylesheet_uri = " $stylesheet_dir_uri / { $wp_locale -> text_direction } .css" ;
else
$stylesheet_uri = '' ;
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the localized stylesheet URI.
2013-12-01 17:24:11 +00:00
*
* @since 2.1.0
*
* @param string $stylesheet_uri Localized stylesheet URI.
* @param string $stylesheet_dir_uri Stylesheet directory URI.
*/
return apply_filters ( 'locale_stylesheet_uri' , $stylesheet_uri , $stylesheet_dir_uri );
2006-09-18 23:40:19 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve name of the current theme.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string Template name.
2008-09-01 05:44:16 +00:00
*/
2006-04-18 04:44:33 +00:00
function get_template () {
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the name of the current theme.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $template Current theme's directory name.
*/
return apply_filters ( 'template' , get_option ( 'template' ) );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve current theme directory.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string Template directory path.
2008-09-01 05:44:16 +00:00
*/
2006-04-18 04:44:33 +00:00
function get_template_directory () {
$template = get_template ();
2009-10-13 19:06:35 +00:00
$theme_root = get_theme_root ( $template );
$template_dir = " $theme_root / $template " ;
2009-10-15 20:26:21 +00:00
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the current theme directory path.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $template_dir The URI of the current theme directory.
* @param string $template Directory name of the current theme.
* @param string $theme_root Absolute path to the themes directory.
*/
2009-10-13 19:06:35 +00:00
return apply_filters ( 'template_directory' , $template_dir , $template , $theme_root );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve theme directory URI.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2008-09-24 05:24:33 +00:00
* @return string Template directory URI.
2008-09-01 05:44:16 +00:00
*/
2006-04-18 04:44:33 +00:00
function get_template_directory_uri () {
2014-03-25 13:07:14 +00:00
$template = str_replace ( '%2F' , '/' , rawurlencode ( get_template () ) );
2009-10-13 19:06:35 +00:00
$theme_root_uri = get_theme_root_uri ( $template );
$template_dir_uri = " $theme_root_uri / $template " ;
2009-10-15 20:26:21 +00:00
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the current theme directory URI.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $template_dir_uri The URI of the current theme directory.
* @param string $template Directory name of the current theme.
* @param string $theme_root_uri The themes root URI.
*/
2009-10-13 19:06:35 +00:00
return apply_filters ( 'template_directory_uri' , $template_dir_uri , $template , $theme_root_uri );
2006-04-18 04:44:33 +00:00
}
2009-10-13 19:06:35 +00:00
/**
* Retrieve theme roots.
*
* @since 2.9.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
*
2011-09-05 19:08:15 +00:00
* @return array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root.
2009-10-13 19:06:35 +00:00
*/
function get_theme_roots () {
2010-09-21 19:41:35 +00:00
global $wp_theme_directories ;
2010-11-17 16:11:44 +00:00
if ( count ( $wp_theme_directories ) <= 1 )
2012-02-28 16:22:26 +00:00
return '/themes' ;
2010-09-21 19:41:35 +00:00
2009-10-29 21:53:57 +00:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 19:06:35 +00:00
if ( false === $theme_roots ) {
2012-03-15 15:39:21 +00:00
search_theme_directories ( true ); // Regenerate the transient.
2012-02-28 20:08:08 +00:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 19:06:35 +00:00
}
return $theme_roots ;
}
/**
2009-10-15 20:45:32 +00:00
* Register a directory that contains themes.
2009-10-13 19:06:35 +00:00
*
* @since 2.9.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
*
2009-10-15 20:45:32 +00:00
* @param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR
2009-10-13 19:06:35 +00:00
* @return bool
*/
2012-02-28 18:02:21 +00:00
function register_theme_directory ( $directory ) {
2009-10-13 19:06:35 +00:00
global $wp_theme_directories ;
2009-12-08 21:29:12 +00:00
2012-02-28 18:02:21 +00:00
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
2014-07-19 23:07:15 +00:00
if ( ! file_exists ( $directory ) ) {
2012-02-28 18:02:21 +00:00
return false ;
2014-07-19 23:07:15 +00:00
}
}
if ( ! is_array ( $wp_theme_directories ) ) {
$wp_theme_directories = array ();
2012-02-28 18:02:21 +00:00
}
2012-02-28 16:22:26 +00:00
2014-07-19 23:07:15 +00:00
$untrailed = untrailingslashit ( $directory );
if ( ! empty ( $untrailed ) && ! in_array ( $untrailed , $wp_theme_directories ) ) {
$wp_theme_directories [] = $untrailed ;
}
2009-10-15 20:26:21 +00:00
2009-10-13 19:06:35 +00:00
return true ;
}
/**
* Search all registered theme directories for complete and valid themes.
*
* @since 2.9.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
* @staticvar array $found_themes
*
2012-03-15 15:39:21 +00:00
* @param bool $force Optional. Whether to force a new directory scan. Defaults to false.
2015-05-27 22:21:25 +00:00
* @return array|false Valid themes found
2009-10-13 19:06:35 +00:00
*/
2012-03-15 15:39:21 +00:00
function search_theme_directories ( $force = false ) {
2012-02-28 20:05:00 +00:00
global $wp_theme_directories ;
2015-05-29 15:43:29 +00:00
static $found_themes = null ;
2009-10-13 19:06:35 +00:00
if ( empty ( $wp_theme_directories ) )
return false ;
2012-03-15 15:39:21 +00:00
if ( ! $force && isset ( $found_themes ) )
2012-02-28 20:05:00 +00:00
return $found_themes ;
2009-10-13 19:06:35 +00:00
2012-02-28 20:05:00 +00:00
$found_themes = array ();
2009-10-15 20:26:21 +00:00
2012-04-05 20:38:42 +00:00
$wp_theme_directories = ( array ) $wp_theme_directories ;
2014-12-20 22:47:22 +00:00
$relative_theme_roots = array ();
2012-04-05 20:38:42 +00:00
2012-03-06 01:50:54 +00:00
// Set up maybe-relative, maybe-absolute array of theme directories.
// We always want to return absolute, but we need to cache relative
2013-05-01 01:46:45 +00:00
// to use in get_theme_root().
2012-03-06 01:50:54 +00:00
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 ;
}
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters whether to get the cache of the registered theme directories.
2013-12-01 17:24:11 +00:00
*
* @since 3.4.0
*
* @param bool $cache_expiration Whether to get the cache of the theme directories. Default false.
* @param string $cache_directory Directory to be searched for the cache.
*/
2012-02-28 20:05:00 +00:00
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 ) {
2012-04-20 13:22:54 +00:00
// A cached theme root is no longer around, so skip it.
if ( ! isset ( $relative_theme_roots [ $theme_root ] ) )
continue ;
2012-02-28 20:05:00 +00:00
$found_themes [ $theme_dir ] = array (
'theme_file' => $theme_dir . '/style.css' ,
2012-03-06 01:50:54 +00:00
'theme_root' => $relative_theme_roots [ $theme_root ], // Convert relative to absolute.
2012-02-28 20:05:00 +00:00
);
}
return $found_themes ;
}
if ( ! is_int ( $cache_expiration ) )
2012-03-30 14:39:05 +00:00
$cache_expiration = 1800 ; // half hour
2012-02-28 20:05:00 +00:00
} else {
2012-03-30 14:39:05 +00:00
$cache_expiration = 1800 ; // half hour
2012-02-28 20:05:00 +00:00
}
2009-10-13 19:06:35 +00:00
2012-02-28 20:05:00 +00:00
/* Loop the registered theme directories and extract all themes */
foreach ( $wp_theme_directories as $theme_root ) {
2009-10-13 19:06:35 +00:00
2012-02-28 20:05:00 +00:00
// Start with directories in the root of the current theme directory.
$dirs = @ scandir ( $theme_root );
2013-08-05 21:40:28 +00:00
if ( ! $dirs ) {
trigger_error ( " $theme_root is not readable" , E_USER_NOTICE );
continue ;
}
2012-02-28 20:05:00 +00:00
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 );
2013-08-05 21:40:28 +00:00
if ( ! $sub_dirs ) {
trigger_error ( " $theme_root / $dir is not readable" , E_USER_NOTICE );
continue ;
}
2012-02-28 20:05:00 +00:00
foreach ( $sub_dirs as $sub_dir ) {
2012-06-26 03:36:03 +00:00
if ( ! is_dir ( $theme_root . '/' . $dir . '/' . $sub_dir ) || $dir [ 0 ] == '.' || $dir == 'CVS' )
2012-02-28 20:05:00 +00:00
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 ;
2009-10-13 19:06:35 +00:00
}
2012-02-28 20:05:00 +00:00
// 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 ,
);
2009-10-13 19:06:35 +00:00
}
}
}
2012-02-28 20:05:00 +00:00
asort ( $found_themes );
$theme_roots = array ();
2012-03-06 01:50:54 +00:00
$relative_theme_roots = array_flip ( $relative_theme_roots );
2012-02-28 20:05:00 +00:00
foreach ( $found_themes as $theme_dir => $theme_data ) {
2012-03-06 01:50:54 +00:00
$theme_roots [ $theme_dir ] = $relative_theme_roots [ $theme_data [ 'theme_root' ] ]; // Convert absolute to relative.
2012-02-28 20:05:00 +00:00
}
if ( $theme_roots != get_site_transient ( 'theme_roots' ) )
set_site_transient ( 'theme_roots' , $theme_roots , $cache_expiration );
return $found_themes ;
2009-10-13 19:06:35 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve path to themes directory.
2008-09-01 05:44:16 +00:00
*
2008-09-24 05:24:33 +00:00
* Does not have trailing slash.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
*
2010-09-07 11:21:11 +00:00
* @param string $stylesheet_or_template The stylesheet or template name of the theme
2008-09-24 05:24:33 +00:00
* @return string Theme path.
2008-09-01 05:44:16 +00:00
*/
2009-10-13 19:06:35 +00:00
function get_theme_root ( $stylesheet_or_template = false ) {
2012-02-28 18:02:21 +00:00
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.
2012-03-05 17:30:09 +00:00
if ( ! in_array ( $theme_root , ( array ) $wp_theme_directories ) )
2012-02-28 16:22:26 +00:00
$theme_root = WP_CONTENT_DIR . $theme_root ;
} else {
2009-10-13 19:06:35 +00:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2012-02-28 16:22:26 +00:00
}
2009-12-08 21:29:12 +00:00
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the absolute path to the themes directory.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $theme_root Absolute path to themes directory.
*/
2009-10-13 19:06:35 +00:00
return apply_filters ( 'theme_root' , $theme_root );
2006-04-18 04:44:33 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve URI for themes directory.
2008-09-01 05:44:16 +00:00
*
2008-09-24 05:24:33 +00:00
* Does not have trailing slash.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
*
2012-03-08 18:18:10 +00:00
* @param string $stylesheet_or_template Optional. The stylesheet or template name of the theme.
2015-05-27 22:21:25 +00:00
* Default is to leverage the main theme root.
* @param string $theme_root Optional. The theme root for which calculations will be based, preventing
* the need for a get_raw_theme_root() call.
2008-09-24 05:24:33 +00:00
* @return string Themes URI.
2008-09-01 05:44:16 +00:00
*/
2012-03-08 18:18:10 +00:00
function get_theme_root_uri ( $stylesheet_or_template = false , $theme_root = false ) {
2012-02-28 18:02:21 +00:00
global $wp_theme_directories ;
2012-03-08 18:18:10 +00:00
if ( $stylesheet_or_template && ! $theme_root )
$theme_root = get_raw_theme_root ( $stylesheet_or_template );
if ( $stylesheet_or_template && $theme_root ) {
2012-03-05 17:30:09 +00:00
if ( in_array ( $theme_root , ( array ) $wp_theme_directories ) ) {
2012-02-28 18:02:21 +00:00
// 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 {
2012-02-28 16:22:26 +00:00
$theme_root_uri = content_url ( $theme_root );
2012-02-28 18:02:21 +00:00
}
2010-09-21 19:41:35 +00:00
} else {
2009-10-13 19:06:35 +00:00
$theme_root_uri = content_url ( 'themes' );
2010-09-21 19:41:35 +00:00
}
2009-10-13 19:06:35 +00:00
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the URI for themes directory.
2013-12-01 17:24:11 +00:00
*
* @since 1.5.0
*
* @param string $theme_root_uri The URI for themes directory.
* @param string $siteurl WordPress web address which is set in General Options.
* @param string $stylesheet_or_template Stylesheet or template name of the theme.
*/
return apply_filters ( 'theme_root_uri' , $theme_root_uri , get_option ( 'siteurl' ), $stylesheet_or_template );
2006-04-18 04:44:33 +00:00
}
2010-09-21 19:41:35 +00:00
/**
2012-02-28 16:22:26 +00:00
* Get the raw theme root relative to the content directory with no filters applied.
2010-09-21 19:41:35 +00:00
*
* @since 3.1.0
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
*
2010-09-21 19:41:35 +00:00
* @param string $stylesheet_or_template The stylesheet or template name of the theme
2015-05-27 22:21:25 +00:00
* @param bool $skip_cache Optional. Whether to skip the cache.
* Defaults to false, meaning the cache is used.
2010-09-21 19:41:35 +00:00
* @return string Theme root
*/
2012-02-28 19:59:53 +00:00
function get_raw_theme_root ( $stylesheet_or_template , $skip_cache = false ) {
2010-09-21 19:41:35 +00:00
global $wp_theme_directories ;
2010-11-17 16:11:44 +00:00
if ( count ( $wp_theme_directories ) <= 1 )
2012-02-28 16:22:26 +00:00
return '/themes' ;
2010-09-21 19:41:35 +00:00
$theme_root = false ;
// If requesting the root for the current theme, consult options to avoid calling get_theme_roots()
2012-02-28 19:59:53 +00:00
if ( ! $skip_cache ) {
2010-11-17 16:11:44 +00:00
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' );
}
2010-09-21 19:41:35 +00:00
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 ;
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Display localized stylesheet link element.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*/
2006-09-18 23:40:19 +00:00
function locale_stylesheet () {
$stylesheet = get_locale_stylesheet_uri ();
if ( empty ( $stylesheet ) )
return ;
echo '<link rel="stylesheet" href="' . $stylesheet . '" type="text/css" media="screen" />' ;
}
2008-09-25 14:12:58 +00:00
/**
2012-06-26 05:21:04 +00:00
* Switches the theme.
*
* Accepts one argument: $stylesheet of the theme. It also accepts an additional function signature
2016-05-13 18:41:31 +00:00
* of two arguments: $template then $stylesheet. This is for backward compatibility.
2008-09-25 14:12:58 +00:00
*
2010-12-01 19:24:38 +00:00
* @since 2.5.0
2008-09-25 14:12:58 +00:00
*
2015-05-27 22:21:25 +00:00
* @global array $wp_theme_directories
* @global WP_Customize_Manager $wp_customize
* @global array $sidebars_widgets
*
2012-06-26 05:21:04 +00:00
* @param string $stylesheet Stylesheet name
2008-09-25 14:12:58 +00:00
*/
2012-06-26 05:21:04 +00:00
function switch_theme ( $stylesheet ) {
2014-04-14 22:46:16 +00:00
global $wp_theme_directories , $wp_customize , $sidebars_widgets ;
2011-09-08 19:25:20 +00:00
2014-04-14 22:46:16 +00:00
$_sidebars_widgets = null ;
if ( 'wp_ajax_customize_save' === current_action () ) {
$_sidebars_widgets = $wp_customize -> post_value ( $wp_customize -> get_setting ( 'old_sidebars_widgets_data' ) );
} elseif ( is_array ( $sidebars_widgets ) ) {
$_sidebars_widgets = $sidebars_widgets ;
}
if ( is_array ( $_sidebars_widgets ) ) {
set_theme_mod ( 'sidebars_widgets' , array ( 'time' => time (), 'data' => $_sidebars_widgets ) );
}
2010-09-21 19:41:35 +00:00
2015-08-30 03:01:21 +00:00
$nav_menu_locations = get_theme_mod ( 'nav_menu_locations' );
2012-06-26 05:21:04 +00:00
if ( func_num_args () > 1 ) {
$stylesheet = func_get_arg ( 1 );
}
2011-09-02 22:13:55 +00:00
2015-08-30 21:45:23 +00:00
$old_theme = wp_get_theme ();
$new_theme = wp_get_theme ( $stylesheet );
$template = $new_theme -> get_template ();
2012-02-29 05:09:29 +00:00
update_option ( 'template' , $template );
update_option ( 'stylesheet' , $stylesheet );
2011-09-02 22:13:55 +00:00
2012-02-29 05:09:29 +00:00
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 ) );
2012-11-11 21:51:27 +00:00
} else {
delete_option ( 'template_root' );
delete_option ( 'stylesheet_root' );
2010-09-21 19:41:35 +00:00
}
2011-09-02 22:13:55 +00:00
2012-06-26 05:21:04 +00:00
$new_name = $new_theme -> get ( 'Name' );
2012-02-29 05:09:29 +00:00
update_option ( 'current_theme' , $new_name );
2011-09-02 22:13:55 +00:00
2014-04-14 22:46:16 +00:00
// Migrate from the old mods_{name} option to theme_mods_{slug}.
2012-02-29 05:09:29 +00:00
if ( is_admin () && false === get_option ( 'theme_mods_' . $stylesheet ) ) {
$default_theme_mods = ( array ) get_option ( 'mods_' . $new_name );
2015-08-30 03:01:21 +00:00
if ( ! empty ( $nav_menu_locations ) && empty ( $default_theme_mods [ 'nav_menu_locations' ] ) ) {
$default_theme_mods [ 'nav_menu_locations' ] = $nav_menu_locations ;
}
2010-12-15 17:39:00 +00:00
add_option ( "theme_mods_ $stylesheet " , $default_theme_mods );
2014-04-14 22:46:16 +00:00
} else {
/*
2014-10-15 17:21:19 +00:00
* Since retrieve_widgets() is called when initializing a theme in the Customizer,
2015-12-06 21:50:25 +00:00
* we need to remove the theme mods to avoid overwriting changes made via
2014-10-15 17:21:19 +00:00
* the Customizer when accessing wp-admin/widgets.php.
2014-04-14 22:46:16 +00:00
*/
if ( 'wp_ajax_customize_save' === current_action () ) {
remove_theme_mod ( 'sidebars_widgets' );
}
2015-08-30 03:01:21 +00:00
if ( ! empty ( $nav_menu_locations ) ) {
$nav_mods = get_theme_mod ( 'nav_menu_locations' );
if ( empty ( $nav_mods ) ) {
set_theme_mod ( 'nav_menu_locations' , $nav_menu_locations );
}
}
2010-12-15 17:39:00 +00:00
}
2011-09-02 22:13:55 +00:00
2012-03-08 21:22:24 +00:00
update_option ( 'theme_switched' , $old_theme -> get_stylesheet () );
2016-02-07 08:26:25 +00:00
2013-12-01 17:24:11 +00:00
/**
* Fires after the theme is switched.
*
* @since 1.5.0
2016-02-07 08:26:25 +00:00
* @since 4.5.0 Introduced the `$old_theme` parameter.
2013-12-01 17:24:11 +00:00
*
* @param string $new_name Name of the new theme.
* @param WP_Theme $new_theme WP_Theme instance of the new theme.
2016-02-07 08:26:25 +00:00
* @param WP_Theme $old_theme WP_Theme instance of the old theme.
2013-12-01 17:24:11 +00:00
*/
2016-02-07 08:26:25 +00:00
do_action ( 'switch_theme' , $new_name , $new_theme , $old_theme );
2007-11-13 05:07:44 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Checks that current theme files 'index.php' and 'style.css' exists.
2008-09-01 05:44:16 +00:00
*
2015-11-25 21:45:25 +00:00
* Does not initially check the default theme, which is the fallback and should always exist.
* But if it doesn't exist, it'll fall back to the latest core default theme that does exist.
2010-04-21 17:14:25 +00:00
* Will switch theme to the fallback theme if current theme does not validate.
2015-11-25 21:45:25 +00:00
*
2016-05-23 19:02:28 +00:00
* You can use the {@see 'validate_current_theme'} filter to return false to
2008-10-06 15:29:47 +00:00
* disable this functionality.
2008-09-01 05:44:16 +00:00
*
* @since 1.5.0
2010-05-06 19:53:40 +00:00
* @see WP_DEFAULT_THEME
2008-09-01 05:44:16 +00:00
*
2008-09-24 05:24:33 +00:00
* @return bool
2008-09-01 05:44:16 +00:00
*/
2006-07-11 22:44:56 +00:00
function validate_current_theme () {
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters whether to validate the current theme.
2013-12-01 17:24:11 +00:00
*
* @since 2.7.0
*
2015-12-16 20:10:25 +00:00
* @param bool $validate Whether to validate the current theme. Default true.
2013-12-01 17:24:11 +00:00
*/
2015-10-05 15:06:28 +00:00
if ( wp_installing () || ! apply_filters ( 'validate_current_theme' , true ) )
2006-07-21 19:00:04 +00:00
return true ;
2015-11-25 21:45:25 +00:00
if ( ! file_exists ( get_template_directory () . '/index.php' ) ) {
// Invalid.
} elseif ( ! file_exists ( get_template_directory () . '/style.css' ) ) {
// Invalid.
} elseif ( is_child_theme () && ! file_exists ( get_stylesheet_directory () . '/style.css' ) ) {
// Invalid.
} else {
// Valid.
return true ;
2006-07-11 22:44:56 +00:00
}
2015-11-25 21:45:25 +00:00
$default = wp_get_theme ( WP_DEFAULT_THEME );
if ( $default -> exists () ) {
2012-06-26 05:21:04 +00:00
switch_theme ( WP_DEFAULT_THEME );
2006-07-11 22:44:56 +00:00
return false ;
}
2010-12-14 19:19:47 +00:00
2015-11-25 21:45:25 +00:00
/**
* If we're in an invalid state but WP_DEFAULT_THEME doesn't exist,
* switch to the latest core default theme that's installed.
* If it turns out that this latest core default theme is our current
* theme, then there's nothing we can do about that, so we have to bail,
* rather than going into an infinite loop. (This is why there are
* checks against WP_DEFAULT_THEME above, also.) We also can't do anything
* if it turns out there is no default theme installed. (That's `false`.)
*/
$default = WP_Theme :: get_core_default_theme ();
if ( false === $default || get_stylesheet () == $default -> get_stylesheet () ) {
return true ;
2010-12-14 19:17:49 +00:00
}
2006-07-11 22:44:56 +00:00
2015-11-25 21:45:25 +00:00
switch_theme ( $default -> get_stylesheet () );
return false ;
2006-07-11 22:44:56 +00:00
}
2010-10-06 21:00:17 +00:00
/**
* Retrieve all theme modifications.
*
* @since 3.1.0
*
2015-05-27 22:21:25 +00:00
* @return array|void Theme modifications.
2010-10-06 21:00:17 +00:00
*/
function get_theme_mods () {
$theme_slug = get_option ( 'stylesheet' );
2015-05-28 05:51:25 +00:00
$mods = get_option ( "theme_mods_ $theme_slug " );
if ( false === $mods ) {
2012-02-29 20:07:22 +00:00
$theme_name = get_option ( 'current_theme' );
if ( false === $theme_name )
$theme_name = wp_get_theme () -> get ( 'Name' );
2010-10-07 05:59:50 +00:00
$mods = get_option ( "mods_ $theme_name " ); // Deprecated location.
2010-10-06 21:00:17 +00:00
if ( is_admin () && false !== $mods ) {
update_option ( "theme_mods_ $theme_slug " , $mods );
delete_option ( "mods_ $theme_name " );
}
}
2015-05-28 05:51:25 +00:00
return $mods ;
2010-10-06 21:00:17 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve theme modification value for the current theme.
2008-09-01 05:44:16 +00:00
*
2008-09-24 05:24:33 +00:00
* If the modification name does not exist, then the $default will be passed
2016-06-10 04:50:33 +00:00
* through {@link https://secure.php.net/sprintf sprintf()} PHP function with the first
2008-09-24 05:24:33 +00:00
* string the template directory URI and the second string the stylesheet
* directory URI.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*
2015-05-27 22:21:25 +00:00
* @param string $name Theme modification name.
2008-09-24 05:24:33 +00:00
* @param bool|string $default
* @return string
2008-09-01 05:44:16 +00:00
*/
2010-10-07 05:59:50 +00:00
function get_theme_mod ( $name , $default = false ) {
2010-10-06 21:00:17 +00:00
$mods = get_theme_mods ();
2006-10-16 06:06:18 +00:00
2013-12-01 17:24:11 +00:00
if ( isset ( $mods [ $name ] ) ) {
/**
2016-05-22 18:18:29 +00:00
* Filters the theme modification, or 'theme_mod', value.
2013-12-01 17:24:11 +00:00
*
2014-11-30 12:10:23 +00:00
* The dynamic portion of the hook name, `$name`, refers to
2013-12-01 17:24:11 +00:00
* the key name of the modification array. For example,
* 'header_textcolor', 'header_image', and so on depending
* on the theme options.
*
* @since 2.2.0
*
* @param string $current_mod The value of the current theme modification.
*/
return apply_filters ( "theme_mod_ { $name } " , $mods [ $name ] );
}
2006-10-16 06:06:18 +00:00
2012-02-02 23:35:37 +00:00
if ( is_string ( $default ) )
$default = sprintf ( $default , get_template_directory_uri (), get_stylesheet_directory_uri () );
2013-12-01 17:24:11 +00:00
/** This filter is documented in wp-includes/theme.php */
return apply_filters ( "theme_mod_ { $name } " , $default );
2006-10-16 06:06:18 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Update theme modification value for the current theme.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*
2015-05-27 22:21:25 +00:00
* @param string $name Theme modification name.
* @param mixed $value Theme modification value.
2008-09-01 05:44:16 +00:00
*/
2010-10-07 05:59:50 +00:00
function set_theme_mod ( $name , $value ) {
2010-10-06 21:00:17 +00:00
$mods = get_theme_mods ();
2014-03-05 01:13:14 +00:00
$old_value = isset ( $mods [ $name ] ) ? $mods [ $name ] : false ;
2006-10-16 06:06:18 +00:00
2014-03-04 07:02:13 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the theme mod value on save.
2014-03-04 07:02:13 +00:00
*
2014-11-30 12:10:23 +00:00
* The dynamic portion of the hook name, `$name`, refers to the key name of
2014-03-04 07:02:13 +00:00
* the modification array. For example, 'header_textcolor', 'header_image',
* and so on depending on the theme options.
*
* @since 3.9.0
*
* @param string $value The new value of the theme mod.
* @param string $old_value The current value of the theme mod.
*/
2016-08-22 18:25:31 +00:00
$mods [ $name ] = apply_filters ( "pre_set_theme_mod_ { $name } " , $value , $old_value );
2006-10-16 06:06:18 +00:00
2010-10-06 21:00:17 +00:00
$theme = get_option ( 'stylesheet' );
update_option ( "theme_mods_ $theme " , $mods );
2006-10-16 06:06:18 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Remove theme modification name from current theme list.
2008-09-01 05:44:16 +00:00
*
2008-09-24 05:24:33 +00:00
* If removing the name also removes all elements, then the entire option will
* be removed.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*
2008-09-24 05:24:33 +00:00
* @param string $name Theme modification name.
2008-09-01 05:44:16 +00:00
*/
2007-01-03 23:49:34 +00:00
function remove_theme_mod ( $name ) {
2010-10-06 21:00:17 +00:00
$mods = get_theme_mods ();
2007-01-03 23:49:34 +00:00
2010-10-07 05:59:50 +00:00
if ( ! isset ( $mods [ $name ] ) )
2007-01-03 23:49:34 +00:00
return ;
2010-10-07 05:59:50 +00:00
unset ( $mods [ $name ] );
2007-01-03 23:49:34 +00:00
2015-05-27 22:21:25 +00:00
if ( empty ( $mods ) ) {
remove_theme_mods ();
return ;
}
2010-10-06 21:00:17 +00:00
$theme = get_option ( 'stylesheet' );
update_option ( "theme_mods_ $theme " , $mods );
2007-01-03 23:49:34 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Remove theme modifications option for current theme.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*/
2006-10-16 06:06:18 +00:00
function remove_theme_mods () {
2010-10-06 21:00:17 +00:00
delete_option ( 'theme_mods_' . get_option ( 'stylesheet' ) );
2012-02-29 20:07:22 +00:00
// Old style.
$theme_name = get_option ( 'current_theme' );
if ( false === $theme_name )
$theme_name = wp_get_theme () -> get ( 'Name' );
delete_option ( 'mods_' . $theme_name );
2006-10-16 06:06:18 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2016-03-25 23:06:27 +00:00
* Retrieves the custom header text color in HEX format.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*
2016-03-25 23:06:27 +00:00
* @return string Header text color in HEX format (minus the hash symbol).
2008-09-01 05:44:16 +00:00
*/
2007-01-03 23:49:34 +00:00
function get_header_textcolor () {
2012-03-19 17:12:44 +00:00
return get_theme_mod ( 'header_textcolor' , get_theme_support ( 'custom-header' , 'default-text-color' ) );
2007-01-03 23:49:34 +00:00
}
2008-09-01 05:44:16 +00:00
/**
2016-03-25 23:06:27 +00:00
* Displays the custom header text color in HEX format (minus the hash symbol).
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*/
2007-01-03 23:49:34 +00:00
function header_textcolor () {
2007-02-27 15:24:54 +00:00
echo get_header_textcolor ();
2007-01-03 23:49:34 +00:00
}
2012-03-21 18:48:57 +00:00
/**
* Whether to display the header text.
*
* @since 3.4.0
*
* @return bool
*/
function display_header_text () {
if ( ! current_theme_supports ( 'custom-header' , 'header-text' ) )
return false ;
$text_color = get_theme_mod ( 'header_textcolor' , get_theme_support ( 'custom-header' , 'default-text-color' ) );
2015-05-27 22:21:25 +00:00
return 'blank' !== $text_color ;
2012-03-21 18:48:57 +00:00
}
2015-01-17 06:34:23 +00:00
/**
* Check whether a header image is set or not.
*
* @since 4.2.0
*
2015-04-05 17:11:28 +00:00
* @see get_header_image()
*
* @return bool Whether a header image is set or not.
2015-01-17 06:34:23 +00:00
*/
function has_header_image () {
return ( bool ) get_header_image ();
}
2008-09-01 05:44:16 +00:00
/**
2008-09-24 05:24:33 +00:00
* Retrieve header image for custom header.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*
2015-03-09 02:11:28 +00:00
* @return string|false
2008-09-01 05:44:16 +00:00
*/
2007-01-03 23:49:34 +00:00
function get_header_image () {
2012-03-19 17:12:44 +00:00
$url = get_theme_mod ( 'header_image' , get_theme_support ( 'custom-header' , 'default-image' ) );
2010-12-09 17:59:35 +00:00
2011-04-29 19:45:30 +00:00
if ( 'remove-header' == $url )
return false ;
2011-04-28 23:02:16 +00:00
if ( is_random_header_image () )
$url = get_random_header_image ();
2012-08-30 13:33:00 +00:00
return esc_url_raw ( set_url_scheme ( $url ) );
2007-01-03 23:49:34 +00:00
}
2015-11-10 01:17:26 +00:00
/**
2015-11-10 01:59:25 +00:00
* Create image tag markup for a custom header image.
2015-11-10 01:17:26 +00:00
*
* @since 4.4.0
*
2015-11-10 01:59:25 +00:00
* @param array $attr Optional. Additional attributes for the image tag. Can be used
* to override the default attributes. Default empty.
* @return string HTML image element markup or empty string on failure.
2015-11-10 01:17:26 +00:00
*/
function get_header_image_tag ( $attr = array () ) {
$header = get_custom_header ();
2016-11-04 17:09:02 +00:00
$header -> url = get_header_image ();
2015-11-10 01:17:26 +00:00
2016-11-04 17:09:02 +00:00
if ( ! $header -> url ) {
2015-11-10 01:17:26 +00:00
return '' ;
}
$width = absint ( $header -> width );
$height = absint ( $header -> height );
$attr = wp_parse_args (
$attr ,
array (
'src' => $header -> url ,
'width' => $width ,
'height' => $height ,
'alt' => get_bloginfo ( 'name' ),
)
);
// Generate 'srcset' and 'sizes' if not already present.
if ( empty ( $attr [ 'srcset' ] ) && ! empty ( $header -> attachment_id ) ) {
$image_meta = get_post_meta ( $header -> attachment_id , '_wp_attachment_metadata' , true );
$size_array = array ( $width , $height );
if ( is_array ( $image_meta ) ) {
2015-11-10 01:59:25 +00:00
$srcset = wp_calculate_image_srcset ( $size_array , $header -> url , $image_meta , $header -> attachment_id );
$sizes = ! empty ( $attr [ 'sizes' ] ) ? $attr [ 'sizes' ] : wp_calculate_image_sizes ( $size_array , $header -> url , $image_meta , $header -> attachment_id );
2015-11-10 01:17:26 +00:00
2015-11-10 01:59:25 +00:00
if ( $srcset && $sizes ) {
2015-11-10 01:17:26 +00:00
$attr [ 'srcset' ] = $srcset ;
2015-11-10 01:59:25 +00:00
$attr [ 'sizes' ] = $sizes ;
2015-11-10 01:17:26 +00:00
}
}
}
$attr = array_map ( 'esc_attr' , $attr );
$html = '<img' ;
foreach ( $attr as $name => $value ) {
$html .= ' ' . $name . '="' . $value . '"' ;
}
$html .= ' />' ;
/**
2016-05-22 18:18:29 +00:00
* Filters the markup of header images.
2015-11-10 01:17:26 +00:00
*
* @since 4.4.0
*
2015-11-10 01:59:25 +00:00
* @param string $html The HTML image tag markup being filtered.
* @param object $header The custom header object returned by 'get_custom_header()'.
* @param array $attr Array of the attributes for the image tag.
2015-11-10 01:17:26 +00:00
*/
return apply_filters ( 'get_header_image_tag' , $html , $header , $attr );
}
/**
* Display the image markup for a custom header image.
*
* @since 4.4.0
*
* @param array $attr Optional. Attributes for the image markup. Default empty.
*/
function the_header_image_tag ( $attr = array () ) {
echo get_header_image_tag ( $attr );
}
2011-04-28 23:02:16 +00:00
/**
2012-02-02 23:35:37 +00:00
* Get random header image data from registered images in theme.
2011-04-28 23:02:16 +00:00
*
2012-02-02 23:35:37 +00:00
* @since 3.4.0
*
* @access private
2011-04-28 23:02:16 +00:00
*
2015-05-27 22:21:25 +00:00
* @global array $_wp_default_headers
* @staticvar object $_wp_random_header
*
* @return object
2011-04-28 23:02:16 +00:00
*/
2012-02-02 23:35:37 +00:00
function _get_random_header_data () {
2015-05-29 15:43:29 +00:00
static $_wp_random_header = null ;
2011-04-28 23:02:16 +00:00
2012-02-02 23:35:37 +00:00
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 ) {
2011-06-22 19:09:23 +00:00
$headers = $_wp_default_headers ;
2012-02-02 23:35:37 +00:00
} else {
2012-03-19 17:12:44 +00:00
if ( current_theme_supports ( 'custom-header' , 'random-default' ) )
2012-02-02 23:35:37 +00:00
$headers = $_wp_default_headers ;
}
2011-06-22 19:09:23 +00:00
}
2011-04-28 23:02:16 +00:00
2012-02-02 23:35:37 +00:00
if ( empty ( $headers ) )
2012-02-03 13:38:03 +00:00
return new stdClass ;
2012-02-02 23:35:37 +00:00
$_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 ;
}
2011-04-28 23:02:16 +00:00
2012-02-02 23:35:37 +00:00
/**
* 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 ;
2011-04-28 23:02:16 +00:00
}
/**
* Check if random header image is in use.
*
* Always true if user expressly chooses the option in Appearance > Header.
2011-06-22 19:09:23 +00:00
* 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().
2011-04-28 23:02:16 +00:00
*
2011-06-11 04:40:18 +00:00
* @since 3.2.0
2011-04-28 23:02:16 +00:00
*
* @param string $type The random pool to use. any|default|uploaded
2015-06-27 01:03:25 +00:00
* @return bool
2011-04-28 23:02:16 +00:00
*/
function is_random_header_image ( $type = 'any' ) {
2012-03-19 17:12:44 +00:00
$header_image_mod = get_theme_mod ( 'header_image' , get_theme_support ( 'custom-header' , 'default-image' ) );
2011-04-28 23:02:16 +00:00
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 ;
2011-06-22 19:09:23 +00:00
elseif ( 'default' == $type && empty ( $header_image_mod ) && '' != get_random_header_image () )
2011-04-29 19:45:30 +00:00
return true ;
2011-04-28 23:02:16 +00:00
}
return false ;
}
2008-09-01 05:44:16 +00:00
/**
2013-03-07 05:30:00 +00:00
* Display header image URL.
2008-09-01 05:44:16 +00:00
*
* @since 2.1.0
*/
2007-01-03 23:49:34 +00:00
function header_image () {
2015-03-09 02:11:28 +00:00
$image = get_header_image ();
if ( $image ) {
echo esc_url ( $image );
}
2007-01-03 23:49:34 +00:00
}
2011-04-28 23:02:16 +00:00
/**
* 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 ) {
2014-03-06 15:55:15 +00:00
$url = esc_url_raw ( wp_get_attachment_url ( $header -> ID ) );
2012-02-02 23:35:37 +00:00
$header_data = wp_get_attachment_metadata ( $header -> ID );
2016-02-16 22:12:27 +00:00
$header_index = $header -> ID ;
2015-06-29 21:32:26 +00:00
2012-02-02 23:35:37 +00:00
$header_images [ $header_index ] = array ();
2015-06-29 21:32:26 +00:00
$header_images [ $header_index ][ 'attachment_id' ] = $header -> ID ;
2012-02-02 23:35:37 +00:00
$header_images [ $header_index ][ 'url' ] = $url ;
2015-06-29 21:32:26 +00:00
$header_images [ $header_index ][ 'thumbnail_url' ] = $url ;
$header_images [ $header_index ][ 'alt_text' ] = get_post_meta ( $header -> ID , '_wp_attachment_image_alt' , true );
2013-03-29 20:51:35 +00:00
if ( isset ( $header_data [ 'width' ] ) )
$header_images [ $header_index ][ 'width' ] = $header_data [ 'width' ];
if ( isset ( $header_data [ 'height' ] ) )
$header_images [ $header_index ][ 'height' ] = $header_data [ 'height' ];
2011-04-28 23:02:16 +00:00
}
return $header_images ;
}
2012-02-02 23:35:37 +00:00
/**
* Get the header image data.
*
* @since 3.4.0
*
2015-05-27 22:21:25 +00:00
* @global array $_wp_default_headers
*
2012-02-02 23:35:37 +00:00
* @return object
*/
2012-03-19 17:12:44 +00:00
function get_custom_header () {
2012-11-07 20:12:47 +00:00
global $_wp_default_headers ;
if ( is_random_header_image () ) {
$data = _get_random_header_data ();
} else {
$data = get_theme_mod ( 'header_image_data' );
2012-11-19 06:59:25 +00:00
if ( ! $data && current_theme_supports ( 'custom-header' , 'default-image' ) ) {
2012-11-07 20:12:47 +00:00
$directory_args = array ( get_template_directory_uri (), get_stylesheet_directory_uri () );
2012-11-19 06:59:25 +00:00
$data = array ();
$data [ 'url' ] = $data [ 'thumbnail_url' ] = vsprintf ( get_theme_support ( 'custom-header' , 'default-image' ), $directory_args );
if ( ! empty ( $_wp_default_headers ) ) {
foreach ( ( array ) $_wp_default_headers as $default_header ) {
$url = vsprintf ( $default_header [ 'url' ], $directory_args );
if ( $data [ 'url' ] == $url ) {
$data = $default_header ;
$data [ 'url' ] = $url ;
$data [ 'thumbnail_url' ] = vsprintf ( $data [ 'thumbnail_url' ], $directory_args );
break ;
}
2012-11-07 20:12:47 +00:00
}
}
}
}
2012-02-02 23:35:37 +00:00
$default = array (
'url' => '' ,
'thumbnail_url' => '' ,
2012-03-19 18:00:27 +00:00
'width' => get_theme_support ( 'custom-header' , 'width' ),
'height' => get_theme_support ( 'custom-header' , 'height' ),
2016-10-27 21:51:31 +00:00
'video' => get_theme_support ( 'custom-header' , 'video' ),
2012-02-02 23:35:37 +00:00
);
return ( object ) wp_parse_args ( $data , $default );
}
2010-02-25 19:18:44 +00:00
/**
* Register a selection of default headers to be displayed by the custom header admin UI.
*
* @since 3.0.0
*
2015-05-27 22:21:25 +00:00
* @global array $_wp_default_headers
*
2010-04-02 03:15:18 +00:00
* @param array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys.
2010-02-25 19:18:44 +00:00
*/
function register_default_headers ( $headers ) {
global $_wp_default_headers ;
2010-04-02 03:15:18 +00:00
$_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
*
2015-05-27 22:21:25 +00:00
* @global array $_wp_default_headers
*
2010-09-07 11:21:11 +00:00
* @param string|array $header The header string id (key of array) to remove, or an array thereof.
2014-03-18 00:12:15 +00:00
* @return bool|void A single header returns true on success, false on failure.
* There is currently no return value for multiple headers.
2010-04-02 03:15:18 +00:00
*/
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 ;
}
2010-02-25 19:18:44 +00:00
}
2016-10-27 21:51:31 +00:00
/**
* Check whether a header video is set or not.
*
* @since 4.7.0
*
* @see get_header_video_url()
*
* @return bool Whether a header video is set or not.
*/
function has_header_video () {
return ( bool ) get_header_video_url ();
}
/* Retrieve header video URL for custom header.
*
* Uses a local video if present, or falls back to an external video. Returns false if there is no video.
*
* @since 4.7.0
*
* @return string|false
*/
function get_header_video_url () {
$id = absint ( get_theme_mod ( 'header_video' ) );
$url = esc_url ( get_theme_mod ( 'external_header_video' ) );
if ( ! $id && ! $url ) {
return false ;
}
if ( $id ) {
// Get the file URL from the attachment ID.
$url = wp_get_attachment_url ( $id );
}
return esc_url_raw ( set_url_scheme ( $url ) );
}
/**
* Display header video URL.
*
* @since 4.7.0
*/
function the_header_video_url () {
$video = get_header_video_url ();
if ( $video ) {
echo esc_url ( $video );
}
}
/**
* Retrieve header video settings.
*
* @since 4.7.0
*
* @return array
*/
function get_header_video_settings () {
$header = get_custom_header ();
$video_url = get_header_video_url ();
$video_type = wp_check_filetype ( $video_url , wp_get_mime_types () );
$settings = array (
'mimeType' => '' ,
'posterUrl' => get_header_image (),
'videoUrl' => $video_url ,
'width' => absint ( $header -> width ),
'height' => absint ( $header -> height ),
'minWidth' => 900 ,
'minHeight' => 500 ,
2016-11-16 23:26:31 +00:00
'l10n' => array (
'pause' => __ ( 'Pause' ),
'play' => __ ( 'Play' ),
'pauseSpeak' => __ ( 'Video is paused.' ),
'playSpeak' => __ ( 'Video is playing.' ),
),
2016-10-27 21:51:31 +00:00
);
if ( preg_match ( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#' , $video_url ) ) {
$settings [ 'mimeType' ] = 'video/x-youtube' ;
} elseif ( ! empty ( $video_type [ 'type' ] ) ) {
$settings [ 'mimeType' ] = $video_type [ 'type' ];
}
return apply_filters ( 'header_video_settings' , $settings );
}
/**
* Check whether a custom header is set or not.
*
* @since 4.7.0
*
* @return bool True if a custom header is set. False if not.
*/
function has_custom_header () {
2016-11-15 07:16:33 +00:00
if ( has_header_image () || ( has_header_video () && is_header_video_active () ) ) {
2016-10-27 21:51:31 +00:00
return true ;
}
return false ;
}
2016-11-15 07:16:33 +00:00
/**
* Checks whether the custom header video is eligible to show on the current page.
*
* @since 4.7.0
*
* @return bool True if the custom header video should be shown. False if not.
*/
function is_header_video_active () {
if ( ! get_theme_support ( 'custom-header' , 'video' ) ) {
return false ;
}
$video_active_cb = get_theme_support ( 'custom-header' , 'video-active-callback' );
if ( empty ( $video_active_cb ) || ! is_callable ( $video_active_cb ) ) {
$show_video = true ;
} else {
$show_video = call_user_func ( $video_active_cb );
}
/**
* Modify whether the custom header video is eligible to show on the current page.
*
* @since 4.7.0
*
* @param bool $show_video Whether the custom header video should be shown. Returns the value
* of the theme setting for the `custom-header`'s `video-active-callback`.
* If no callback is set, the default value is that of `is_front_page()`.
*/
return apply_filters ( 'is_header_video_active' , $show_video );
}
2016-10-27 21:51:31 +00:00
/**
* Retrieve the markup for a custom header.
*
2016-11-14 18:41:32 +00:00
* The container div will always be returned in the Customizer preview.
*
2016-10-27 21:51:31 +00:00
* @since 4.7.0
*
2016-11-14 18:41:32 +00:00
* @return string The markup for a custom header on success.
2016-10-27 21:51:31 +00:00
*/
function get_custom_header_markup () {
2016-11-14 18:41:32 +00:00
if ( ! has_custom_header () && ! is_customize_preview () ) {
return '' ;
2016-10-27 21:51:31 +00:00
}
return sprintf (
'<div id="wp-custom-header" class="wp-custom-header">%s</div>' ,
get_header_image_tag ()
);
}
/**
* Print the markup for a custom header.
*
2016-11-14 18:41:32 +00:00
* A container div will always be printed in the Customizer preview.
*
2016-10-27 21:51:31 +00:00
* @since 4.7.0
*/
function the_custom_header_markup () {
2016-11-14 18:41:32 +00:00
$custom_header = get_custom_header_markup ();
if ( empty ( $custom_header ) ) {
2016-10-27 21:51:31 +00:00
return ;
}
2016-11-14 18:41:32 +00:00
2016-10-27 21:51:31 +00:00
echo $custom_header ;
2016-11-15 07:16:33 +00:00
if ( is_header_video_active () && ( has_header_video () || is_customize_preview () ) ) {
2016-10-27 21:51:31 +00:00
wp_enqueue_script ( 'wp-custom-header' );
wp_localize_script ( 'wp-custom-header' , '_wpCustomHeaderSettings' , get_header_video_settings () );
}
}
2010-02-09 20:37:12 +00:00
/**
* Retrieve background image for custom background.
*
* @since 3.0.0
*
* @return string
*/
function get_background_image () {
2012-03-19 17:12:44 +00:00
return get_theme_mod ( 'background_image' , get_theme_support ( 'custom-background' , 'default-image' ) );
2010-02-09 20:37:12 +00:00
}
/**
* Display background image path.
*
* @since 3.0.0
*/
function background_image () {
echo get_background_image ();
}
2010-03-03 17:10:43 +00:00
/**
* Retrieve value for custom background color.
*
* @since 3.0.0
*
* @return string
*/
function get_background_color () {
2012-03-19 17:12:44 +00:00
return get_theme_mod ( 'background_color' , get_theme_support ( 'custom-background' , 'default-color' ) );
2010-03-03 17:10:43 +00:00
}
/**
* Display background color value.
*
* @since 3.0.0
*/
function background_color () {
echo get_background_color ();
}
2010-02-09 20:37:12 +00:00
/**
* Default custom background callback.
*
* @since 3.0.0
* @access protected
*/
function _custom_background_cb () {
2012-06-05 18:44:31 +00:00
// $background is the saved custom image, or the default image.
2012-08-27 20:25:53 +00:00
$background = set_url_scheme ( get_background_image () );
2012-06-05 18:44:31 +00:00
// $color is the saved custom color.
// A default has to be specified in style.css. It will not be printed here.
2014-03-25 11:53:14 +00:00
$color = get_background_color ();
if ( $color === get_theme_support ( 'custom-background' , 'default-color' ) ) {
$color = false ;
}
2012-06-01 20:31:50 +00:00
2016-11-13 02:43:29 +00:00
if ( ! $background && ! $color ) {
if ( is_customize_preview () ) {
echo '<style type="text/css" id="custom-background-css"></style>' ;
}
2010-02-09 20:37:12 +00:00
return ;
2016-11-13 02:43:29 +00:00
}
2010-02-09 20:37:12 +00:00
2010-06-10 18:28:25 +00:00
$style = $color ? "background-color: # $color ;" : '' ;
if ( $background ) {
2016-10-26 06:52:29 +00:00
$image = " background-image: url(" . wp_json_encode ( $background ) . ");" ;
2010-06-10 18:28:25 +00:00
2016-10-26 06:52:29 +00:00
// Background Position.
$position_x = get_theme_mod ( 'background_position_x' , get_theme_support ( 'custom-background' , 'default-position-x' ) );
$position_y = get_theme_mod ( 'background_position_y' , get_theme_support ( 'custom-background' , 'default-position-y' ) );
if ( ! in_array ( $position_x , array ( 'left' , 'center' , 'right' ), true ) ) {
$position_x = 'left' ;
}
if ( ! in_array ( $position_y , array ( 'top' , 'center' , 'bottom' ), true ) ) {
$position_y = 'top' ;
}
$position = " background-position: $position_x $position_y ;" ;
// Background Size.
$size = get_theme_mod ( 'background_size' , get_theme_support ( 'custom-background' , 'default-size' ) );
if ( ! in_array ( $size , array ( 'auto' , 'contain' , 'cover' ), true ) ) {
$size = 'auto' ;
}
$size = " background-size: $size ;" ;
// Background Repeat.
2013-12-03 21:36:10 +00:00
$repeat = get_theme_mod ( 'background_repeat' , get_theme_support ( 'custom-background' , 'default-repeat' ) );
2016-10-26 06:52:29 +00:00
if ( ! in_array ( $repeat , array ( 'repeat-x' , 'repeat-y' , 'repeat' , 'no-repeat' ), true ) ) {
2010-06-10 18:28:25 +00:00
$repeat = 'repeat' ;
2016-10-26 06:52:29 +00:00
}
2010-06-11 20:19:35 +00:00
2016-10-26 06:52:29 +00:00
$repeat = " background-repeat: $repeat ;" ;
2010-06-11 20:19:35 +00:00
2016-10-26 06:52:29 +00:00
// Background Scroll.
2013-12-03 21:36:10 +00:00
$attachment = get_theme_mod ( 'background_attachment' , get_theme_support ( 'custom-background' , 'default-attachment' ) );
2016-10-26 06:52:29 +00:00
if ( 'fixed' !== $attachment ) {
2010-06-10 18:28:25 +00:00
$attachment = 'scroll' ;
2016-10-26 06:52:29 +00:00
}
2010-06-10 18:28:25 +00:00
$attachment = " background-attachment: $attachment ;" ;
2016-10-26 06:52:29 +00:00
$style .= $image . $position . $size . $repeat . $attachment ;
2010-03-28 02:53:04 +00:00
}
2010-02-09 20:37:12 +00:00
?>
2012-05-25 18:41:22 +00:00
<style type="text/css" id="custom-background-css">
2011-10-05 17:20:43 +00:00
body.custom-background { <?php echo trim( $style ); ?> }
2010-02-09 20:37:12 +00:00
</style>
<?php
}
2016-10-19 18:15:31 +00:00
/**
* Render the Custom CSS style element.
*
* @since 4.7.0
* @access public
*/
function wp_custom_css_cb() {
$styles = wp_get_custom_css();
if ( $styles || is_customize_preview() ) : ?>
<style type="text/css" id="wp-custom-css">
<?php echo strip_tags( $styles ); // Note that esc_html() cannot be used because `div > span` is not interpreted properly. ?>
</style>
<?php endif;
}
/**
2016-11-09 20:43:30 +00:00
* Fetch the `custom_css` post for a given theme.
2016-10-19 18:15:31 +00:00
*
* @since 4.7.0
* @access public
*
* @param string $stylesheet Optional. A theme object stylesheet name. Defaults to the current theme.
2016-11-09 20:43:30 +00:00
* @return WP_Post|null The custom_css post or null if none exists.
2016-10-19 18:15:31 +00:00
*/
2016-11-09 20:43:30 +00:00
function wp_get_custom_css_post( $stylesheet = '' ) {
2016-10-19 18:15:31 +00:00
if ( empty( $stylesheet ) ) {
$stylesheet = get_stylesheet();
}
$custom_css_query_vars = array(
2016-11-09 20:43:30 +00:00
'post_type' => 'custom_css',
'post_status' => get_post_stati(),
'name' => sanitize_title( $stylesheet ),
2016-11-22 11:41:34 +00:00
'posts_per_page' => 1,
2016-11-09 20:43:30 +00:00
'no_found_rows' => true,
'cache_results' => true,
2016-10-19 18:15:31 +00:00
'update_post_meta_cache' => false,
'update_term_meta_cache' => false,
);
$post = null;
if ( get_stylesheet() === $stylesheet ) {
$post_id = get_theme_mod( 'custom_css_post_id' );
2016-11-22 11:41:34 +00:00
if ( $post_id > 0 && get_post( $post_id ) ) {
$post = get_post( $post_id );
} else {
2016-10-19 18:15:31 +00:00
$query = new WP_Query( $custom_css_query_vars );
$post = $query->post;
/*
* Cache the lookup. See WP_Customize_Custom_CSS_Setting::update().
* @todo This should get cleared if a custom_css post is added/removed.
*/
2016-11-22 11:41:34 +00:00
if ( $post ) {
set_theme_mod( 'custom_css_post_id', $post->ID );
} elseif ( -1 !== $post_id ) {
set_theme_mod( 'custom_css_post_id', -1 );
}
2016-10-19 18:15:31 +00:00
}
} else {
$query = new WP_Query( $custom_css_query_vars );
$post = $query->post;
}
2016-11-09 20:43:30 +00:00
return $post;
}
/**
2016-11-13 02:43:29 +00:00
* Fetch the saved Custom CSS content for rendering.
2016-11-09 20:43:30 +00:00
*
* @since 4.7.0
* @access public
*
* @param string $stylesheet Optional. A theme object stylesheet name. Defaults to the current theme.
* @return string The Custom CSS Post content.
*/
function wp_get_custom_css( $stylesheet = '' ) {
$css = '';
if ( empty( $stylesheet ) ) {
$stylesheet = get_stylesheet();
}
$post = wp_get_custom_css_post( $stylesheet );
2016-10-19 18:15:31 +00:00
if ( $post ) {
$css = $post->post_content;
}
/**
* Modify the Custom CSS Output into the <head>.
*
* @since 4.7.0
*
* @param string $css CSS pulled in from the Custom CSS CPT.
* @param string $stylesheet The theme stylesheet name.
*/
$css = apply_filters( 'wp_get_custom_css', $css, $stylesheet );
return $css;
}
2016-11-23 17:34:31 +00:00
/**
* Update the `custom_css` post for a given theme.
*
* Inserts a `custom_css` post when one doesn't yet exist.
*
* @since 4.7.0
* @access public
*
* @param string $css CSS, stored in `post_content`.
* @param array $args {
* Args.
*
* @type string $preprocessed Pre-processed CSS, stored in `post_content_filtered`. Normally empty string. Optional.
* @type string $stylesheet Stylesheet (child theme) to update. Optional, defaults to current theme/stylesheet.
* }
* @return WP_Post|WP_Error Post on success, error on failure.
*/
function wp_update_custom_css_post( $css, $args = array() ) {
$args = wp_parse_args( $args, array(
'preprocessed' => '',
'stylesheet' => get_stylesheet(),
) );
$data = array(
'css' => $css,
'preprocessed' => $args['preprocessed'],
);
/**
* Filters the `css` (`post_content`) and `preprocessed` (`post_content_filtered`) args for a `custom_css` post being updated.
*
* This filter can be used by plugin that offer CSS pre-processors, to store the original
* pre-processed CSS in `post_content_filtered` and then store processed CSS in `post_content`.
* When used in this way, the `post_content_filtered` should be supplied as the setting value
* instead of `post_content` via a the `customize_value_custom_css` filter, for example:
*
* <code>
* add_filter( 'customize_value_custom_css', function( $value, $setting ) {
* $post = wp_get_custom_css_post( $setting->stylesheet );
* if ( $post && ! empty( $post->post_content_filtered ) ) {
* $css = $post->post_content_filtered;
* }
* return $css;
* }, 10, 2 );
* </code>
*
* @since 4.7.0
* @param array $data {
* Custom CSS data.
*
* @type string $css CSS stored in `post_content`.
* @type string $preprocessed Pre-processed CSS stored in `post_content_filtered`. Normally empty string.
* }
* @param array $args {
* The args passed into `wp_update_custom_css_post()` merged with defaults.
*
* @type string $css The original CSS passed in to be updated.
* @type string $preprocessed The original preprocessed CSS passed in to be updated.
* @type string $stylesheet The stylesheet (theme) being updated.
* }
*/
$data = apply_filters( 'update_custom_css_data', $data, array_merge( $args, compact( 'css' ) ) );
$post_data = array(
'post_title' => $args['stylesheet'],
'post_name' => sanitize_title( $args['stylesheet'] ),
'post_type' => 'custom_css',
'post_status' => 'publish',
'post_content' => $data['css'],
'post_content_filtered' => $data['preprocessed'],
);
// Update post if it already exists, otherwise create a new one.
$post = wp_get_custom_css_post( $args['stylesheet'] );
if ( $post ) {
$post_data['ID'] = $post->ID;
$r = wp_update_post( wp_slash( $post_data ), true );
} else {
$r = wp_insert_post( wp_slash( $post_data ), true );
}
if ( $r instanceof WP_Error ) {
return $r;
}
return get_post( $r );
}
2010-02-26 20:12:06 +00:00
/**
2010-02-26 21:07:41 +00:00
* Add callback for custom TinyMCE editor stylesheets.
2010-02-26 20:12:06 +00:00
*
* The parameter $stylesheet is the name of the stylesheet, relative to
2010-02-26 21:07:41 +00:00
* the theme root. It also accepts an array of stylesheets.
* It is optional and defaults to 'editor-style.css'.
2010-02-26 20:12:06 +00:00
*
2012-03-01 00:18:26 +00:00
* This function automatically adds another stylesheet with -rtl prefix, e.g. editor-style-rtl.css.
* If that file doesn't exist, it is removed before adding the stylesheet(s) to TinyMCE.
* If an array of stylesheets is passed to add_editor_style(),
2010-12-04 10:09:00 +00:00
* RTL is only added for the first stylesheet.
*
2012-03-01 00:18:26 +00:00
* Since version 3.4 the TinyMCE body has .rtl CSS class.
* It is a better option to use that class and add any RTL styles to the main stylesheet.
*
2010-02-26 20:12:06 +00:00
* @since 3.0.0
*
2015-05-27 22:21:25 +00:00
* @global array $editor_styles
*
2014-11-30 22:44:22 +00:00
* @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
2015-05-27 22:21:25 +00:00
* Defaults to 'editor-style.css'
2010-02-26 20:12:06 +00:00
*/
function add_editor_style( $stylesheet = 'editor-style.css' ) {
add_theme_support( 'editor-style' );
if ( ! is_admin() )
return;
2010-02-27 07:36:35 +00:00
global $editor_styles;
$editor_styles = (array) $editor_styles;
$stylesheet = (array) $stylesheet;
2010-05-03 05:49:19 +00:00
if ( is_rtl() ) {
2010-04-26 14:56:57 +00:00
$rtl_stylesheet = str_replace('.css', '-rtl.css', $stylesheet[0]);
$stylesheet[] = $rtl_stylesheet;
}
2010-02-27 07:36:35 +00:00
$editor_styles = array_merge( $editor_styles, $stylesheet );
2010-02-26 20:12:06 +00:00
}
2010-12-04 10:09:00 +00:00
/**
* Removes all visual editor stylesheets.
*
* @since 3.1.0
*
2015-05-27 22:21:25 +00:00
* @global array $editor_styles
*
2010-12-04 10:09:00 +00:00
* @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;
}
2014-07-15 21:51:15 +00:00
/**
* Retrieve any registered editor stylesheets
*
* @since 4.0.0
*
2015-05-27 22:21:25 +00:00
* @global array $editor_styles Registered editor stylesheets
2014-07-15 21:51:15 +00:00
*
* @return array If registered, a list of editor stylesheet URLs.
*/
function get_editor_stylesheets() {
$stylesheets = array();
// load editor_style.css if the current theme supports it
if ( ! empty( $GLOBALS['editor_styles'] ) && is_array( $GLOBALS['editor_styles'] ) ) {
$editor_styles = $GLOBALS['editor_styles'];
$editor_styles = array_unique( array_filter( $editor_styles ) );
$style_uri = get_stylesheet_directory_uri();
$style_dir = get_stylesheet_directory();
// Support externally referenced styles (like, say, fonts).
foreach ( $editor_styles as $key => $file ) {
if ( preg_match( '~^(https?:)?//~', $file ) ) {
$stylesheets[] = esc_url_raw( $file );
unset( $editor_styles[ $key ] );
}
}
// Look in a parent theme first, that way child theme CSS overrides.
if ( is_child_theme() ) {
$template_uri = get_template_directory_uri();
$template_dir = get_template_directory();
foreach ( $editor_styles as $key => $file ) {
if ( $file && file_exists( "$template_dir/$file" ) ) {
$stylesheets[] = "$template_uri/$file";
}
}
}
foreach ( $editor_styles as $file ) {
if ( $file && file_exists( "$style_dir/$file" ) ) {
$stylesheets[] = "$style_uri/$file";
}
}
}
2015-07-13 22:01:24 +00:00
2015-06-24 13:32:32 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters the array of stylesheets applied to the editor.
2015-06-24 13:32:32 +00:00
*
* @since 4.3.0
*
* @param array $stylesheets Array of stylesheets to be applied to the editor.
*/
return apply_filters( 'editor_stylesheets', $stylesheets );
2014-07-15 21:51:15 +00:00
}
2016-10-28 02:57:35 +00:00
/**
* Expand a theme's starter content configuration using core-provided data.
*
* @since 4.7.0
*
* @return array Array of starter content.
*/
function get_theme_starter_content() {
$theme_support = get_theme_support( 'starter-content' );
2016-11-17 08:18:32 +00:00
if ( is_array( $theme_support ) && ! empty( $theme_support[0] ) && is_array( $theme_support[0] ) ) {
2016-10-28 02:57:35 +00:00
$config = $theme_support[0];
} else {
$config = array();
}
2016-11-15 09:03:32 +00:00
$core_content = array(
2016-10-28 02:57:35 +00:00
'widgets' => array(
2016-11-15 09:03:32 +00:00
'text_business_info' => array( 'text', array(
2016-11-14 21:38:32 +00:00
'title' => _x( 'Find Us', 'Theme starter content' ),
2016-11-15 09:03:32 +00:00
'text' => join( '', array(
2016-11-14 21:38:32 +00:00
'<p><strong>' . _x( 'Address', 'Theme starter content' ) . '</strong><br />',
_x( '123 Main Street', 'Theme starter content' ) . '<br />' . _x( 'New York, NY 10001', 'Theme starter content' ) . '</p>',
'<p><strong>' . _x( 'Hours', 'Theme starter content' ) . '</strong><br />',
_x( 'Monday—Friday: 9:00AM–5:00PM', 'Theme starter content' ) . '<br />' . _x( 'Saturday & Sunday: 11:00AM–3:00PM', 'Theme starter content' ) . '</p>'
2016-10-28 02:57:35 +00:00
) ),
) ),
2016-11-15 21:08:30 +00:00
'text_about' => array( 'text', array(
'title' => _x( 'About This Site', 'Theme starter content' ),
'text' => _x( 'This may be a good place to introduce yourself and your site or include some credits.', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
) ),
2016-11-16 00:40:32 +00:00
'archives' => array( 'archives', array(
'title' => _x( 'Archives', 'Theme starter content' ),
) ),
'calendar' => array( 'calendar', array(
'title' => _x( 'Calendar', 'Theme starter content' ),
) ),
'categories' => array( 'categories', array(
'title' => _x( 'Categories', 'Theme starter content' ),
) ),
'meta' => array( 'meta', array(
'title' => _x( 'Meta', 'Theme starter content' ),
) ),
'recent-comments' => array( 'recent-comments', array(
'title' => _x( 'Recent Comments', 'Theme starter content' ),
) ),
'recent-posts' => array( 'recent-posts', array(
'title' => _x( 'Recent Posts', 'Theme starter content' ),
) ),
'search' => array( 'search', array(
'title' => _x( 'Search', 'Theme starter content' ),
) ),
2016-10-28 02:57:35 +00:00
),
2016-11-15 09:03:32 +00:00
'nav_menus' => array(
2016-10-28 02:57:35 +00:00
'page_home' => array(
'type' => 'post_type',
'object' => 'page',
'object_id' => '{{home}}',
),
'page_about' => array(
'type' => 'post_type',
'object' => 'page',
2016-11-16 00:29:31 +00:00
'object_id' => '{{about}}',
2016-10-28 02:57:35 +00:00
),
'page_blog' => array(
'type' => 'post_type',
'object' => 'page',
'object_id' => '{{blog}}',
),
2016-11-16 00:29:31 +00:00
'page_news' => array(
'type' => 'post_type',
'object' => 'page',
'object_id' => '{{news}}',
),
2016-10-28 02:57:35 +00:00
'page_contact' => array(
'type' => 'post_type',
'object' => 'page',
2016-11-16 00:29:31 +00:00
'object_id' => '{{contact}}',
2016-10-28 02:57:35 +00:00
),
2016-11-15 21:20:31 +00:00
'link_email' => array(
'title' => _x( 'Email', 'Theme starter content' ),
'url' => 'mailto:wordpress@example.com',
2016-10-28 02:57:35 +00:00
),
'link_facebook' => array(
2016-11-14 21:38:32 +00:00
'title' => _x( 'Facebook', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
'url' => 'https://www.facebook.com/wordpress',
),
2016-11-15 21:20:31 +00:00
'link_foursquare' => array(
'title' => _x( 'Foursquare', 'Theme starter content' ),
'url' => 'https://foursquare.com/',
),
'link_github' => array(
'title' => _x( 'GitHub', 'Theme starter content' ),
'url' => 'https://github.com/wordpress/',
2016-10-28 02:57:35 +00:00
),
'link_instagram' => array(
2016-11-14 21:38:32 +00:00
'title' => _x( 'Instagram', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
'url' => 'https://www.instagram.com/explore/tags/wordcamp/',
),
2016-11-15 21:20:31 +00:00
'link_linkedin' => array(
'title' => _x( 'LinkedIn', 'Theme starter content' ),
'url' => 'https://www.linkedin.com/company/1089783',
),
'link_pinterest' => array(
'title' => _x( 'Pinterest', 'Theme starter content' ),
'url' => 'https://www.pinterest.com/',
),
'link_twitter' => array(
'title' => _x( 'Twitter', 'Theme starter content' ),
'url' => 'https://twitter.com/wordpress',
),
'link_yelp' => array(
'title' => _x( 'Yelp', 'Theme starter content' ),
'url' => 'https://www.yelp.com',
),
'link_youtube' => array(
'title' => _x( 'YouTube', 'Theme starter content' ),
'url' => 'https://www.youtube.com/channel/UCdof4Ju7amm1chz1gi1T2ZA',
2016-10-28 02:57:35 +00:00
),
),
'posts' => array(
'home' => array(
'post_type' => 'page',
2016-11-16 00:29:31 +00:00
'post_title' => _x( 'Home', 'Theme starter content' ),
'post_content' => _x( 'Welcome to your site! This is your homepage, which is what most visitors will see when they come to your site for the first time.', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
),
2016-11-16 00:29:31 +00:00
'about' => array(
2016-10-28 02:57:35 +00:00
'post_type' => 'page',
2016-11-16 00:29:31 +00:00
'post_title' => _x( 'About', 'Theme starter content' ),
'post_content' => _x( 'You might be an artist who would like to introduce yourself and your work here or maybe you’re a business with a mission to describe.', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
),
2016-11-16 00:29:31 +00:00
'contact' => array(
2016-10-28 02:57:35 +00:00
'post_type' => 'page',
2016-11-16 00:29:31 +00:00
'post_title' => _x( 'Contact', 'Theme starter content' ),
'post_content' => _x( 'This is a page with some basic contact information, such as an address and phone number. You might also try a plugin to add a contact form.', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
),
'blog' => array(
'post_type' => 'page',
2016-11-14 21:38:32 +00:00
'post_title' => _x( 'Blog', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
),
2016-11-16 00:29:31 +00:00
'news' => array(
'post_type' => 'page',
'post_title' => _x( 'News', 'Theme starter content' ),
),
2016-10-28 02:57:35 +00:00
'homepage-section' => array(
'post_type' => 'page',
2016-11-14 21:38:32 +00:00
'post_title' => _x( 'A homepage section', 'Theme starter content' ),
2016-11-16 00:29:31 +00:00
'post_content' => _x( 'This is an example of a homepage section. Homepage sections can be any page other than the homepage itself, including the page that shows your latest blog posts.', 'Theme starter content' ),
2016-10-28 02:57:35 +00:00
),
),
);
$content = array();
foreach ( $config as $type => $args ) {
switch( $type ) {
2016-11-15 09:03:32 +00:00
// Use options and theme_mods as-is.
2016-10-28 02:57:35 +00:00
case 'options' :
case 'theme_mods' :
$content[ $type ] = $config[ $type ];
break;
2016-11-15 09:03:32 +00:00
// Widgets are grouped into sidebars.
2016-10-28 02:57:35 +00:00
case 'widgets' :
2016-11-15 09:03:32 +00:00
foreach ( $config[ $type ] as $sidebar_id => $widgets ) {
2016-11-23 09:53:33 +00:00
foreach ( $widgets as $id => $widget ) {
2016-11-15 09:03:32 +00:00
if ( is_array( $widget ) ) {
2016-11-23 09:53:33 +00:00
// Item extends core content.
if ( ! empty( $core_content[ $type ][ $id ] ) ) {
$widget = array(
$core_content[ $type ][ $id ][0],
array_merge( $core_content[ $type ][ $id ][1], $widget ),
);
}
2016-11-15 09:03:32 +00:00
$content[ $type ][ $sidebar_id ][] = $widget;
} elseif ( is_string( $widget ) && ! empty( $core_content[ $type ] ) && ! empty( $core_content[ $type ][ $widget ] ) ) {
$content[ $type ][ $sidebar_id ][] = $core_content[ $type ][ $widget ];
2016-10-28 02:57:35 +00:00
}
}
}
break;
2016-11-15 09:03:32 +00:00
// And nav menu items are grouped into nav menus.
2016-10-28 02:57:35 +00:00
case 'nav_menus' :
2016-11-15 09:03:32 +00:00
foreach ( $config[ $type ] as $nav_menu_location => $nav_menu ) {
// Ensure nav menus get a name.
if ( empty( $nav_menu['name'] ) ) {
$nav_menu['name'] = $nav_menu_location;
2016-10-28 02:57:35 +00:00
}
2016-11-15 09:03:32 +00:00
$content[ $type ][ $nav_menu_location ]['name'] = $nav_menu['name'];
2016-10-28 02:57:35 +00:00
2016-11-23 09:53:33 +00:00
foreach ( $nav_menu['items'] as $id => $nav_menu_item ) {
2016-11-15 09:03:32 +00:00
if ( is_array( $nav_menu_item ) ) {
2016-11-23 09:53:33 +00:00
// Item extends core content.
if ( ! empty( $core_content[ $type ][ $id ] ) ) {
$nav_menu_item = array_merge( $core_content[ $type ][ $id ], $nav_menu_item );
}
2016-11-15 09:03:32 +00:00
$content[ $type ][ $nav_menu_location ]['items'][] = $nav_menu_item;
} elseif ( is_string( $nav_menu_item ) && ! empty( $core_content[ $type ] ) && ! empty( $core_content[ $type ][ $nav_menu_item ] ) ) {
$content[ $type ][ $nav_menu_location ]['items'][] = $core_content[ $type ][ $nav_menu_item ];
2016-10-28 02:57:35 +00:00
}
}
}
break;
2016-11-23 09:53:33 +00:00
// Attachments are posts but have special treatment.
case 'attachments' :
foreach ( $config[ $type ] as $id => $item ) {
if ( ! empty( $item['file'] ) ) {
$content[ $type ][ $id ] = $item;
}
}
break;
// All that's left now are posts (besides attachments). Not a default case for the sake of clarity and future work.
case 'posts' :
foreach ( $config[ $type ] as $id => $item ) {
2016-11-15 09:03:32 +00:00
if ( is_array( $item ) ) {
2016-11-23 09:53:33 +00:00
// Item extends core content.
if ( ! empty( $core_content[ $type ][ $id ] ) ) {
$item = array_merge( $core_content[ $type ][ $id ], $item );
}
// Enforce a subset of fields.
$content[ $type ][ $id ] = wp_array_slice_assoc(
$item,
array(
'post_type',
'post_title',
'post_excerpt',
'post_name',
'post_content',
'menu_order',
'comment_status',
'thumbnail',
'template',
)
);
} elseif ( is_string( $item ) && ! empty( $core_content[ $type ][ $item ] ) ) {
2016-11-15 09:03:32 +00:00
$content[ $type ][ $item ] = $core_content[ $type ][ $item ];
2016-10-28 02:57:35 +00:00
}
}
break;
}
}
/**
* Filters the expanded array of starter content.
*
* @since 4.7.0
*
* @param array $content Array of starter content.
* @param array $config Array of theme-specific starter content configuration.
*/
return apply_filters( 'get_theme_starter_content', $content, $config );
}
2009-11-01 05:27:39 +00:00
/**
2016-06-10 00:07:30 +00:00
* Registers theme support for a given feature.
2010-01-15 22:11:12 +00:00
*
2010-03-31 09:06:11 +00:00
* Must be called in the theme's functions.php file to work.
2016-05-23 19:02:28 +00:00
* If attached to a hook, it must be {@see 'after_setup_theme'}.
* The {@see 'init'} hook may be too late for some features.
2009-11-01 05:27:39 +00:00
*
2010-03-26 19:23:39 +00:00
* @since 2.9.0
2016-06-26 14:26:29 +00:00
* @since 3.6.0 The `html5` feature was added
* @since 3.9.0 The `html5` feature now also accepts 'gallery' and 'caption'
* @since 4.1.0 The `title-tag` feature was added
* @since 4.5.0 The `customize-selective-refresh-widgets` feature was added
2016-10-28 02:57:35 +00:00
* @since 4.7.0 The `starter-content` feature was added
2014-03-31 22:20:16 +00:00
*
2015-05-27 22:21:25 +00:00
* @global array $_wp_theme_features
*
2016-06-10 00:03:28 +00:00
* @param string $feature The feature being added. Likely core values include 'post-formats',
* 'post-thumbnails', 'html5', 'custom-logo', 'custom-header-uploads',
2016-10-28 02:57:35 +00:00
* 'custom-header', 'custom-background', 'title-tag', 'starter-content', etc.
2016-06-10 00:03:28 +00:00
* @param mixed $args,... Optional extra arguments to pass along with certain features.
2014-03-31 22:20:16 +00:00
* @return void|bool False on failure, void otherwise.
2009-11-01 05:27:39 +00:00
*/
function add_theme_support( $feature ) {
global $_wp_theme_features;
2009-12-09 15:39:20 +00:00
if ( func_num_args() == 1 )
2012-03-19 17:12:44 +00:00
$args = true;
2009-12-09 15:39:20 +00:00
else
2012-03-19 17:12:44 +00:00
$args = array_slice( func_get_args(), 1 );
switch ( $feature ) {
2016-04-26 17:05:31 +00:00
case 'post-thumbnails':
// All post types are already supported.
if ( true === get_theme_support( 'post-thumbnails' ) ) {
return;
}
/*
* Merge post types with any that already declared their support
* for post thumbnails.
*/
2016-04-26 20:29:27 +00:00
if ( is_array( $args[0] ) && isset( $_wp_theme_features['post-thumbnails'] ) ) {
$args[0] = array_unique( array_merge( $_wp_theme_features['post-thumbnails'][0], $args[0] ) );
2016-04-26 17:05:31 +00:00
}
break;
2013-02-21 22:48:09 +00:00
case 'post-formats' :
2014-10-27 11:26:18 +00:00
if ( is_array( $args[0] ) ) {
$post_formats = get_post_format_slugs();
unset( $post_formats['standard'] );
$args[0] = array_intersect( $args[0], array_keys( $post_formats ) );
}
2012-03-19 17:12:44 +00:00
break;
2013-08-31 01:30:09 +00:00
case 'html5' :
// You can't just pass 'html5', you need to pass an array of types.
2013-09-04 17:44:09 +00:00
if ( empty( $args[0] ) ) {
2014-03-31 22:20:16 +00:00
// Build an array of types for back-compat.
2013-09-04 17:44:09 +00:00
$args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
} elseif ( ! is_array( $args[0] ) ) {
2014-10-05 21:06:15 +00:00
_doing_it_wrong( "add_theme_support( 'html5' )", __( 'You need to pass an array of types.' ), '3.6.1' );
2013-08-31 01:30:09 +00:00
return false;
2013-09-04 17:44:09 +00:00
}
2013-08-31 01:30:09 +00:00
// Calling 'html5' again merges, rather than overwrites.
if ( isset( $_wp_theme_features['html5'] ) )
$args[0] = array_merge( $_wp_theme_features['html5'][0], $args[0] );
break;
2016-03-24 02:02:27 +00:00
case 'custom-logo':
2016-03-30 02:22:26 +00:00
if ( ! is_array( $args ) ) {
$args = array( 0 => array() );
}
2016-03-24 02:02:27 +00:00
$defaults = array(
'width' => null,
'height' => null,
'flex-width' => false,
'flex-height' => false,
'header-text' => '',
);
$args[0] = wp_parse_args( array_intersect_key( $args[0], $defaults ), $defaults );
// Allow full flexibility if no size is specified.
if ( is_null( $args[0]['width'] ) && is_null( $args[0]['height'] ) ) {
$args[0]['flex-width'] = true;
$args[0]['flex-height'] = true;
}
break;
2012-03-19 17:12:44 +00:00
case 'custom-header-uploads' :
return add_theme_support( 'custom-header', array( 'uploads' => true ) );
case 'custom-header' :
2012-03-20 20:34:49 +00:00
if ( ! is_array( $args ) )
$args = array( 0 => array() );
2012-03-19 17:12:44 +00:00
$defaults = array(
'default-image' => '',
'random-default' => false,
'width' => 0,
'height' => 0,
'flex-height' => false,
'flex-width' => false,
'default-text-color' => '',
'header-text' => true,
'uploads' => true,
2012-03-21 03:36:17 +00:00
'wp-head-callback' => '',
'admin-head-callback' => '',
'admin-preview-callback' => '',
2016-10-27 21:51:31 +00:00
'video' => false,
2016-11-15 07:16:33 +00:00
'video-active-callback' => 'is_front_page',
2012-03-19 17:12:44 +00:00
);
$jit = isset( $args[0]['__jit'] );
unset( $args[0]['__jit'] );
// Merge in data from previous add_theme_support() calls.
// The first value registered wins. (A child theme is set up first.)
if ( isset( $_wp_theme_features['custom-header'] ) )
$args[0] = wp_parse_args( $_wp_theme_features['custom-header'][0], $args[0] );
// Load in the defaults at the end, as we need to insure first one wins.
// This will cause all constants to be defined, as each arg will then be set to the default.
if ( $jit )
$args[0] = wp_parse_args( $args[0], $defaults );
// If a constant was defined, use that value. Otherwise, define the constant to ensure
// the constant is always accurate (and is not defined later, overriding our value).
// As stated above, the first value wins.
// Once we get to wp_loaded (just-in-time), define any constants we haven't already.
2016-05-13 18:41:31 +00:00
// Constants are lame. Don't reference them. This is just for backward compatibility.
2012-03-19 17:12:44 +00:00
if ( defined( 'NO_HEADER_TEXT' ) )
$args[0]['header-text'] = ! NO_HEADER_TEXT;
elseif ( isset( $args[0]['header-text'] ) )
define( 'NO_HEADER_TEXT', empty( $args[0]['header-text'] ) );
if ( defined( 'HEADER_IMAGE_WIDTH' ) )
$args[0]['width'] = (int) HEADER_IMAGE_WIDTH;
elseif ( isset( $args[0]['width'] ) )
define( 'HEADER_IMAGE_WIDTH', (int) $args[0]['width'] );
if ( defined( 'HEADER_IMAGE_HEIGHT' ) )
$args[0]['height'] = (int) HEADER_IMAGE_HEIGHT;
2012-03-20 20:34:49 +00:00
elseif ( isset( $args[0]['height'] ) )
2012-03-19 17:12:44 +00:00
define( 'HEADER_IMAGE_HEIGHT', (int) $args[0]['height'] );
if ( defined( 'HEADER_TEXTCOLOR' ) )
$args[0]['default-text-color'] = HEADER_TEXTCOLOR;
elseif ( isset( $args[0]['default-text-color'] ) )
define( 'HEADER_TEXTCOLOR', $args[0]['default-text-color'] );
if ( defined( 'HEADER_IMAGE' ) )
$args[0]['default-image'] = HEADER_IMAGE;
2012-03-20 20:34:49 +00:00
elseif ( isset( $args[0]['default-image'] ) )
define( 'HEADER_IMAGE', $args[0]['default-image'] );
2012-03-19 17:12:44 +00:00
if ( $jit && ! empty( $args[0]['default-image'] ) )
$args[0]['random-default'] = false;
// If headers are supported, and we still don't have a defined width or height,
// we have implicit flex sizes.
if ( $jit ) {
if ( empty( $args[0]['width'] ) && empty( $args[0]['flex-width'] ) )
$args[0]['flex-width'] = true;
if ( empty( $args[0]['height'] ) && empty( $args[0]['flex-height'] ) )
$args[0]['flex-height'] = true;
}
break;
case 'custom-background' :
2012-03-20 20:34:49 +00:00
if ( ! is_array( $args ) )
$args = array( 0 => array() );
2012-03-19 17:12:44 +00:00
$defaults = array(
2013-11-24 14:05:10 +00:00
'default-image' => '',
2016-10-26 06:52:29 +00:00
'default-preset' => 'default',
2013-12-03 21:36:10 +00:00
'default-position-x' => 'left',
2016-10-26 06:52:29 +00:00
'default-position-y' => 'top',
'default-size' => 'auto',
'default-repeat' => 'repeat',
2013-12-03 21:36:10 +00:00
'default-attachment' => 'scroll',
2013-11-24 14:05:10 +00:00
'default-color' => '',
'wp-head-callback' => '_custom_background_cb',
'admin-head-callback' => '',
2012-03-21 03:36:17 +00:00
'admin-preview-callback' => '',
2012-03-19 17:12:44 +00:00
);
$jit = isset( $args[0]['__jit'] );
unset( $args[0]['__jit'] );
// Merge in data from previous add_theme_support() calls. The first value registered wins.
if ( isset( $_wp_theme_features['custom-background'] ) )
$args[0] = wp_parse_args( $_wp_theme_features['custom-background'][0], $args[0] );
if ( $jit )
$args[0] = wp_parse_args( $args[0], $defaults );
if ( defined( 'BACKGROUND_COLOR' ) )
$args[0]['default-color'] = BACKGROUND_COLOR;
elseif ( isset( $args[0]['default-color'] ) || $jit )
define( 'BACKGROUND_COLOR', $args[0]['default-color'] );
if ( defined( 'BACKGROUND_IMAGE' ) )
$args[0]['default-image'] = BACKGROUND_IMAGE;
elseif ( isset( $args[0]['default-image'] ) || $jit )
define( 'BACKGROUND_IMAGE', $args[0]['default-image'] );
break;
2014-10-28 21:12:22 +00:00
// Ensure that 'title-tag' is accessible in the admin.
case 'title-tag' :
// Can be called in functions.php but must happen before wp_loaded, i.e. not in header.php.
if ( did_action( 'wp_loaded' ) ) {
2014-12-08 16:06:26 +00:00
/* translators: 1: Theme support 2: hook name */
_doing_it_wrong( "add_theme_support( 'title-tag' )", sprintf( __( 'Theme support for %1$s should be registered before the %2$s hook.' ),
2016-07-06 12:40:29 +00:00
'<code>title-tag</code>', '<code>wp_loaded</code>' ), '4.1.0' );
2014-10-28 21:12:22 +00:00
return false;
}
2012-03-19 17:12:44 +00:00
}
$_wp_theme_features[ $feature ] = $args;
}
/**
* Registers the internal custom header and background routines.
*
* @since 3.4.0
* @access private
2015-05-27 22:21:25 +00:00
*
* @global Custom_Image_Header $custom_image_header
* @global Custom_Background $custom_background
2012-03-19 17:12:44 +00:00
*/
function _custom_header_background_just_in_time() {
global $custom_image_header, $custom_background;
if ( current_theme_supports( 'custom-header' ) ) {
// In case any constants were defined after an add_custom_image_header() call, re-run.
add_theme_support( 'custom-header', array( '__jit' => true ) );
$args = get_theme_support( 'custom-header' );
2012-05-03 13:30:55 +00:00
if ( $args[0]['wp-head-callback'] )
2012-03-21 03:36:17 +00:00
add_action( 'wp_head', $args[0]['wp-head-callback'] );
2012-03-19 17:12:44 +00:00
2012-05-03 13:30:55 +00:00
if ( is_admin() ) {
2016-08-31 16:31:29 +00:00
require_once( ABSPATH . 'wp-admin/custom-header.php' );
2012-05-03 13:30:55 +00:00
$custom_image_header = new Custom_Image_Header( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
2012-03-19 17:12:44 +00:00
}
}
2011-01-06 04:11:14 +00:00
2012-03-19 17:12:44 +00:00
if ( current_theme_supports( 'custom-background' ) ) {
// In case any constants were defined after an add_custom_background() call, re-run.
add_theme_support( 'custom-background', array( '__jit' => true ) );
$args = get_theme_support( 'custom-background' );
2012-03-21 03:36:17 +00:00
add_action( 'wp_head', $args[0]['wp-head-callback'] );
2012-03-19 17:12:44 +00:00
if ( is_admin() ) {
2016-08-31 16:31:29 +00:00
require_once( ABSPATH . 'wp-admin/custom-background.php' );
2012-03-21 03:36:17 +00:00
$custom_background = new Custom_Background( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
2012-03-19 17:12:44 +00:00
}
2012-03-19 21:14:41 +00:00
}
2009-11-01 05:27:39 +00:00
}
2016-03-10 05:37:27 +00:00
/**
* Adds CSS to hide header text for custom logo, based on Customizer setting.
*
* @since 4.5.0
* @access private
*/
function _custom_logo_header_styles() {
if ( ! current_theme_supports( 'custom-header', 'header-text' ) && get_theme_support( 'custom-logo', 'header-text' ) && ! get_theme_mod( 'header_text', true ) ) {
$classes = (array) get_theme_support( 'custom-logo', 'header-text' );
$classes = array_map( 'sanitize_html_class', $classes );
$classes = '.' . implode( ', .', $classes );
?>
<!-- Custom Logo: hide header text -->
<style id="custom-logo-css" type="text/css">
<?php echo $classes; ?> {
position: absolute;
clip: rect(1px, 1px, 1px, 1px);
}
</style>
<?php
}
}
2010-11-04 07:41:07 +00:00
/**
* Gets the theme support arguments passed when registering that support
*
2013-12-24 18:57:12 +00:00
* @since 3.1.0
*
2015-05-27 22:21:25 +00:00
* @global array $_wp_theme_features
*
2010-11-04 07:41:07 +00:00
* @param string $feature the feature to check
2014-11-03 05:18:22 +00:00
* @return mixed The array of extra arguments or the value for the registered feature.
2010-11-04 07:41:07 +00:00
*/
function get_theme_support( $feature ) {
global $_wp_theme_features;
2012-03-19 17:12:44 +00:00
if ( ! isset( $_wp_theme_features[ $feature ] ) )
2010-11-04 07:41:07 +00:00
return false;
2012-03-19 17:12:44 +00:00
if ( func_num_args() <= 1 )
return $_wp_theme_features[ $feature ];
$args = array_slice( func_get_args(), 1 );
switch ( $feature ) {
2016-03-09 21:51:27 +00:00
case 'custom-logo' :
2012-03-19 17:12:44 +00:00
case 'custom-header' :
case 'custom-background' :
if ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) )
return $_wp_theme_features[ $feature ][0][ $args[0] ];
return false;
2014-05-07 03:50:14 +00:00
2012-03-19 17:12:44 +00:00
default :
return $_wp_theme_features[ $feature ];
}
2010-11-04 07:41:07 +00:00
}
2010-03-29 16:26:54 +00:00
/**
* Allows a theme to de-register its support of a certain feature
*
2010-03-31 09:06:11 +00:00
* Should be called in the theme's functions.php file. Generally would
* be used for child themes to override support from the parent theme.
2010-03-29 16:26:54 +00:00
*
* @since 3.0.0
2010-03-31 09:06:11 +00:00
* @see add_theme_support()
2010-03-29 16:26:54 +00:00
* @param string $feature the feature being added
2015-05-27 22:21:25 +00:00
* @return bool|void Whether feature was removed.
2010-03-29 16:26:54 +00:00
*/
function remove_theme_support( $feature ) {
2010-03-31 09:06:11 +00:00
// Blacklist: for internal registrations not used directly by themes.
2012-03-19 17:12:44 +00:00
if ( in_array( $feature, array( 'editor-style', 'widgets', 'menus' ) ) )
2010-03-31 09:06:11 +00:00
return false;
2012-03-19 17:12:44 +00:00
2010-12-02 00:16:35 +00:00
return _remove_theme_support( $feature );
}
2010-03-31 09:06:11 +00:00
2010-12-02 00:16:35 +00:00
/**
2010-12-04 09:59:35 +00:00
* Do not use. Removes theme support internally, ignorant of the blacklist.
2010-12-02 00:16:35 +00:00
*
* @access private
* @since 3.1.0
2015-05-27 22:21:25 +00:00
*
* @global array $_wp_theme_features
* @global Custom_Image_Header $custom_image_header
* @global Custom_Background $custom_background
*
2014-11-30 22:44:22 +00:00
* @param string $feature
2010-12-02 00:16:35 +00:00
*/
function _remove_theme_support( $feature ) {
2010-03-29 16:26:54 +00:00
global $_wp_theme_features;
2012-03-19 17:12:44 +00:00
switch ( $feature ) {
case 'custom-header-uploads' :
if ( ! isset( $_wp_theme_features['custom-header'] ) )
return false;
add_theme_support( 'custom-header', array( 'uploads' => false ) );
return; // Do not continue - custom-header-uploads no longer exists.
}
if ( ! isset( $_wp_theme_features[ $feature ] ) )
2010-03-31 09:06:11 +00:00
return false;
2012-03-19 17:12:44 +00:00
switch ( $feature ) {
case 'custom-header' :
2013-02-01 20:33:27 +00:00
if ( ! did_action( 'wp_loaded' ) )
2012-10-26 04:17:25 +00:00
break;
2012-03-19 17:12:44 +00:00
$support = get_theme_support( 'custom-header' );
2016-11-15 07:16:33 +00:00
if ( isset( $support[0]['wp-head-callback'] ) ) {
2012-03-21 03:36:17 +00:00
remove_action( 'wp_head', $support[0]['wp-head-callback'] );
2016-11-15 07:16:33 +00:00
}
if ( isset( $GLOBALS['custom_image_header'] ) ) {
remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
unset( $GLOBALS['custom_image_header'] );
}
2012-03-19 17:12:44 +00:00
break;
2012-03-19 17:15:30 +00:00
case 'custom-background' :
2013-02-01 20:33:27 +00:00
if ( ! did_action( 'wp_loaded' ) )
2012-10-26 04:17:25 +00:00
break;
2012-03-19 17:12:44 +00:00
$support = get_theme_support( 'custom-background' );
2012-10-26 04:16:49 +00:00
remove_action( 'wp_head', $support[0]['wp-head-callback'] );
remove_action( 'admin_menu', array( $GLOBALS['custom_background'], 'init' ) );
unset( $GLOBALS['custom_background'] );
2012-03-19 17:12:44 +00:00
break;
}
unset( $_wp_theme_features[ $feature ] );
2010-03-31 09:06:11 +00:00
return true;
2010-03-29 16:26:54 +00:00
}
2009-11-01 05:27:39 +00:00
/**
* Checks a theme's support for a given feature
*
2010-03-26 19:23:39 +00:00
* @since 2.9.0
2015-05-27 22:21:25 +00:00
*
* @global array $_wp_theme_features
*
2009-11-01 05:27:39 +00:00
* @param string $feature the feature being checked
2015-05-27 22:21:25 +00:00
* @return bool
2009-11-01 05:27:39 +00:00
*/
function current_theme_supports( $feature ) {
global $_wp_theme_features;
2009-12-09 15:39:20 +00:00
2012-03-19 17:12:44 +00:00
if ( 'custom-header-uploads' == $feature )
return current_theme_supports( 'custom-header', 'uploads' );
2009-12-09 15:39:20 +00:00
if ( !isset( $_wp_theme_features[$feature] ) )
return false;
// If no args passed then no extra checks need be performed
if ( func_num_args() <= 1 )
return true;
$args = array_slice( func_get_args(), 1 );
switch ( $feature ) {
2009-12-10 06:14:36 +00:00
case 'post-thumbnails':
2009-12-09 15:39:20 +00:00
// post-thumbnails can be registered for only certain content/post types by passing
2011-12-13 23:45:31 +00:00
// an array of types to add_theme_support(). If no array was passed, then
2009-12-09 15:39:20 +00:00
// any type is accepted
if ( true === $_wp_theme_features[$feature] ) // Registered for all types
return true;
$content_type = $args[0];
2011-09-19 16:29:03 +00:00
return in_array( $content_type, $_wp_theme_features[$feature][0] );
2013-08-31 01:30:09 +00:00
case 'html5':
2011-09-19 16:29:03 +00:00
case 'post-formats':
// specific post formats can be registered by passing an array of types to
// add_theme_support()
2013-08-31 01:30:09 +00:00
// Specific areas of HTML5 support *must* be passed via an array to add_theme_support()
$type = $args[0];
return in_array( $type, $_wp_theme_features[$feature][0] );
2012-02-02 23:35:37 +00:00
2016-03-09 21:51:27 +00:00
case 'custom-logo':
2012-02-02 23:35:37 +00:00
case 'custom-header':
2016-03-09 21:51:27 +00:00
case 'custom-background':
// Specific capabilities can be registered by passing an array to add_theme_support().
return ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) && $_wp_theme_features[ $feature ][0][ $args[0] ] );
2009-12-09 15:39:20 +00:00
}
2013-12-01 17:24:11 +00:00
/**
2016-05-22 18:18:29 +00:00
* Filters whether the current theme supports a specific feature.
2013-12-01 17:24:11 +00:00
*
2014-11-30 12:10:23 +00:00
* The dynamic portion of the hook name, `$feature`, refers to the specific theme
* feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
2016-10-28 02:57:35 +00:00
* 'custom-header', 'menus', 'automatic-feed-links', 'html5',
* 'starter-content', and 'customize-selective-refresh-widgets'.
2013-12-01 17:24:11 +00:00
*
* @since 3.4.0
*
* @param bool true Whether the current theme supports the given feature. Default true.
* @param array $args Array of arguments for the feature.
* @param string $feature The theme feature.
*/
return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[$feature] );
2009-11-01 05:27:39 +00:00
}
2012-04-30 02:02:11 +00:00
/**
* Checks a theme's support for a given feature before loading the functions which implement it.
*
* @since 2.9.0
2014-02-20 22:11:14 +00:00
*
* @param string $feature The feature being checked.
* @param string $include Path to the file.
* @return bool True if the current theme supports the supplied feature, false otherwise.
2012-04-30 02:02:11 +00:00
*/
2014-02-20 22:11:14 +00:00
function require_if_theme_supports( $feature, $include ) {
if ( current_theme_supports( $feature ) ) {
2012-04-30 02:02:11 +00:00
require ( $include );
2014-02-20 22:11:14 +00:00
return true;
}
return false;
2012-04-30 02:02:11 +00:00
}
2010-05-24 19:42:43 +00:00
/**
2010-05-24 21:26:49 +00:00
* Checks an attachment being deleted to see if it's a header or background image.
2010-05-26 02:42:15 +00:00
*
2010-05-24 21:26:49 +00:00
* If true it removes the theme modification which would be pointing at the deleted
2015-07-15 16:28:25 +00:00
* attachment.
2010-05-24 19:42:43 +00:00
*
2010-05-24 21:26:49 +00:00
* @access private
2010-05-24 19:42:43 +00:00
* @since 3.0.0
2015-07-15 16:28:25 +00:00
* @since 4.3.0 Also removes `header_image_data`.
2016-03-10 05:37:27 +00:00
* @since 4.5.0 Also removes custom logo theme mods.
2015-07-15 16:28:25 +00:00
*
* @param int $id The attachment id.
2010-05-24 19:42:43 +00:00
*/
function _delete_attachment_theme_mod( $id ) {
$attachment_image = wp_get_attachment_url( $id );
2015-07-15 16:28:25 +00:00
$header_image = get_header_image();
2010-05-24 19:42:43 +00:00
$background_image = get_background_image();
2016-03-10 05:37:27 +00:00
$custom_logo_id = get_theme_mod( 'custom_logo' );
if ( $custom_logo_id && $custom_logo_id == $id ) {
remove_theme_mod( 'custom_logo' );
remove_theme_mod( 'header_text' );
}
2010-05-26 02:42:15 +00:00
2015-07-15 16:28:25 +00:00
if ( $header_image && $header_image == $attachment_image ) {
2010-05-24 19:42:43 +00:00
remove_theme_mod( 'header_image' );
2015-07-15 16:28:25 +00:00
remove_theme_mod( 'header_image_data' );
}
2010-05-24 19:42:43 +00:00
2015-07-15 16:28:25 +00:00
if ( $background_image && $background_image == $attachment_image ) {
2010-05-24 19:42:43 +00:00
remove_theme_mod( 'background_image' );
2015-07-15 16:28:25 +00:00
}
2010-05-24 19:42:43 +00:00
}
2011-09-08 20:07:15 +00:00
/**
2016-05-23 19:02:28 +00:00
* Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load.
*
* See {@see 'after_switch_theme'}.
2011-09-08 20:07:15 +00:00
*
2012-01-04 19:03:33 +00:00
* @since 3.3.0
2011-09-08 20:59:41 +00:00
*/
2011-09-08 20:07:15 +00:00
function check_theme_switched() {
2012-03-08 21:22:24 +00:00
if ( $stylesheet = get_option( 'theme_switched' ) ) {
$old_theme = wp_get_theme( $stylesheet );
2012-03-30 15:13:12 +00:00
2014-04-14 22:46:16 +00:00
// Prevent retrieve_widgets() from running since Customizer already called it up front
if ( get_option( 'theme_switched_via_customizer' ) ) {
remove_action( 'after_switch_theme', '_wp_sidebars_changed' );
update_option( 'theme_switched_via_customizer', false );
}
2013-12-01 17:24:11 +00:00
if ( $old_theme->exists() ) {
/**
* Fires on the first WP load after a theme switch if the old theme still exists.
*
* This action fires multiple times and the parameters differs
* according to the context, if the old theme exists or not.
* If the old theme is missing, the parameter will be the slug
* of the old theme.
*
* @since 3.3.0
*
* @param string $old_name Old theme name.
* @param WP_Theme $old_theme WP_Theme instance of the old theme.
*/
do_action( 'after_switch_theme', $old_theme->get( 'Name' ), $old_theme );
} else {
/** This action is documented in wp-includes/theme.php */
2012-03-30 15:13:12 +00:00
do_action( 'after_switch_theme', $stylesheet );
2013-12-01 17:24:11 +00:00
}
2015-09-10 23:50:24 +00:00
flush_rewrite_rules();
2012-03-30 15:13:12 +00:00
2011-09-08 20:07:15 +00:00
update_option( 'theme_switched', false );
}
}
2012-02-25 04:12:43 +00:00
2012-04-10 02:25:03 +00:00
/**
2012-05-23 17:56:42 +00:00
* Includes and instantiates the WP_Customize_Manager class.
2012-04-10 02:25:03 +00:00
*
2015-09-25 19:36:25 +00:00
* Loads the Customizer at plugins_loaded when accessing the customize.php admin
2016-10-18 20:05:31 +00:00
* page or when any request includes a wp_customize=on param or a customize_changeset
* param (a UUID). This param is a signal for whether to bootstrap the Customizer when
* WordPress is loading, especially in the Customizer preview
2015-09-25 19:36:25 +00:00
* or when making Customizer Ajax requests for widgets or menus.
2012-04-10 02:25:03 +00:00
*
* @since 3.4.0
2015-05-27 22:21:25 +00:00
*
* @global WP_Customize_Manager $wp_customize
2012-04-10 02:25:03 +00:00
*/
function _wp_customize_include() {
2016-10-18 20:05:31 +00:00
$is_customize_admin_page = ( is_admin() && 'customize.php' == basename( $_SERVER['PHP_SELF'] ) );
$should_include = (
$is_customize_admin_page
||
( isset( $_REQUEST['wp_customize'] ) && 'on' == $_REQUEST['wp_customize'] )
||
( ! empty( $_GET['customize_changeset_uuid'] ) || ! empty( $_POST['customize_changeset_uuid'] ) )
);
if ( ! $should_include ) {
2012-02-25 04:12:43 +00:00
return;
2015-09-25 19:36:25 +00:00
}
2012-02-25 04:12:43 +00:00
2016-10-18 20:05:31 +00:00
/*
* Note that wp_unslash() is not being used on the input vars because it is
* called before wp_magic_quotes() gets called. Besides this fact, none of
* the values should contain any characters needing slashes anyway.
*/
$keys = array( 'changeset_uuid', 'customize_changeset_uuid', 'customize_theme', 'theme', 'customize_messenger_channel' );
$input_vars = array_merge(
wp_array_slice_assoc( $_GET, $keys ),
wp_array_slice_assoc( $_POST, $keys )
);
$theme = null;
$changeset_uuid = null;
$messenger_channel = null;
if ( $is_customize_admin_page && isset( $input_vars['changeset_uuid'] ) ) {
$changeset_uuid = sanitize_key( $input_vars['changeset_uuid'] );
} elseif ( ! empty( $input_vars['customize_changeset_uuid'] ) ) {
$changeset_uuid = sanitize_key( $input_vars['customize_changeset_uuid'] );
}
// Note that theme will be sanitized via WP_Theme.
if ( $is_customize_admin_page && isset( $input_vars['theme'] ) ) {
$theme = $input_vars['theme'];
} elseif ( isset( $input_vars['customize_theme'] ) ) {
$theme = $input_vars['customize_theme'];
}
if ( isset( $input_vars['customize_messenger_channel'] ) ) {
$messenger_channel = sanitize_key( $input_vars['customize_messenger_channel'] );
}
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
$GLOBALS['wp_customize'] = new WP_Customize_Manager( compact( 'changeset_uuid', 'theme', 'messenger_channel' ) );
}
/**
* Publish a snapshot's changes.
*
* @param string $new_status New post status.
* @param string $old_status Old post status.
* @param WP_Post $changeset_post Changeset post object.
*/
function _wp_customize_publish_changeset( $new_status, $old_status, $changeset_post ) {
2016-11-09 05:45:32 +00:00
global $wp_customize, $wpdb;
2016-10-18 20:05:31 +00:00
$is_publishing_changeset = (
'customize_changeset' === $changeset_post->post_type
&&
'publish' === $new_status
&&
'publish' !== $old_status
);
if ( ! $is_publishing_changeset ) {
return;
}
if ( empty( $wp_customize ) ) {
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
2016-11-09 07:03:30 +00:00
$wp_customize = new WP_Customize_Manager( array( 'changeset_uuid' => $changeset_post->post_name ) );
2016-10-18 20:05:31 +00:00
}
if ( ! did_action( 'customize_register' ) ) {
/*
* When running from CLI or Cron, the customize_register action will need
* to be triggered in order for core, themes, and plugins to register their
* settings. Normally core will add_action( 'customize_register' ) at
* priority 10 to register the core settings, and if any themes/plugins
* also add_action( 'customize_register' ) at the same priority, they
* will have a $wp_customize with those settings registered since they
* call add_action() afterward, normally. However, when manually doing
* the customize_register action after the setup_theme, then the order
* will be reversed for two actions added at priority 10, resulting in
* the core settings no longer being available as expected to themes/plugins.
* So the following manually calls the method that registers the core
* settings up front before doing the action.
*/
remove_action( 'customize_register', array( $wp_customize, 'register_controls' ) );
$wp_customize->register_controls();
/** This filter is documented in /wp-includes/class-wp-customize-manager.php */
do_action( 'customize_register', $wp_customize );
}
$wp_customize->_publish_changeset_values( $changeset_post->ID ) ;
/*
* Trash the changeset post if revisions are not enabled. Unpublished
* changesets by default get garbage collected due to the auto-draft status.
* When a changeset post is published, however, it would no longer get cleaned
* out. Ths is a problem when the changeset posts are never displayed anywhere,
* since they would just be endlessly piling up. So here we use the revisions
* feature to indicate whether or not a published changeset should get trashed
* and thus garbage collected.
*/
if ( ! wp_revisions_enabled( $changeset_post ) ) {
2016-11-09 05:45:32 +00:00
$post = $changeset_post;
$post_id = $changeset_post->ID;
/*
* The following re-formulates the logic from wp_trash_post() as done in
* wp_publish_post(). The reason for bypassing wp_trash_post() is that it
* will mutate the the post_content and the post_name when they should be
* untouched.
*/
if ( ! EMPTY_TRASH_DAYS ) {
wp_delete_post( $post_id, true );
} else {
/** This action is documented in wp-includes/post.php */
do_action( 'wp_trash_post', $post_id );
add_post_meta( $post_id, '_wp_trash_meta_status', $post->post_status );
add_post_meta( $post_id, '_wp_trash_meta_time', time() );
$old_status = $post->post_status;
$new_status = 'trash';
$wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'ID' => $post->ID ) );
clean_post_cache( $post->ID );
$post->post_status = $new_status;
wp_transition_post_status( $new_status, $old_status, $post );
/** This action is documented in wp-includes/post.php */
do_action( 'edit_post', $post->ID, $post );
/** This action is documented in wp-includes/post.php */
do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
/** This action is documented in wp-includes/post.php */
do_action( 'save_post', $post->ID, $post, true );
/** This action is documented in wp-includes/post.php */
do_action( 'wp_insert_post', $post->ID, $post, true );
/** This action is documented in wp-includes/post.php */
do_action( 'trashed_post', $post_id );
}
2016-10-18 20:05:31 +00:00
}
}
/**
* Filters changeset post data upon insert to ensure post_name is intact.
*
* This is needed to prevent the post_name from being dropped when the post is
* transitioned into pending status by a contributor.
*
* @since 4.7.0
* @see wp_insert_post()
*
* @param array $post_data An array of slashed post data.
* @param array $supplied_post_data An array of sanitized, but otherwise unmodified post data.
* @returns array Filtered data.
*/
function _wp_customize_changeset_filter_insert_post_data( $post_data, $supplied_post_data ) {
if ( isset( $post_data['post_type'] ) && 'customize_changeset' === $post_data['post_type'] ) {
// Prevent post_name from being dropped, such as when contributor saves a changeset post as pending.
if ( empty( $post_data['post_name'] ) && ! empty( $supplied_post_data['post_name'] ) ) {
$post_data['post_name'] = $supplied_post_data['post_name'];
}
}
return $post_data;
2012-02-25 04:12:43 +00:00
}
2012-04-10 02:25:03 +00:00
/**
2012-05-24 21:13:21 +00:00
* Adds settings for the customize-loader script.
2012-04-10 02:25:03 +00:00
*
* @since 3.4.0
*/
2012-05-24 21:13:21 +00:00
function _wp_customize_loader_settings() {
$admin_origin = parse_url( admin_url() );
$home_origin = parse_url( home_url() );
$cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
2012-06-06 21:45:17 +00:00
$browser = array(
'mobile' => wp_is_mobile(),
'ios' => wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] ),
);
2012-05-24 21:13:21 +00:00
$settings = array(
2012-05-24 22:45:27 +00:00
'url' => esc_url( admin_url( 'customize.php' ) ),
2012-05-24 21:13:21 +00:00
'isCrossDomain' => $cross_domain,
2012-06-06 21:45:17 +00:00
'browser' => $browser,
2014-07-08 17:04:15 +00:00
'l10n' => array(
2015-03-10 21:20:26 +00:00
'saveAlert' => __( 'The changes you made will be lost if you navigate away from this page.' ),
'mainIframeTitle' => __( 'Customizer' ),
2014-07-08 17:04:15 +00:00
),
2012-05-24 21:13:21 +00:00
);
2014-10-28 18:35:19 +00:00
$script = 'var _wpCustomizeLoaderSettings = ' . wp_json_encode( $settings ) . ';';
2012-05-24 21:13:21 +00:00
2015-05-27 22:21:25 +00:00
$wp_scripts = wp_scripts();
2012-05-24 21:13:21 +00:00
$data = $wp_scripts->get_data( 'customize-loader', 'data' );
if ( $data )
$script = "$data\n$script";
$wp_scripts->add_data( 'customize-loader', 'data', $script );
2012-04-10 02:25:03 +00:00
}
/**
2014-10-15 17:21:19 +00:00
* Returns a URL to load the Customizer.
2012-04-10 02:25:03 +00:00
*
* @since 3.4.0
2012-05-26 15:32:05 +00:00
*
* @param string $stylesheet Optional. Theme to customize. Defaults to current theme.
2015-05-27 22:21:25 +00:00
* The theme's stylesheet will be urlencoded if necessary.
* @return string
2012-04-10 02:25:03 +00:00
*/
2012-05-26 15:32:05 +00:00
function wp_customize_url( $stylesheet = null ) {
$url = admin_url( 'customize.php' );
if ( $stylesheet )
2012-09-03 23:58:30 +00:00
$url .= '?theme=' . urlencode( $stylesheet );
2012-05-26 15:32:05 +00:00
return esc_url( $url );
2012-05-24 21:13:21 +00:00
}
2012-05-25 00:15:12 +00:00
/**
2014-10-15 17:21:19 +00:00
* Prints a script to check whether or not the Customizer is supported,
2012-05-25 00:15:12 +00:00
* and apply either the no-customize-support or customize-support class
* to the body.
*
* This function MUST be called inside the body tag.
*
* Ideally, call this function immediately after the body tag is opened.
* This prevents a flash of unstyled content.
*
* It is also recommended that you add the "no-customize-support" class
* to the body tag by default.
*
* @since 3.4.0
2016-09-25 04:35:32 +00:00
* @since 4.7.0 Support for IE8 and below is explicitly removed via conditional comments.
2012-05-25 00:15:12 +00:00
*/
function wp_customize_support_script() {
$admin_origin = parse_url( admin_url() );
$home_origin = parse_url( home_url() );
$cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
?>
2016-09-25 04:35:32 +00:00
<!--[if lte IE 8]>
<script type="text/javascript">
document.body.className = document.body.className.replace( /(^|\s)(no-)?customize-support(?=\s|$)/, '' ) + ' no-customize-support';
</script>
<![endif]-->
<!--[if gte IE 9]><!-->
<script type="text/javascript">
(function() {
var request, b = document.body, c = 'className', cs = 'customize-support', rcs = new RegExp('(^|\\s+)(no-)?'+cs+'(\\s+|$)');
<?php if ( $cross_domain ) : ?>
request = (function(){ var xhr = new XMLHttpRequest(); return ('withCredentials' in xhr); })();
<?php else : ?>
request = true;
<?php endif; ?>
b[c] = b[c].replace( rcs, ' ' );
// The customizer requires postMessage and CORS (if the site is cross domain)
b[c] += ( window.postMessage && request ? ' ' : ' no-' ) + cs;
}());
</script>
<!--<![endif]-->
2012-05-25 00:15:12 +00:00
<?php
2014-04-14 22:46:16 +00:00
}
2014-07-04 16:17:15 +00:00
/**
* Whether the site is being previewed in the Customizer.
*
* @since 4.0.0
*
2014-07-14 01:02:15 +00:00
* @global WP_Customize_Manager $wp_customize Customizer instance.
*
2014-07-04 16:17:15 +00:00
* @return bool True if the site is being previewed in the Customizer, false otherwise.
*/
function is_customize_preview() {
global $wp_customize;
2015-01-16 01:06:24 +00:00
return ( $wp_customize instanceof WP_Customize_Manager ) && $wp_customize->is_preview();
2014-07-04 16:17:15 +00:00
}