2006-04-18 06:44:33 +02:00
< ? php
2008-08-12 22:18:05 +02:00
/**
2008-09-01 07:44:16 +02:00
* Theme , template , and stylesheet functions .
*
2008-08-12 22:18:05 +02:00
* @ package WordPress
2012-02-28 02:49:49 +01:00
* @ subpackage Theme
2008-09-01 07:44:16 +02:00
*/
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
/**
* Returns an array of WP_Theme objects based on the arguments .
*
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
* Despite advances over get_themes (), this function is quite expensive , and grows
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
* linearly with additional themes . Stick to wp_get_theme () if possible .
*
* @ since 3.4 . 0
*
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01: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 .
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
* @ return Array of WP_Theme objects .
*/
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 );
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01: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 08:46:39 +01:00
$root_of_current_theme = get_raw_theme_root ( $current_theme );
if ( ! in_array ( $root_of_current_theme , $wp_theme_directories ) )
2012-03-08 19:00:11 +01:00
$root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme ;
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
$theme_directories [ $current_theme ][ 'theme_root' ] = $root_of_current_theme ;
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
}
}
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
if ( empty ( $theme_directories ) )
2012-03-08 08:46:39 +01:00
return array ();
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
if ( is_multisite () && null !== $args [ 'allowed' ] ) {
2012-03-08 08:46:39 +01:00
$allowed = $args [ 'allowed' ];
if ( 'network' === $allowed )
2012-03-21 18:32:28 +01:00
$theme_directories = array_intersect_key ( $theme_directories , WP_Theme :: get_allowed_on_network () );
2012-03-08 08:46:39 +01: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 18:32:28 +01:00
static $_themes = array ();
2012-03-08 08:46:39 +01:00
foreach ( $theme_directories as $theme => $theme_root ) {
2012-04-05 22:38:42 +02:00
if ( isset ( $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ] ) )
$themes [ $theme ] = $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ];
2012-03-08 08:46:39 +01:00
else
2012-04-05 22:38:42 +02:00
$themes [ $theme ] = $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ] = new WP_Theme ( $theme , $theme_root [ 'theme_root' ] );
2012-03-08 08:46:39 +01:00
}
if ( null !== $args [ 'errors' ] ) {
foreach ( $themes as $theme => $wp_theme ) {
if ( $wp_theme -> errors () != $args [ 'errors' ] )
unset ( $themes [ $theme ] );
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
}
}
return $themes ;
}
/**
* Gets a WP_Theme object for a theme .
*
* @ since 3.4 . 0
*
* @ param string $stylesheet Directory name for the theme . Optional . Defaults to current theme .
* @ param string $theme_root Absolute path of the theme root to look in . Optional . If not specified , get_raw_theme_root ()
* is used to calculate the theme root for the $stylesheet provided ( or current theme ) .
2012-04-05 03:05:49 +02:00
* @ return WP_Theme Theme object . Be sure to check the object 's exists() method if you need to confirm the theme' s existence .
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01: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 04:59:48 +02:00
if ( false === $theme_root )
2012-06-12 17:57:11 +02:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2012-04-19 05:33:42 +02:00
elseif ( ! in_array ( $theme_root , ( array ) $wp_theme_directories ) )
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
$theme_root = WP_CONTENT_DIR . $theme_root ;
}
2012-04-05 03:05:49 +02:00
return new WP_Theme ( $stylesheet , $theme_root );
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 22:24:44 +01:00
}
2012-06-14 16:24:25 +02:00
/**
* Clears the cache held by get_theme_roots () and WP_Theme .
*
* @ since 3.5 . 0
2013-09-06 03:33:09 +02:00
* @ param bool $clear_update_cache Whether to clear the Theme updates cache
2012-06-14 16:24:25 +02:00
*/
2013-09-06 03:33:09 +02:00
function wp_clean_themes_cache ( $clear_update_cache = true ) {
if ( $clear_update_cache )
delete_site_transient ( 'update_themes' );
2012-06-14 16:24:25 +02:00
search_theme_directories ( true );
foreach ( wp_get_themes ( array ( 'errors' => null ) ) as $theme )
$theme -> cache_delete ();
}
2010-05-03 22:56:57 +02: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 20:07:16 +02:00
return ( TEMPLATEPATH !== STYLESHEETPATH );
2010-05-03 22:56:57 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve name of the current stylesheet .
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* The theme name that the administrator has currently set the front end theme
2008-09-01 07:44:16 +02:00
* as .
*
2014-07-23 07:11:16 +02:00
* For all intents and purposes , the template name and the stylesheet name are
2008-09-24 07:24:33 +02:00
* going to be the same for most cases .
*
2008-09-01 07:44:16 +02:00
* @ since 1.5 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string Stylesheet name .
2006-04-18 06:44:33 +02:00
*/
function get_stylesheet () {
2013-12-01 18:24:11 +01:00
/**
* Filter the name of current stylesheet .
*
* @ since 1.5 . 0
*
* @ param string $stylesheet Name of the current stylesheet .
*/
return apply_filters ( 'stylesheet' , get_option ( 'stylesheet' ) );
2006-04-18 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve stylesheet directory path for current theme .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string Path to current theme directory .
2008-09-01 07:44:16 +02:00
*/
2006-04-18 06:44:33 +02:00
function get_stylesheet_directory () {
$stylesheet = get_stylesheet ();
2009-10-13 21:06:35 +02:00
$theme_root = get_theme_root ( $stylesheet );
$stylesheet_dir = " $theme_root / $stylesheet " ;
2013-12-01 18:24:11 +01:00
/**
* Filter the stylesheet directory path for current theme .
*
* @ since 1.5 . 0
*
* @ param string $stylesheet_dir Absolute path to the current them .
* @ param string $stylesheet Directory name of the current theme .
* @ param string $theme_root Absolute path to themes directory .
*/
2009-10-13 21:06:35 +02:00
return apply_filters ( 'stylesheet_directory' , $stylesheet_dir , $stylesheet , $theme_root );
2006-04-18 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve stylesheet directory URI .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string
2008-09-01 07:44:16 +02:00
*/
2006-04-18 06:44:33 +02:00
function get_stylesheet_directory_uri () {
2014-03-25 14:07:14 +01:00
$stylesheet = str_replace ( '%2F' , '/' , rawurlencode ( get_stylesheet () ) );
2009-10-13 21:06:35 +02:00
$ theme_root_uri = get_theme_root_uri ( $stylesheet );
$stylesheet_dir_uri = " $theme_root_uri / $stylesheet " ;
2013-12-01 18:24:11 +01:00
/**
* Filter the stylesheet directory URI .
*
* @ 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 21:06:35 +02:00
return apply_filters ( 'stylesheet_directory_uri' , $stylesheet_dir_uri , $stylesheet , $theme_root_uri );
2006-04-18 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve URI of current theme stylesheet .
2008-09-01 07:44:16 +02:00
*
2008-12-09 19:03:31 +01:00
* The stylesheet file name is 'style.css' which is appended to { @ link
2008-09-24 07:24:33 +02:00
* get_stylesheet_directory_uri () stylesheet directory URI } path .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string
2008-09-01 07:44:16 +02:00
*/
2006-04-18 06:44:33 +02:00
function get_stylesheet_uri () {
$stylesheet_dir_uri = get_stylesheet_directory_uri ();
2011-05-23 00:30:05 +02:00
$stylesheet_uri = $stylesheet_dir_uri . '/style.css' ;
2013-12-01 18:24:11 +01:00
/**
* Filter the URI of the current theme stylesheet .
*
* @ 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 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve localized stylesheet URI .
2008-09-01 07:44:16 +02:00
*
2008-09-25 16:12:58 +02: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
* the 'stylesheet_directory_uri' filter or the 'locale_stylesheet_uri' filter .
* If you want to change the location of the stylesheet files for the entire
* WordPress workflow , then change the former . If you just have the locale in a
* separate folder , then change the latter .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string
2008-09-01 07:44:16 +02:00
*/
2006-09-19 01:40:19 +02: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 12:33:44 +02:00
elseif ( ! empty ( $wp_locale -> text_direction ) && file_exists ( " $dir / { $wp_locale -> text_direction } .css " ) )
2006-09-19 01:40:19 +02:00
$stylesheet_uri = " $stylesheet_dir_uri / { $wp_locale -> text_direction } .css " ;
else
$stylesheet_uri = '' ;
2013-12-01 18:24:11 +01:00
/**
* Filter the localized stylesheet URI .
*
* @ 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-19 01:40:19 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve name of the current theme .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
2008-09-24 07:24:33 +02:00
* @ uses apply_filters () Calls 'template' filter on template option .
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* @ return string Template name .
2008-09-01 07:44:16 +02:00
*/
2006-04-18 06:44:33 +02:00
function get_template () {
2013-12-01 18:24:11 +01:00
/**
* Filter the name of the current theme .
*
* @ since 1.5 . 0
*
* @ param string $template Current theme ' s directory name .
*/
return apply_filters ( 'template' , get_option ( 'template' ) );
2006-04-18 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve current theme directory .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string Template directory path .
2008-09-01 07:44:16 +02:00
*/
2006-04-18 06:44:33 +02:00
function get_template_directory () {
$template = get_template ();
2009-10-13 21:06:35 +02:00
$theme_root = get_theme_root ( $template );
$template_dir = " $theme_root / $template " ;
2009-10-15 22:26:21 +02:00
2013-12-01 18:24:11 +01:00
/**
* Filter the current theme directory path .
*
* @ 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 21:06:35 +02:00
return apply_filters ( 'template_directory' , $template_dir , $template , $theme_root );
2006-04-18 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve theme directory URI .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string Template directory URI .
2008-09-01 07:44:16 +02:00
*/
2006-04-18 06:44:33 +02:00
function get_template_directory_uri () {
2014-03-25 14:07:14 +01:00
$template = str_replace ( '%2F' , '/' , rawurlencode ( get_template () ) );
2009-10-13 21:06:35 +02:00
$theme_root_uri = get_theme_root_uri ( $template );
$template_dir_uri = " $theme_root_uri / $template " ;
2009-10-15 22:26:21 +02:00
2013-12-01 18:24:11 +01:00
/**
* Filter the current theme directory URI .
*
* @ 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 21:06:35 +02:00
return apply_filters ( 'template_directory_uri' , $template_dir_uri , $template , $theme_root_uri );
2006-04-18 06:44:33 +02:00
}
2009-10-13 21:06:35 +02:00
/**
* Retrieve theme roots .
*
* @ since 2.9 . 0
*
2011-09-05 21:08:15 +02: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 21:06:35 +02:00
*/
function get_theme_roots () {
2010-09-21 21:41:35 +02:00
global $wp_theme_directories ;
2010-11-17 17:11:44 +01:00
if ( count ( $wp_theme_directories ) <= 1 )
2012-02-28 17:22:26 +01:00
return '/themes' ;
2010-09-21 21:41:35 +02:00
2009-10-29 22:53:57 +01:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 21:06:35 +02:00
if ( false === $theme_roots ) {
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
search_theme_directories ( true ); // Regenerate the transient.
2012-02-28 21:08:08 +01:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 21:06:35 +02:00
}
return $theme_roots ;
}
/**
2009-10-15 22:45:32 +02:00
* Register a directory that contains themes .
2009-10-13 21:06:35 +02:00
*
* @ since 2.9 . 0
*
2009-10-15 22:45:32 +02:00
* @ param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR
2009-10-13 21:06:35 +02:00
* @ return bool
*/
2012-02-28 19:02:21 +01:00
function register_theme_directory ( $directory ) {
2009-10-13 21:06:35 +02:00
global $wp_theme_directories ;
2009-12-08 22:29:12 +01:00
2012-02-28 19:02:21 +01: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-20 01:07:15 +02:00
if ( ! file_exists ( $directory ) ) {
2012-02-28 19:02:21 +01:00
return false ;
2014-07-20 01:07:15 +02:00
}
}
if ( ! is_array ( $wp_theme_directories ) ) {
$wp_theme_directories = array ();
2012-02-28 19:02:21 +01:00
}
2012-02-28 17:22:26 +01:00
2014-07-20 01:07:15 +02:00
$untrailed = untrailingslashit ( $directory );
if ( ! empty ( $untrailed ) && ! in_array ( $untrailed , $wp_theme_directories ) ) {
$wp_theme_directories [] = $untrailed ;
}
2009-10-15 22:26:21 +02:00
2009-10-13 21:06:35 +02:00
return true ;
}
/**
* Search all registered theme directories for complete and valid themes .
*
* @ since 2.9 . 0
*
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
* @ param bool $force Optional . Whether to force a new directory scan . Defaults to false .
2009-10-13 21:06:35 +02:00
* @ return array Valid themes found
*/
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
function search_theme_directories ( $force = false ) {
2012-02-28 21:05:00 +01:00
global $wp_theme_directories ;
2009-10-13 21:06:35 +02:00
if ( empty ( $wp_theme_directories ) )
return false ;
2012-02-28 21:05:00 +01:00
static $found_themes ;
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 16:39:21 +01:00
if ( ! $force && isset ( $found_themes ) )
2012-02-28 21:05:00 +01:00
return $found_themes ;
2009-10-13 21:06:35 +02:00
2012-02-28 21:05:00 +01:00
$found_themes = array ();
2009-10-15 22:26:21 +02:00
2012-04-05 22:38:42 +02:00
$wp_theme_directories = ( array ) $wp_theme_directories ;
2012-03-06 02:50:54 +01: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 03:46:45 +02:00
// to use in get_theme_root().
2012-03-06 02:50:54 +01: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 18:24:11 +01:00
/**
* Filter whether to get the cache of the registered theme directories .
*
* @ 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 21:05:00 +01: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 15:22:54 +02:00
// A cached theme root is no longer around, so skip it.
if ( ! isset ( $relative_theme_roots [ $theme_root ] ) )
continue ;
2012-02-28 21:05:00 +01:00
$found_themes [ $theme_dir ] = array (
'theme_file' => $theme_dir . '/style.css' ,
2012-03-06 02:50:54 +01:00
'theme_root' => $relative_theme_roots [ $theme_root ], // Convert relative to absolute.
2012-02-28 21:05:00 +01:00
);
}
return $found_themes ;
}
if ( ! is_int ( $cache_expiration ) )
2012-03-30 16:39:05 +02:00
$cache_expiration = 1800 ; // half hour
2012-02-28 21:05:00 +01:00
} else {
2012-03-30 16:39:05 +02:00
$cache_expiration = 1800 ; // half hour
2012-02-28 21:05:00 +01:00
}
2009-10-13 21:06:35 +02:00
2012-02-28 21:05:00 +01:00
/* Loop the registered theme directories and extract all themes */
foreach ( $wp_theme_directories as $theme_root ) {
2009-10-13 21:06:35 +02:00
2012-02-28 21:05:00 +01:00
// Start with directories in the root of the current theme directory.
$dirs = @ scandir ( $theme_root );
2013-08-05 23:40:28 +02:00
if ( ! $dirs ) {
trigger_error ( " $theme_root is not readable " , E_USER_NOTICE );
continue ;
}
2012-02-28 21:05:00 +01: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 23:40:28 +02:00
if ( ! $sub_dirs ) {
trigger_error ( " $theme_root / $dir is not readable " , E_USER_NOTICE );
continue ;
}
2012-02-28 21:05:00 +01:00
foreach ( $sub_dirs as $sub_dir ) {
2012-06-26 05:36:03 +02:00
if ( ! is_dir ( $theme_root . '/' . $dir . '/' . $sub_dir ) || $dir [ 0 ] == '.' || $dir == 'CVS' )
2012-02-28 21:05:00 +01: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 21:06:35 +02:00
}
2012-02-28 21:05:00 +01: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 21:06:35 +02:00
}
}
}
2012-02-28 21:05:00 +01:00
asort ( $found_themes );
$theme_roots = array ();
2012-03-06 02:50:54 +01:00
$relative_theme_roots = array_flip ( $relative_theme_roots );
2012-02-28 21:05:00 +01:00
foreach ( $found_themes as $theme_dir => $theme_data ) {
2012-03-06 02:50:54 +01:00
$theme_roots [ $theme_dir ] = $relative_theme_roots [ $theme_data [ 'theme_root' ] ]; // Convert absolute to relative.
2012-02-28 21:05:00 +01:00
}
if ( $theme_roots != get_site_transient ( 'theme_roots' ) )
set_site_transient ( 'theme_roots' , $theme_roots , $cache_expiration );
return $found_themes ;
2009-10-13 21:06:35 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve path to themes directory .
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* Does not have trailing slash .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2010-09-07 13:21:11 +02:00
* @ param string $stylesheet_or_template The stylesheet or template name of the theme
2008-09-24 07:24:33 +02:00
* @ return string Theme path .
2008-09-01 07:44:16 +02:00
*/
2009-10-13 21:06:35 +02:00
function get_theme_root ( $stylesheet_or_template = false ) {
2012-02-28 19:02:21 +01: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 18:30:09 +01:00
if ( ! in_array ( $theme_root , ( array ) $wp_theme_directories ) )
2012-02-28 17:22:26 +01:00
$theme_root = WP_CONTENT_DIR . $theme_root ;
} else {
2009-10-13 21:06:35 +02:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2012-02-28 17:22:26 +01:00
}
2009-12-08 22:29:12 +01:00
2013-12-01 18:24:11 +01:00
/**
* Filter the absolute path to the themes directory .
*
* @ since 1.5 . 0
*
* @ param string $theme_root Absolute path to themes directory .
*/
2009-10-13 21:06:35 +02:00
return apply_filters ( 'theme_root' , $theme_root );
2006-04-18 06:44:33 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve URI for themes directory .
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* Does not have trailing slash .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
*
2012-03-08 19:18:10 +01:00
* @ param string $stylesheet_or_template Optional . The stylesheet or template name of the theme .
* 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 07:24:33 +02:00
* @ return string Themes URI .
2008-09-01 07:44:16 +02:00
*/
2012-03-08 19:18:10 +01:00
function get_theme_root_uri ( $stylesheet_or_template = false , $theme_root = false ) {
2012-02-28 19:02:21 +01:00
global $wp_theme_directories ;
2012-03-08 19:18:10 +01: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 18:30:09 +01:00
if ( in_array ( $theme_root , ( array ) $wp_theme_directories ) ) {
2012-02-28 19:02:21 +01: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 17:22:26 +01:00
$theme_root_uri = content_url ( $theme_root );
2012-02-28 19:02:21 +01:00
}
2010-09-21 21:41:35 +02:00
} else {
2009-10-13 21:06:35 +02:00
$theme_root_uri = content_url ( 'themes' );
2010-09-21 21:41:35 +02:00
}
2009-10-13 21:06:35 +02:00
2013-12-01 18:24:11 +01:00
/**
* Filter the URI for themes directory .
*
* @ 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 06:44:33 +02:00
}
2010-09-21 21:41:35 +02:00
/**
2012-02-28 17:22:26 +01:00
* Get the raw theme root relative to the content directory with no filters applied .
2010-09-21 21:41:35 +02:00
*
* @ since 3.1 . 0
*
* @ param string $stylesheet_or_template The stylesheet or template name of the theme
2012-02-28 20:59:53 +01:00
* @ param bool $skip_cache Optional . Whether to skip the cache . Defaults to false , meaning the cache is used .
2010-09-21 21:41:35 +02:00
* @ return string Theme root
*/
2012-02-28 20:59:53 +01:00
function get_raw_theme_root ( $stylesheet_or_template , $skip_cache = false ) {
2010-09-21 21:41:35 +02:00
global $wp_theme_directories ;
2010-11-17 17:11:44 +01:00
if ( count ( $wp_theme_directories ) <= 1 )
2012-02-28 17:22:26 +01:00
return '/themes' ;
2010-09-21 21:41:35 +02:00
$theme_root = false ;
// If requesting the root for the current theme, consult options to avoid calling get_theme_roots()
2012-02-28 20:59:53 +01:00
if ( ! $skip_cache ) {
2010-11-17 17:11:44 +01: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 21:41:35 +02: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 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Display localized stylesheet link element .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*/
2006-09-19 01:40:19 +02: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-01 07:44:16 +02:00
/**
2008-09-25 16:12:58 +02:00
* Start preview theme output buffer .
2008-09-01 07:44:16 +02:00
*
2013-05-01 03:46:45 +02:00
* Will only perform task if the user has permissions and template and preview
2008-09-25 16:12:58 +02:00
* query variables exist .
2008-09-01 07:44:16 +02:00
*
2009-09-22 09:16:19 +02:00
* @ since 2.6 . 0
2008-09-01 07:44:16 +02:00
*/
2008-05-20 19:19:33 +02:00
function preview_theme () {
if ( ! ( isset ( $_GET [ 'template' ]) && isset ( $_GET [ 'preview' ])) )
return ;
if ( ! current_user_can ( 'switch_themes' ) )
return ;
2010-12-17 09:32:53 +01:00
// Admin Thickbox requests
if ( isset ( $_GET [ 'preview_iframe' ] ) )
2010-12-17 09:42:37 +01:00
show_admin_bar ( false );
2009-03-20 01:30:32 +01:00
$_GET [ 'template' ] = preg_replace ( '|[^a-z0-9_./-]|i' , '' , $_GET [ 'template' ]);
2008-07-29 19:03:00 +02:00
2008-08-12 23:13:25 +02:00
if ( validate_file ( $_GET [ 'template' ]) )
2008-07-29 19:03:00 +02:00
return ;
2008-05-20 19:19:33 +02:00
2009-09-21 23:43:41 +02:00
add_filter ( 'template' , '_preview_theme_template_filter' );
2008-05-20 19:19:33 +02:00
if ( isset ( $_GET [ 'stylesheet' ]) ) {
2009-03-20 01:30:32 +01:00
$_GET [ 'stylesheet' ] = preg_replace ( '|[^a-z0-9_./-]|i' , '' , $_GET [ 'stylesheet' ]);
2008-08-12 23:13:25 +02:00
if ( validate_file ( $_GET [ 'stylesheet' ]) )
2008-07-29 19:03:00 +02:00
return ;
2009-09-21 23:43:41 +02:00
add_filter ( 'stylesheet' , '_preview_theme_stylesheet_filter' );
2008-05-20 19:19:33 +02:00
}
2010-12-17 09:42:37 +01:00
2009-05-25 01:47:49 +02:00
// Prevent theme mods to current theme being used on theme being previewed
2012-02-29 06:09:29 +01:00
add_filter ( 'pre_option_theme_mods_' . get_option ( 'stylesheet' ), '__return_empty_array' );
2009-04-23 00:32:35 +02:00
2008-05-20 19:19:33 +02:00
ob_start ( 'preview_theme_ob_filter' );
}
add_action ( 'setup_theme' , 'preview_theme' );
2009-09-21 23:43:41 +02:00
/**
* Private function to modify the current template when previewing a theme
2009-09-22 09:16:19 +02:00
*
* @ since 2.9 . 0
* @ access private
2009-09-24 19:19:13 +02:00
*
2009-09-21 23:43:41 +02:00
* @ return string
*/
function _preview_theme_template_filter () {
return isset ( $_GET [ 'template' ]) ? $_GET [ 'template' ] : '' ;
}
/**
* Private function to modify the current stylesheet when previewing a theme
2009-09-24 19:19:13 +02:00
*
2009-09-22 09:16:19 +02:00
* @ since 2.9 . 0
* @ access private
2009-09-24 19:19:13 +02:00
*
2009-09-21 23:43:41 +02:00
* @ return string
*/
function _preview_theme_stylesheet_filter () {
return isset ( $_GET [ 'stylesheet' ]) ? $_GET [ 'stylesheet' ] : '' ;
}
2008-09-25 16:12:58 +02:00
/**
* Callback function for ob_start () to capture all links in the theme .
*
2009-09-22 09:16:19 +02:00
* @ since 2.6 . 0
2008-09-25 16:12:58 +02:00
* @ access private
*
* @ param string $content
* @ return string
*/
2008-05-20 19:19:33 +02:00
function preview_theme_ob_filter ( $content ) {
return preg_replace_callback ( " |(<a.*?href=([ \" ']))(.*?)([ \" '].*?>)| " , 'preview_theme_ob_filter_callback' , $content );
}
2008-09-25 16:12:58 +02:00
/**
* Manipulates preview theme links in order to control and maintain location .
*
* Callback function for preg_replace_callback () to accept and filter matches .
*
2009-09-22 09:16:19 +02:00
* @ since 2.6 . 0
2008-09-25 16:12:58 +02:00
* @ access private
*
* @ param array $matches
* @ return string
*/
2008-05-20 19:19:33 +02:00
function preview_theme_ob_filter_callback ( $matches ) {
2008-11-15 03:20:26 +01:00
if ( strpos ( $matches [ 4 ], 'onclick' ) !== false )
2012-12-20 16:55:32 +01:00
$matches [ 4 ] = preg_replace ( '#onclick=([\'"]).*?(?<!\\\)\\1#i' , '' , $matches [ 4 ]); //Strip out any onclicks from rest of <a>. (?<!\\\) means to ignore the '" if it's escaped by \ to prevent breaking mid-attribute.
2008-05-20 19:19:33 +02:00
if (
( false !== strpos ( $matches [ 3 ], '/wp-admin/' ) )
||
2010-01-04 18:23:29 +01:00
( false !== strpos ( $matches [ 3 ], '://' ) && 0 !== strpos ( $matches [ 3 ], home_url () ) )
2008-05-20 19:19:33 +02:00
||
( false !== strpos ( $matches [ 3 ], '/feed/' ) )
||
( false !== strpos ( $matches [ 3 ], '/trackback/' ) )
)
return $matches [ 1 ] . " # $matches[2] onclick= $matches[2] return false; " . $matches [ 4 ];
2013-08-15 18:25:12 +02:00
$stylesheet = isset ( $_GET [ 'stylesheet' ] ) ? $_GET [ 'stylesheet' ] : '' ;
$template = isset ( $_GET [ 'template' ] ) ? $_GET [ 'template' ] : '' ;
$link = add_query_arg ( array ( 'preview' => 1 , 'template' => $template , 'stylesheet' => $stylesheet , 'preview_iframe' => 1 ), $matches [ 3 ] );
2008-05-20 19:19:33 +02:00
if ( 0 === strpos ( $link , 'preview=1' ) )
$link = " ? $link " ;
2009-05-05 21:43:53 +02:00
return $matches [ 1 ] . esc_attr ( $link ) . $matches [ 4 ];
2008-05-20 19:19:33 +02:00
}
2008-09-25 16:12:58 +02:00
/**
2012-06-26 07:21:04 +02:00
* Switches the theme .
*
* Accepts one argument : $stylesheet of the theme . It also accepts an additional function signature
* of two arguments : $template then $stylesheet . This is for backwards compatibility .
2008-09-25 16:12:58 +02:00
*
2010-12-01 20:24:38 +01:00
* @ since 2.5 . 0
2008-09-25 16:12:58 +02:00
*
2012-06-26 07:21:04 +02:00
* @ param string $stylesheet Stylesheet name
2008-09-25 16:12:58 +02:00
*/
2012-06-26 07:21:04 +02:00
function switch_theme ( $stylesheet ) {
2014-04-15 00:46:16 +02:00
global $wp_theme_directories , $wp_customize , $sidebars_widgets ;
2011-09-08 21:25:20 +02:00
2014-04-15 00:46:16 +02: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 21:41:35 +02:00
2012-02-29 06:09:29 +01:00
$old_theme = wp_get_theme ();
$new_theme = wp_get_theme ( $stylesheet );
2012-06-26 07:21:04 +02:00
if ( func_num_args () > 1 ) {
$template = $stylesheet ;
$stylesheet = func_get_arg ( 1 );
} else {
$template = $new_theme -> get_template ();
}
2011-09-03 00:13:55 +02:00
2012-02-29 06:09:29 +01:00
update_option ( 'template' , $template );
update_option ( 'stylesheet' , $stylesheet );
2011-09-03 00:13:55 +02:00
2012-02-29 06:09:29 +01: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 22:51:27 +01:00
} else {
delete_option ( 'template_root' );
delete_option ( 'stylesheet_root' );
2010-09-21 21:41:35 +02:00
}
2011-09-03 00:13:55 +02:00
2012-06-26 07:21:04 +02:00
$new_name = $new_theme -> get ( 'Name' );
2012-02-29 06:09:29 +01:00
update_option ( 'current_theme' , $new_name );
2011-09-03 00:13:55 +02:00
2014-04-15 00:46:16 +02:00
// Migrate from the old mods_{name} option to theme_mods_{slug}.
2012-02-29 06:09:29 +01:00
if ( is_admin () && false === get_option ( 'theme_mods_' . $stylesheet ) ) {
$default_theme_mods = ( array ) get_option ( 'mods_' . $new_name );
2010-12-15 18:39:00 +01:00
add_option ( " theme_mods_ $stylesheet " , $default_theme_mods );
2014-04-15 00:46:16 +02:00
} else {
/*
2014-10-15 19:21:19 +02:00
* Since retrieve_widgets () is called when initializing a theme in the Customizer ,
2014-04-15 00:46:16 +02:00
* we need to to remove the theme mods to avoid overwriting changes made via
2014-10-15 19:21:19 +02:00
* the Customizer when accessing wp - admin / widgets . php .
2014-04-15 00:46:16 +02:00
*/
if ( 'wp_ajax_customize_save' === current_action () ) {
remove_theme_mod ( 'sidebars_widgets' );
}
2010-12-15 18:39:00 +01:00
}
2011-09-03 00:13:55 +02:00
2012-03-08 22:22:24 +01:00
update_option ( 'theme_switched' , $old_theme -> get_stylesheet () );
2013-12-01 18:24:11 +01:00
/**
* Fires after the theme is switched .
*
* @ since 1.5 . 0
*
* @ param string $new_name Name of the new theme .
* @ param WP_Theme $new_theme WP_Theme instance of the new theme .
*/
2012-02-29 06:09:29 +01:00
do_action ( 'switch_theme' , $new_name , $new_theme );
2007-11-13 06:07:44 +01:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Checks that current theme files 'index.php' and 'style.css' exists .
2008-09-01 07:44:16 +02:00
*
2010-05-06 21:53:40 +02:00
* Does not check the default theme , which is the fallback and should always exist .
2010-04-21 19:14:25 +02:00
* Will switch theme to the fallback theme if current theme does not validate .
2012-01-05 21:50:54 +01:00
* You can use the 'validate_current_theme' filter to return false to
2008-10-06 17:29:47 +02:00
* disable this functionality .
2008-09-01 07:44:16 +02:00
*
* @ since 1.5 . 0
2010-05-06 21:53:40 +02:00
* @ see WP_DEFAULT_THEME
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* @ return bool
2008-09-01 07:44:16 +02:00
*/
2006-07-12 00:44:56 +02:00
function validate_current_theme () {
2013-12-01 18:24:11 +01:00
/**
* Filter whether to validate the current theme .
*
* @ since 2.7 . 0
*
* @ param bool true Validation flag to check the current theme .
*/
if ( defined ( 'WP_INSTALLING' ) || ! apply_filters ( 'validate_current_theme' , true ) )
2006-07-21 21:00:04 +02:00
return true ;
2010-05-06 21:53:40 +02:00
if ( get_template () != WP_DEFAULT_THEME && ! file_exists ( get_template_directory () . '/index.php' ) ) {
2012-06-26 07:21:04 +02:00
switch_theme ( WP_DEFAULT_THEME );
2006-07-12 00:44:56 +02:00
return false ;
}
2010-05-06 21:53:40 +02:00
if ( get_stylesheet () != WP_DEFAULT_THEME && ! file_exists ( get_template_directory () . '/style.css' ) ) {
2012-06-26 07:21:04 +02:00
switch_theme ( WP_DEFAULT_THEME );
2006-07-12 00:44:56 +02:00
return false ;
}
2010-12-14 20:19:47 +01:00
2010-12-14 20:17:49 +01:00
if ( is_child_theme () && ! file_exists ( get_stylesheet_directory () . '/style.css' ) ) {
2012-06-26 07:21:04 +02:00
switch_theme ( WP_DEFAULT_THEME );
2010-12-14 20:17:49 +01:00
return false ;
}
2006-07-12 00:44:56 +02:00
return true ;
}
2010-10-06 23:00:17 +02:00
/**
* Retrieve all theme modifications .
*
* @ since 3.1 . 0
*
2010-10-07 07:59:50 +02:00
* @ return array Theme modifications .
2010-10-06 23:00:17 +02:00
*/
function get_theme_mods () {
$theme_slug = get_option ( 'stylesheet' );
if ( false === ( $mods = get_option ( " theme_mods_ $theme_slug " ) ) ) {
2012-02-29 21:07:22 +01:00
$theme_name = get_option ( 'current_theme' );
if ( false === $theme_name )
$theme_name = wp_get_theme () -> get ( 'Name' );
2010-10-07 07:59:50 +02:00
$mods = get_option ( " mods_ $theme_name " ); // Deprecated location.
2010-10-06 23:00:17 +02:00
if ( is_admin () && false !== $mods ) {
update_option ( " theme_mods_ $theme_slug " , $mods );
delete_option ( " mods_ $theme_name " );
}
}
return $mods ;
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve theme modification value for the current theme .
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* If the modification name does not exist , then the $default will be passed
* through { @ link http :// php . net / sprintf sprintf ()} PHP function with the first
* string the template directory URI and the second string the stylesheet
* directory URI .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*
2008-09-24 07:24:33 +02:00
* @ param string $name Theme modification name .
* @ param bool | string $default
* @ return string
2008-09-01 07:44:16 +02:00
*/
2010-10-07 07:59:50 +02:00
function get_theme_mod ( $name , $default = false ) {
2010-10-06 23:00:17 +02:00
$mods = get_theme_mods ();
2006-10-16 08:06:18 +02:00
2013-12-01 18:24:11 +01:00
if ( isset ( $mods [ $name ] ) ) {
/**
* Filter the theme modification , or 'theme_mod' , value .
*
* The dynamic portion of the hook name , $name , refers to
* 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 08:06:18 +02:00
2012-02-03 00:35:37 +01:00
if ( is_string ( $default ) )
$default = sprintf ( $default , get_template_directory_uri (), get_stylesheet_directory_uri () );
2013-12-01 18:24:11 +01:00
/** This filter is documented in wp-includes/theme.php */
return apply_filters ( " theme_mod_ { $name } " , $default );
2006-10-16 08:06:18 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Update theme modification value for the current theme .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*
2008-09-24 07:24:33 +02:00
* @ param string $name Theme modification name .
* @ param string $value theme modification value .
2008-09-01 07:44:16 +02:00
*/
2010-10-07 07:59:50 +02:00
function set_theme_mod ( $name , $value ) {
2010-10-06 23:00:17 +02:00
$mods = get_theme_mods ();
2014-03-05 02:13:14 +01:00
$old_value = isset ( $mods [ $name ] ) ? $mods [ $name ] : false ;
2006-10-16 08:06:18 +02:00
2014-03-04 08:02:13 +01:00
/**
* Filter the theme mod value on save .
*
* The dynamic portion of the hook name , $name , refers to the key name of
* 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 .
*/
$mods [ $name ] = apply_filters ( " pre_set_theme_mod_ $name " , $value , $old_value );
2006-10-16 08:06:18 +02:00
2010-10-06 23:00:17 +02:00
$theme = get_option ( 'stylesheet' );
update_option ( " theme_mods_ $theme " , $mods );
2006-10-16 08:06:18 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Remove theme modification name from current theme list .
2008-09-01 07:44:16 +02:00
*
2008-09-24 07:24:33 +02:00
* If removing the name also removes all elements , then the entire option will
* be removed .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*
2008-09-24 07:24:33 +02:00
* @ param string $name Theme modification name .
* @ return null
2008-09-01 07:44:16 +02:00
*/
2007-01-04 00:49:34 +01:00
function remove_theme_mod ( $name ) {
2010-10-06 23:00:17 +02:00
$mods = get_theme_mods ();
2007-01-04 00:49:34 +01:00
2010-10-07 07:59:50 +02:00
if ( ! isset ( $mods [ $name ] ) )
2007-01-04 00:49:34 +01:00
return ;
2010-10-07 07:59:50 +02:00
unset ( $mods [ $name ] );
2007-01-04 00:49:34 +01:00
2010-10-07 07:59:50 +02:00
if ( empty ( $mods ) )
2007-01-04 00:49:34 +01:00
return remove_theme_mods ();
2010-10-06 23:00:17 +02:00
$theme = get_option ( 'stylesheet' );
update_option ( " theme_mods_ $theme " , $mods );
2007-01-04 00:49:34 +01:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Remove theme modifications option for current theme .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*/
2006-10-16 08:06:18 +02:00
function remove_theme_mods () {
2010-10-06 23:00:17 +02:00
delete_option ( 'theme_mods_' . get_option ( 'stylesheet' ) );
2012-02-29 21:07:22 +01: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 08:06:18 +02:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve text color for custom header .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string
2008-09-01 07:44:16 +02:00
*/
2007-01-04 00:49:34 +01:00
function get_header_textcolor () {
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
return get_theme_mod ( 'header_textcolor' , get_theme_support ( 'custom-header' , 'default-text-color' ) );
2007-01-04 00:49:34 +01:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Display text color for custom header .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*/
2007-01-04 00:49:34 +01:00
function header_textcolor () {
2007-02-27 16:24:54 +01:00
echo get_header_textcolor ();
2007-01-04 00:49:34 +01:00
}
2012-03-21 19:48:57 +01: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' ) );
2012-05-11 21:55:07 +02:00
return 'blank' != $text_color ;
2012-03-21 19:48:57 +01:00
}
2008-09-01 07:44:16 +02:00
/**
2008-09-24 07:24:33 +02:00
* Retrieve header image for custom header .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*
2008-09-24 07:24:33 +02:00
* @ return string
2008-09-01 07:44:16 +02:00
*/
2007-01-04 00:49:34 +01:00
function get_header_image () {
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$url = get_theme_mod ( 'header_image' , get_theme_support ( 'custom-header' , 'default-image' ) );
2010-12-09 18:59:35 +01:00
2011-04-29 21:45:30 +02:00
if ( 'remove-header' == $url )
return false ;
2011-04-29 01:02:16 +02:00
if ( is_random_header_image () )
$url = get_random_header_image ();
2012-08-30 15:33:00 +02:00
return esc_url_raw ( set_url_scheme ( $url ) );
2007-01-04 00:49:34 +01:00
}
2011-04-29 01:02:16 +02:00
/**
2012-02-03 00:35:37 +01:00
* Get random header image data from registered images in theme .
2011-04-29 01:02:16 +02:00
*
2012-02-03 00:35:37 +01:00
* @ since 3.4 . 0
*
* @ access private
2011-04-29 01:02:16 +02:00
*
* @ return string Path to header image
*/
2012-02-03 00:35:37 +01:00
function _get_random_header_data () {
static $_wp_random_header ;
2011-04-29 01:02:16 +02:00
2012-02-03 00:35:37 +01: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 21:09:23 +02:00
$headers = $_wp_default_headers ;
2012-02-03 00:35:37 +01:00
} else {
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
if ( current_theme_supports ( 'custom-header' , 'random-default' ) )
2012-02-03 00:35:37 +01:00
$headers = $_wp_default_headers ;
}
2011-06-22 21:09:23 +02:00
}
2011-04-29 01:02:16 +02:00
2012-02-03 00:35:37 +01:00
if ( empty ( $headers ) )
2012-02-03 14:38:03 +01:00
return new stdClass ;
2012-02-03 00:35:37 +01: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-29 01:02:16 +02:00
2012-02-03 00:35:37 +01:00
/**
* Get random header image url from registered images in theme .
*
* @ since 3.2 . 0
*
* @ return string Path to header image
*/
2011-04-29 01:02:16 +02:00
2012-02-03 00:35:37 +01:00
function get_random_header_image () {
$random_image = _get_random_header_data ();
if ( empty ( $random_image -> url ) )
return '' ;
return $random_image -> url ;
2011-04-29 01:02:16 +02:00
}
/**
* Check if random header image is in use .
*
* Always true if user expressly chooses the option in Appearance > Header .
2011-06-22 21:09:23 +02: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-29 01:02:16 +02:00
*
2011-06-11 06:40:18 +02:00
* @ since 3.2 . 0
2011-04-29 01:02:16 +02:00
*
* @ param string $type The random pool to use . any | default | uploaded
* @ return boolean
*/
function is_random_header_image ( $type = 'any' ) {
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$header_image_mod = get_theme_mod ( 'header_image' , get_theme_support ( 'custom-header' , 'default-image' ) );
2011-04-29 01:02:16 +02: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 21:09:23 +02:00
elseif ( 'default' == $type && empty ( $header_image_mod ) && '' != get_random_header_image () )
2011-04-29 21:45:30 +02:00
return true ;
2011-04-29 01:02:16 +02:00
}
return false ;
}
2008-09-01 07:44:16 +02:00
/**
2013-03-07 06:30:00 +01:00
* Display header image URL .
2008-09-01 07:44:16 +02:00
*
* @ since 2.1 . 0
*/
2007-01-04 00:49:34 +01:00
function header_image () {
2013-03-07 06:30:00 +01:00
echo esc_url ( get_header_image () );
2007-01-04 00:49:34 +01:00
}
2011-04-29 01:02:16 +02: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 16:55:15 +01:00
$url = esc_url_raw ( wp_get_attachment_url ( $header -> ID ) );
2012-02-03 00:35:37 +01:00
$header_data = wp_get_attachment_metadata ( $header -> ID );
$header_index = basename ( $url );
$header_images [ $header_index ] = array ();
$header_images [ $header_index ][ 'attachment_id' ] = $header -> ID ;
$header_images [ $header_index ][ 'url' ] = $url ;
$header_images [ $header_index ][ 'thumbnail_url' ] = $url ;
2013-03-29 21:51:35 +01: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-29 01:02:16 +02:00
}
return $header_images ;
}
2012-02-03 00:35:37 +01:00
/**
* Get the header image data .
*
* @ since 3.4 . 0
*
* @ return object
*/
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
function get_custom_header () {
2012-11-07 21:12:47 +01: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 07:59:25 +01:00
if ( ! $data && current_theme_supports ( 'custom-header' , 'default-image' ) ) {
2012-11-07 21:12:47 +01:00
$directory_args = array ( get_template_directory_uri (), get_stylesheet_directory_uri () );
2012-11-19 07:59:25 +01: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 21:12:47 +01:00
}
}
}
}
2012-02-03 00:35:37 +01:00
$default = array (
'url' => '' ,
'thumbnail_url' => '' ,
2012-03-19 19:00:27 +01:00
'width' => get_theme_support ( 'custom-header' , 'width' ),
'height' => get_theme_support ( 'custom-header' , 'height' ),
2012-02-03 00:35:37 +01:00
);
return ( object ) wp_parse_args ( $data , $default );
}
2010-02-25 20:18:44 +01:00
/**
* Register a selection of default headers to be displayed by the custom header admin UI .
*
* @ since 3.0 . 0
*
2010-04-02 05:15:18 +02: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 20:18:44 +01:00
*/
function register_default_headers ( $headers ) {
global $_wp_default_headers ;
2010-04-02 05:15:18 +02: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
*
2010-09-07 13:21:11 +02:00
* @ param string | array $header The header string id ( key of array ) to remove , or an array thereof .
2014-03-18 01:12:15 +01: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 05:15:18 +02: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 20:18:44 +01:00
}
2010-02-09 21:37:12 +01:00
/**
* Retrieve background image for custom background .
*
* @ since 3.0 . 0
*
* @ return string
*/
function get_background_image () {
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
return get_theme_mod ( 'background_image' , get_theme_support ( 'custom-background' , 'default-image' ) );
2010-02-09 21:37:12 +01:00
}
/**
* Display background image path .
*
* @ since 3.0 . 0
*/
function background_image () {
echo get_background_image ();
}
2010-03-03 18:10:43 +01:00
/**
* Retrieve value for custom background color .
*
* @ since 3.0 . 0
*
* @ return string
*/
function get_background_color () {
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
return get_theme_mod ( 'background_color' , get_theme_support ( 'custom-background' , 'default-color' ) );
2010-03-03 18:10:43 +01:00
}
/**
* Display background color value .
*
* @ since 3.0 . 0
*/
function background_color () {
echo get_background_color ();
}
2010-02-09 21:37:12 +01:00
/**
* Default custom background callback .
*
* @ since 3.0 . 0
* @ access protected
*/
function _custom_background_cb () {
2012-06-05 20:44:31 +02:00
// $background is the saved custom image, or the default image.
2012-08-27 22:25:53 +02:00
$background = set_url_scheme ( get_background_image () );
2012-06-05 20:44:31 +02: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 12:53:14 +01:00
$color = get_background_color ();
if ( $color === get_theme_support ( 'custom-background' , 'default-color' ) ) {
$color = false ;
}
2012-06-01 22:31:50 +02:00
2012-06-11 23:25:05 +02:00
if ( ! $background && ! $color )
2010-02-09 21:37:12 +01:00
return ;
2010-06-10 20:28:25 +02:00
$style = $color ? " background-color: # $color ; " : '' ;
if ( $background ) {
$image = " background-image: url(' $background '); " ;
2013-12-03 22:36:10 +01:00
$repeat = get_theme_mod ( 'background_repeat' , get_theme_support ( 'custom-background' , 'default-repeat' ) );
2010-06-10 20:28:25 +02:00
if ( ! in_array ( $repeat , array ( 'no-repeat' , 'repeat-x' , 'repeat-y' , 'repeat' ) ) )
$repeat = 'repeat' ;
$repeat = " background-repeat: $repeat ; " ;
2010-06-11 22:19:35 +02:00
2013-12-03 22:36:10 +01:00
$position = get_theme_mod ( 'background_position_x' , get_theme_support ( 'custom-background' , 'default-position-x' ) );
2010-06-10 20:28:25 +02:00
if ( ! in_array ( $position , array ( 'center' , 'right' , 'left' ) ) )
$position = 'left' ;
$position = " background-position: top $position ; " ;
2010-06-11 22:19:35 +02:00
2013-12-03 22:36:10 +01:00
$attachment = get_theme_mod ( 'background_attachment' , get_theme_support ( 'custom-background' , 'default-attachment' ) );
2010-06-10 20:28:25 +02:00
if ( ! in_array ( $attachment , array ( 'fixed' , 'scroll' ) ) )
$attachment = 'scroll' ;
$attachment = " background-attachment: $attachment ; " ;
$style .= $image . $repeat . $position . $attachment ;
2010-03-28 04:53:04 +02:00
}
2010-02-09 21:37:12 +01:00
?>
2012-05-25 20:41:22 +02:00
< style type = " text/css " id = " custom-background-css " >
2011-10-05 19:20:43 +02:00
body . custom - background { < ? php echo trim ( $style ); ?> }
2010-02-09 21:37:12 +01:00
</ style >
< ? php
}
2010-02-26 21:12:06 +01:00
/**
2010-02-26 22:07:41 +01:00
* Add callback for custom TinyMCE editor stylesheets .
2010-02-26 21:12:06 +01:00
*
* The parameter $stylesheet is the name of the stylesheet , relative to
2010-02-26 22:07:41 +01:00
* the theme root . It also accepts an array of stylesheets .
* It is optional and defaults to 'editor-style.css' .
2010-02-26 21:12:06 +01:00
*
2012-03-01 01:18:26 +01: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 11:09:00 +01:00
* RTL is only added for the first stylesheet .
*
2012-03-01 01:18:26 +01: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 21:12:06 +01:00
* @ since 3.0 . 0
*
2010-02-26 22:07:41 +01:00
* @ param mixed $stylesheet Optional . Stylesheet name or array thereof , relative to theme root .
* Defaults to 'editor-style.css'
2010-02-26 21:12:06 +01:00
*/
function add_editor_style ( $stylesheet = 'editor-style.css' ) {
add_theme_support ( 'editor-style' );
if ( ! is_admin () )
return ;
2010-02-27 08:36:35 +01:00
global $editor_styles ;
$editor_styles = ( array ) $editor_styles ;
$stylesheet = ( array ) $stylesheet ;
2010-05-03 07:49:19 +02:00
if ( is_rtl () ) {
2010-04-26 16:56:57 +02:00
$rtl_stylesheet = str_replace ( '.css' , '-rtl.css' , $stylesheet [ 0 ]);
$stylesheet [] = $rtl_stylesheet ;
}
2010-02-27 08:36:35 +01:00
$editor_styles = array_merge ( $editor_styles , $stylesheet );
2010-02-26 21:12:06 +01:00
}
2010-12-04 11:09:00 +01:00
/**
* Removes all visual editor stylesheets .
*
* @ since 3.1 . 0
*
* @ return bool True on success , false if there were no stylesheets to remove .
*/
function remove_editor_styles () {
if ( ! current_theme_supports ( 'editor-style' ) )
return false ;
_remove_theme_support ( 'editor-style' );
if ( is_admin () )
$GLOBALS [ 'editor_styles' ] = array ();
return true ;
}
2014-07-15 23:51:15 +02:00
/**
* Retrieve any registered editor stylesheets
*
* @ since 4.0 . 0
*
* @ global $editor_styles Registered editor stylesheets
*
* @ 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 " ;
}
}
}
return $stylesheets ;
}
2009-11-01 06:27:39 +01:00
/**
* Allows a theme to register its support of a certain feature
2010-01-15 23:11:12 +01:00
*
2010-03-31 11:06:11 +02:00
* Must be called in the theme ' s functions . php file to work .
* If attached to a hook , it must be after_setup_theme .
* The init hook may be too late for some features .
2009-11-01 06:27:39 +01:00
*
2010-03-26 20:23:39 +01:00
* @ since 2.9 . 0
2014-04-01 00:20:16 +02:00
*
* @ param string $feature The feature being added .
* @ return void | bool False on failure , void otherwise .
2009-11-01 06:27:39 +01:00
*/
function add_theme_support ( $feature ) {
global $_wp_theme_features ;
2009-12-09 16:39:20 +01:00
if ( func_num_args () == 1 )
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$args = true ;
2009-12-09 16:39:20 +01:00
else
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$args = array_slice ( func_get_args (), 1 );
switch ( $feature ) {
2013-02-21 23:48:09 +01:00
case 'post-formats' :
2013-05-30 19:55:14 +02:00
if ( is_array ( $args [ 0 ] ) )
$args [ 0 ] = array_intersect ( $args [ 0 ], array_keys ( get_post_format_slugs () ) );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
break ;
2013-08-31 03:30:09 +02:00
case 'html5' :
// You can't just pass 'html5', you need to pass an array of types.
2013-09-04 19:44:09 +02:00
if ( empty ( $args [ 0 ] ) ) {
2014-04-01 00:20:16 +02:00
// Build an array of types for back-compat.
2013-09-04 19:44:09 +02:00
$args = array ( 0 => array ( 'comment-list' , 'comment-form' , 'search-form' ) );
} elseif ( ! is_array ( $args [ 0 ] ) ) {
2014-10-05 23:06:15 +02:00
_doing_it_wrong ( " add_theme_support( 'html5' ) " , __ ( 'You need to pass an array of types.' ), '3.6.1' );
2013-08-31 03:30:09 +02:00
return false ;
2013-09-04 19:44:09 +02:00
}
2013-08-31 03:30:09 +02: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 ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
case 'custom-header-uploads' :
return add_theme_support ( 'custom-header' , array ( 'uploads' => true ) );
case 'custom-header' :
2012-03-20 21:34:49 +01:00
if ( ! is_array ( $args ) )
$args = array ( 0 => array () );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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 04:36:17 +01:00
'wp-head-callback' => '' ,
'admin-head-callback' => '' ,
'admin-preview-callback' => '' ,
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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.
// Constants are lame. Don't reference them. This is just for backwards compatibility.
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 21:34:49 +01:00
elseif ( isset ( $args [ 0 ][ 'height' ] ) )
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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 21:34:49 +01:00
elseif ( isset ( $args [ 0 ][ 'default-image' ] ) )
define ( 'HEADER_IMAGE' , $args [ 0 ][ 'default-image' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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 21:34:49 +01:00
if ( ! is_array ( $args ) )
$args = array ( 0 => array () );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$defaults = array (
2013-11-24 15:05:10 +01:00
'default-image' => '' ,
2013-12-03 22:36:10 +01:00
'default-repeat' => 'repeat' ,
'default-position-x' => 'left' ,
'default-attachment' => 'scroll' ,
2013-11-24 15:05:10 +01:00
'default-color' => '' ,
'wp-head-callback' => '_custom_background_cb' ,
'admin-head-callback' => '' ,
2012-03-21 04:36:17 +01:00
'admin-preview-callback' => '' ,
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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 ;
}
$_wp_theme_features [ $feature ] = $args ;
}
/**
* Registers the internal custom header and background routines .
*
* @ since 3.4 . 0
* @ access private
*/
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 15:30:55 +02:00
if ( $args [ 0 ][ 'wp-head-callback' ] )
2012-03-21 04:36:17 +01:00
add_action ( 'wp_head' , $args [ 0 ][ 'wp-head-callback' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
2012-05-03 15:30:55 +02:00
if ( is_admin () ) {
require_once ( ABSPATH . 'wp-admin/custom-header.php' );
$custom_image_header = new Custom_Image_Header ( $args [ 0 ][ 'admin-head-callback' ], $args [ 0 ][ 'admin-preview-callback' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
}
}
2011-01-06 05:11:14 +01:00
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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 04:36:17 +01:00
add_action ( 'wp_head' , $args [ 0 ][ 'wp-head-callback' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
if ( is_admin () ) {
require_once ( ABSPATH . 'wp-admin/custom-background.php' );
2012-03-21 04:36:17 +01:00
$custom_background = new Custom_Background ( $args [ 0 ][ 'admin-head-callback' ], $args [ 0 ][ 'admin-preview-callback' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
}
2012-03-19 22:14:41 +01:00
}
2009-11-01 06:27:39 +01:00
}
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
add_action ( 'wp_loaded' , '_custom_header_background_just_in_time' );
2009-11-01 06:27:39 +01:00
2010-11-04 08:41:07 +01:00
/**
* Gets the theme support arguments passed when registering that support
*
2013-12-24 19:57:12 +01:00
* @ since 3.1 . 0
*
2010-11-04 08:41:07 +01:00
* @ param string $feature the feature to check
* @ return array The array of extra arguments
*/
function get_theme_support ( $feature ) {
global $_wp_theme_features ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
if ( ! isset ( $_wp_theme_features [ $feature ] ) )
2010-11-04 08:41:07 +01:00
return false ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
if ( func_num_args () <= 1 )
return $_wp_theme_features [ $feature ];
$args = array_slice ( func_get_args (), 1 );
switch ( $feature ) {
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 05:50:14 +02:00
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
default :
return $_wp_theme_features [ $feature ];
}
2010-11-04 08:41:07 +01:00
}
2010-03-29 18:26:54 +02:00
/**
* Allows a theme to de - register its support of a certain feature
*
2010-03-31 11:06:11 +02: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 18:26:54 +02:00
*
* @ since 3.0 . 0
2010-03-31 11:06:11 +02:00
* @ see add_theme_support ()
2010-03-29 18:26:54 +02:00
* @ param string $feature the feature being added
2010-03-31 11:06:11 +02:00
* @ return bool Whether feature was removed .
2010-03-29 18:26:54 +02:00
*/
function remove_theme_support ( $feature ) {
2010-03-31 11:06:11 +02:00
// Blacklist: for internal registrations not used directly by themes.
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
if ( in_array ( $feature , array ( 'editor-style' , 'widgets' , 'menus' ) ) )
2010-03-31 11:06:11 +02:00
return false ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
2010-12-02 01:16:35 +01:00
return _remove_theme_support ( $feature );
}
2010-03-31 11:06:11 +02:00
2010-12-02 01:16:35 +01:00
/**
2010-12-04 10:59:35 +01:00
* Do not use . Removes theme support internally , ignorant of the blacklist .
2010-12-02 01:16:35 +01:00
*
* @ access private
* @ since 3.1 . 0
*/
function _remove_theme_support ( $feature ) {
2010-03-29 18:26:54 +02:00
global $_wp_theme_features ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01: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 11:06:11 +02:00
return false ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
switch ( $feature ) {
case 'custom-header' :
2013-02-01 21:33:27 +01:00
if ( ! did_action ( 'wp_loaded' ) )
2012-10-26 06:17:25 +02:00
break ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$support = get_theme_support ( 'custom-header' );
2012-10-26 06:16:49 +02:00
if ( $support [ 0 ][ 'wp-head-callback' ] )
2012-03-21 04:36:17 +01:00
remove_action ( 'wp_head' , $support [ 0 ][ 'wp-head-callback' ] );
2012-10-26 06:16:49 +02:00
remove_action ( 'admin_menu' , array ( $GLOBALS [ 'custom_image_header' ], 'init' ) );
unset ( $GLOBALS [ 'custom_image_header' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
break ;
2012-03-19 18:15:30 +01:00
case 'custom-background' :
2013-02-01 21:33:27 +01:00
if ( ! did_action ( 'wp_loaded' ) )
2012-10-26 06:17:25 +02:00
break ;
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
$support = get_theme_support ( 'custom-background' );
2012-10-26 06:16:49 +02:00
remove_action ( 'wp_head' , $support [ 0 ][ 'wp-head-callback' ] );
remove_action ( 'admin_menu' , array ( $GLOBALS [ 'custom_background' ], 'init' ) );
unset ( $GLOBALS [ 'custom_background' ] );
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
break ;
}
unset ( $_wp_theme_features [ $feature ] );
2010-03-31 11:06:11 +02:00
return true ;
2010-03-29 18:26:54 +02:00
}
2009-11-01 06:27:39 +01:00
/**
* Checks a theme ' s support for a given feature
*
2010-03-26 20:23:39 +01:00
* @ since 2.9 . 0
2009-11-01 06:27:39 +01:00
* @ param string $feature the feature being checked
* @ return boolean
*/
function current_theme_supports ( $feature ) {
global $_wp_theme_features ;
2009-12-09 16:39:20 +01:00
Introduce new registration methods for custom headers and custom backgrounds. Backwards compatible, but old methods will be deprecated. see #20249. see #17242.
Custom header: Use add_theme_support('custom-header', $args) instead of add_custom_image_header(). Deprecates all use of constants.
* HEADER_TEXTCOLOR is now (string) 'default-text-color'.
* NO_HEADER_TEXT is nowi ! (bool) 'header-text'.
* HEADER_IMAGE_WIDTH (and _HEIGHT) are now (int) 'width' and 'height'.
* HEADER_IMAGE is now (string) 'default-image'.
* The 3.4 arguments 'suggested-width' and 'suggested-height' are now just 'width' and 'height' (they are "suggested" when flex-width and flex-height are set).
* Callback arguments for add_custom_image_header() can now be passed to add_theme_support().
Custom background: Use add_theme_support('custom-background, $args) instead of add_custom_background(). Deprecates all use of constants.
* BACKGROUND_COLOR is now (string) 'default-color'.
* BACKGROUND_IMAGE is now (string) 'default-image'.
* Callback arguments for add_custom_background() can now be passed to add_theme_support().
Inheritance: add_theme_support() arguments for custom headers and custom backgrounds is a first-one-wins situation. This is not an unusual paradigm for theming as a child theme (which is included first) overrides a parent theme.
* Once an argument is explicitly set, it cannot be overridden. You must hook in earlier and set it first.
* Any argument that is not explicitly set before WP is loaded will inherit the default value for that argument.
* It is therefore possible for a child theme to pass minimal arguments as long as the parent theme specifies others that may be necessary.
* Allows for a child theme to alter callbacks for <head> and preview (previously, calling add_custom_image_header more than once broke things).
* The just-in-time bits ensure that arguments fall back to default values, that the values of all constants are considered (such as one defined after an old add_custom_image_header call), and that all constants are defined (so as to be backwards compatible).
get_theme_support(): Introduce new second argument, which headers and backgrounds leverage to return an argument. current_theme_supports() already supported checking the truthiness of the argument.
* For example, get_theme_support( 'custom-header', 'width' ) will return the width specified during registration.
* If you had wanted the default image, use get_theme_support( 'custom-header', 'default-image' ) instead of HEADER_IMAGE.
Deprecate remove_custom_image_header(), remove_custom_background(). Use remove_theme_support('custom-header'), 'custom-background'.
Deprecate short-lived custom-header-uploads internal support; this is now (bool) 'uploads' for add_theme_support().
New 3.4 functions renamed or removed: Rename get_current_header_data() to get_custom_header(). Remove get_header_image_width() and _height() in favor of get_custom_header()->width and height.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-19 18:12:44 +01:00
if ( 'custom-header-uploads' == $feature )
return current_theme_supports ( 'custom-header' , 'uploads' );
2009-12-09 16:39:20 +01: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 07:14:36 +01:00
case 'post-thumbnails' :
2009-12-09 16:39:20 +01:00
// post-thumbnails can be registered for only certain content/post types by passing
2011-12-14 00:45:31 +01:00
// an array of types to add_theme_support(). If no array was passed, then
2009-12-09 16:39:20 +01:00
// any type is accepted
if ( true === $_wp_theme_features [ $feature ] ) // Registered for all types
return true ;
$content_type = $args [ 0 ];
2011-09-19 18:29:03 +02:00
return in_array ( $content_type , $_wp_theme_features [ $feature ][ 0 ] );
2013-08-31 03:30:09 +02:00
case 'html5' :
2011-09-19 18:29:03 +02:00
case 'post-formats' :
// specific post formats can be registered by passing an array of types to
// add_theme_support()
2013-08-31 03:30:09 +02: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-03 00:35:37 +01:00
case 'custom-header' :
2012-05-25 19:58:57 +02:00
case 'custom-background' :
// specific custom header and background capabilities can be registered by passing
2012-02-03 00:35:37 +01:00
// an array to add_theme_support()
$header_support = $args [ 0 ];
return ( isset ( $_wp_theme_features [ $feature ][ 0 ][ $header_support ] ) && $_wp_theme_features [ $feature ][ 0 ][ $header_support ] );
2009-12-09 16:39:20 +01:00
}
2013-12-01 18:24:11 +01:00
/**
* Filter whether the current theme supports a specific feature .
*
* The dynamic portion of the hook name , $feature , refers to
* the specific theme feature . Possible values include 'post-formats' ,
* 'post-thumbnails' , 'custom-background' , 'custom-header' , 'menus' ,
* 'automatic-feed-links' , and 'html5' .
*
* @ 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 06:27:39 +01:00
}
2012-04-30 04:02:11 +02:00
/**
* Checks a theme ' s support for a given feature before loading the functions which implement it .
*
* @ since 2.9 . 0
2014-02-20 23:11:14 +01: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 04:02:11 +02:00
*/
2014-02-20 23:11:14 +01:00
function require_if_theme_supports ( $feature , $include ) {
if ( current_theme_supports ( $feature ) ) {
2012-04-30 04:02:11 +02:00
require ( $include );
2014-02-20 23:11:14 +01:00
return true ;
}
return false ;
2012-04-30 04:02:11 +02:00
}
2010-05-24 21:42:43 +02:00
/**
2010-05-24 23:26:49 +02:00
* Checks an attachment being deleted to see if it ' s a header or background image .
2010-05-26 04:42:15 +02:00
*
2010-05-24 23:26:49 +02:00
* If true it removes the theme modification which would be pointing at the deleted
* attachment
2010-05-24 21:42:43 +02:00
*
2010-05-24 23:26:49 +02:00
* @ access private
2010-05-24 21:42:43 +02:00
* @ since 3.0 . 0
* @ param int $id the attachment id
*/
function _delete_attachment_theme_mod ( $id ) {
$attachment_image = wp_get_attachment_url ( $id );
$header_image = get_header_image ();
$background_image = get_background_image ();
2010-05-26 04:42:15 +02:00
2010-05-24 21:42:43 +02:00
if ( $header_image && $header_image == $attachment_image )
remove_theme_mod ( 'header_image' );
if ( $background_image && $background_image == $attachment_image )
remove_theme_mod ( 'background_image' );
}
add_action ( 'delete_attachment' , '_delete_attachment_theme_mod' );
2011-09-08 22:07:15 +02:00
/**
2011-09-08 22:59:41 +02:00
* Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load
2011-09-08 22:07:15 +02:00
*
2012-01-04 20:03:33 +01:00
* @ since 3.3 . 0
2011-09-08 22:59:41 +02:00
*/
2011-09-08 22:07:15 +02:00
function check_theme_switched () {
2012-03-08 22:22:24 +01:00
if ( $stylesheet = get_option ( 'theme_switched' ) ) {
$old_theme = wp_get_theme ( $stylesheet );
2012-03-30 17:13:12 +02:00
2014-04-15 00:46:16 +02: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 18:24:11 +01: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 17:13:12 +02:00
do_action ( 'after_switch_theme' , $stylesheet );
2013-12-01 18:24:11 +01:00
}
2012-03-30 17:13:12 +02:00
2011-09-08 22:07:15 +02:00
update_option ( 'theme_switched' , false );
}
}
2012-02-25 05:12:43 +01:00
2012-04-10 04:25:03 +02:00
/**
2012-05-23 19:56:42 +02:00
* Includes and instantiates the WP_Customize_Manager class .
2012-04-10 04:25:03 +02:00
*
2012-06-07 03:29:57 +02:00
* Fires when ? wp_customize = on or on wp - admin / customize . php .
2012-04-10 04:25:03 +02:00
*
* @ since 3.4 . 0
*/
function _wp_customize_include () {
2012-06-07 03:29:57 +02:00
if ( ! ( ( isset ( $_REQUEST [ 'wp_customize' ] ) && 'on' == $_REQUEST [ 'wp_customize' ] )
|| ( is_admin () && 'customize.php' == basename ( $_SERVER [ 'PHP_SELF' ] ) )
) )
2012-02-25 05:12:43 +01:00
return ;
2012-05-23 19:56:42 +02:00
require ( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
2012-02-25 05:12:43 +01:00
// Init Customize class
2012-05-23 19:56:42 +02:00
$GLOBALS [ 'wp_customize' ] = new WP_Customize_Manager ;
2012-02-25 05:12:43 +01:00
}
2012-04-10 04:25:03 +02:00
add_action ( 'plugins_loaded' , '_wp_customize_include' );
/**
2012-05-24 23:13:21 +02:00
* Adds settings for the customize - loader script .
2012-04-10 04:25:03 +02:00
*
* @ since 3.4 . 0
*/
2012-05-24 23:13:21 +02:00
function _wp_customize_loader_settings () {
global $wp_scripts ;
$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 23:45:17 +02:00
$browser = array (
'mobile' => wp_is_mobile (),
'ios' => wp_is_mobile () && preg_match ( '/iPad|iPod|iPhone/' , $_SERVER [ 'HTTP_USER_AGENT' ] ),
);
2012-05-24 23:13:21 +02:00
$settings = array (
2012-05-25 00:45:27 +02:00
'url' => esc_url ( admin_url ( 'customize.php' ) ),
2012-05-24 23:13:21 +02:00
'isCrossDomain' => $cross_domain ,
2012-06-06 23:45:17 +02:00
'browser' => $browser ,
2014-07-08 19:04:15 +02:00
'l10n' => array (
'saveAlert' => __ ( 'The changes you made will be lost if you navigate away from this page.' ),
),
2012-05-24 23:13:21 +02:00
);
$script = 'var _wpCustomizeLoaderSettings = ' . json_encode ( $settings ) . ';' ;
$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 04:25:03 +02:00
}
2012-05-24 23:13:21 +02:00
add_action ( 'admin_enqueue_scripts' , '_wp_customize_loader_settings' );
2012-04-10 04:25:03 +02:00
/**
2014-10-15 19:21:19 +02:00
* Returns a URL to load the Customizer .
2012-04-10 04:25:03 +02:00
*
* @ since 3.4 . 0
2012-05-26 17:32:05 +02:00
*
* @ param string $stylesheet Optional . Theme to customize . Defaults to current theme .
2012-09-04 01:58:30 +02:00
* The theme ' s stylesheet will be urlencoded if necessary .
2012-04-10 04:25:03 +02:00
*/
2012-05-26 17:32:05 +02:00
function wp_customize_url ( $stylesheet = null ) {
$url = admin_url ( 'customize.php' );
if ( $stylesheet )
2012-09-04 01:58:30 +02:00
$url .= '?theme=' . urlencode ( $stylesheet );
2012-05-26 17:32:05 +02:00
return esc_url ( $url );
2012-05-24 23:13:21 +02:00
}
2012-05-25 02:15:12 +02:00
/**
2014-10-15 19:21:19 +02:00
* Prints a script to check whether or not the Customizer is supported ,
2012-05-25 02:15:12 +02: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
*/
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' ] ) );
?>
< 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 ; ?>
2012-10-07 16:58:12 +02:00
b [ c ] = b [ c ] . replace ( rcs , ' ' );
2012-05-25 02:15:12 +02:00
b [ c ] += ( window . postMessage && request ? ' ' : ' no-' ) + cs ;
}());
</ script >
< ? php
2014-04-15 00:46:16 +02:00
}
2014-07-04 18:17:15 +02:00
/**
* Whether the site is being previewed in the Customizer .
*
* @ since 4.0 . 0
*
2014-07-14 03:02:15 +02:00
* @ global WP_Customize_Manager $wp_customize Customizer instance .
*
2014-07-04 18:17:15 +02:00
* @ return bool True if the site is being previewed in the Customizer , false otherwise .
*/
function is_customize_preview () {
global $wp_customize ;
return is_a ( $wp_customize , 'WP_Customize_Manager' ) && $wp_customize -> is_preview ();
}