2006-04-18 00:44:33 -04:00
< ? php
2008-08-12 16:18:05 -04:00
/**
2008-09-01 01:44:16 -04:00
* Theme , template , and stylesheet functions .
*
2008-08-12 16:18:05 -04:00
* @ package WordPress
2012-02-27 20:49:49 -05:00
* @ subpackage Theme
2008-09-01 01:44:16 -04: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 16:24:44 -05: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 11:39:21 -04: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 16:24:44 -05:00
* linearly with additional themes . Stick to wp_get_theme () if possible .
*
* @ since 3.4 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2018-02-02 04:38:30 -05:00
* @ param array $args {
* Optional . The search arguments .
*
2020-06-27 08:02:03 -04:00
* @ type mixed $errors True to return themes with errors , false to return
* themes without errors , null to return all themes .
* Default false .
* @ type mixed $allowed ( 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 . Default null .
* @ type int $blog_id ( Multisite ) The blog ID used to calculate which themes
* are allowed . Default 0 , synonymous for the current blog .
2018-02-02 04:38:30 -05:00
* }
2018-03-22 16:27:32 -04:00
* @ return WP_Theme [] Array of WP_Theme objects .
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 16:24:44 -05:00
*/
function wp_get_themes ( $args = array () ) {
global $wp_theme_directories ;
2017-11-30 18:11:00 -05:00
$defaults = array (
'errors' => false ,
'allowed' => null ,
'blog_id' => 0 ,
);
$args = wp_parse_args ( $args , $defaults );
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 16:24:44 -05: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 11:39:21 -04:00
$theme_directories = search_theme_directories ();
2017-07-27 13:00:44 -04:00
if ( is_array ( $wp_theme_directories ) && count ( $wp_theme_directories ) > 1 ) {
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* Make sure the active theme wins out , in case search_theme_directories () picks the wrong
* one in the case of a conflict . ( Normally , last registered theme root wins . )
*/
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 11:39:21 -04:00
$current_theme = get_stylesheet ();
if ( isset ( $theme_directories [ $current_theme ] ) ) {
2012-03-08 02:46:39 -05:00
$root_of_current_theme = get_raw_theme_root ( $current_theme );
2020-04-04 23:02:11 -04:00
if ( ! in_array ( $root_of_current_theme , $wp_theme_directories , true ) ) {
2012-03-08 13:00:11 -05:00
$root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme ;
2017-11-30 18:11:00 -05: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 11:39:21 -04: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 16:24:44 -05:00
}
}
2017-11-30 18:11:00 -05:00
if ( empty ( $theme_directories ) ) {
2012-03-08 02:46:39 -05:00
return array ();
2017-11-30 18:11:00 -05: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 16:24:44 -05:00
if ( is_multisite () && null !== $args [ 'allowed' ] ) {
2012-03-08 02:46:39 -05:00
$allowed = $args [ 'allowed' ];
2017-11-30 18:11:00 -05:00
if ( 'network' === $allowed ) {
2012-03-21 13:32:28 -04:00
$theme_directories = array_intersect_key ( $theme_directories , WP_Theme :: get_allowed_on_network () );
2017-11-30 18:11:00 -05:00
} elseif ( 'site' === $allowed ) {
2012-03-08 02:46:39 -05:00
$theme_directories = array_intersect_key ( $theme_directories , WP_Theme :: get_allowed_on_site ( $args [ 'blog_id' ] ) );
2017-11-30 18:11:00 -05:00
} elseif ( $allowed ) {
2012-03-08 02:46:39 -05:00
$theme_directories = array_intersect_key ( $theme_directories , WP_Theme :: get_allowed ( $args [ 'blog_id' ] ) );
2017-11-30 18:11:00 -05:00
} else {
2012-03-08 02:46:39 -05:00
$theme_directories = array_diff_key ( $theme_directories , WP_Theme :: get_allowed ( $args [ 'blog_id' ] ) );
2017-11-30 18:11:00 -05:00
}
2012-03-08 02:46:39 -05:00
}
2017-11-30 18:11:00 -05:00
$themes = array ();
2012-03-21 13:32:28 -04:00
static $_themes = array ();
2012-03-08 02:46:39 -05:00
foreach ( $theme_directories as $theme => $theme_root ) {
2017-11-30 18:11:00 -05:00
if ( isset ( $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ] ) ) {
2012-04-05 16:38:42 -04:00
$themes [ $theme ] = $_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ];
2017-11-30 18:11:00 -05:00
} else {
2019-11-10 21:43:03 -05:00
$themes [ $theme ] = new WP_Theme ( $theme , $theme_root [ 'theme_root' ] );
2019-07-02 19:42:58 -04:00
$_themes [ $theme_root [ 'theme_root' ] . '/' . $theme ] = $themes [ $theme ];
2017-11-30 18:11:00 -05:00
}
2012-03-08 02:46:39 -05:00
}
if ( null !== $args [ 'errors' ] ) {
foreach ( $themes as $theme => $wp_theme ) {
2017-11-30 18:11:00 -05:00
if ( $wp_theme -> errors () != $args [ 'errors' ] ) {
2012-03-08 02:46:39 -05:00
unset ( $themes [ $theme ] );
2017-11-30 18:11:00 -05: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 16:24:44 -05:00
}
}
return $themes ;
}
/**
* Gets a WP_Theme object for a theme .
*
* @ since 3.4 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2022-01-20 18:53:05 -05:00
* @ param string $stylesheet Optional . Directory name for the theme . Defaults to active theme .
2020-06-27 08:02:03 -04:00
* @ param string $theme_root Optional . Absolute path of the theme root to look in .
* If not specified , get_raw_theme_root () is used to calculate
2022-01-20 18:53:05 -05:00
* the theme root for the $stylesheet provided ( or active theme ) .
2020-06-27 08:02:03 -04: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 16:24:44 -05:00
*/
2019-10-04 19:20:58 -04:00
function wp_get_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 16:24:44 -05:00
global $wp_theme_directories ;
2017-11-30 18:11:00 -05:00
if ( empty ( $stylesheet ) ) {
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 16:24:44 -05:00
$stylesheet = get_stylesheet ();
2017-11-30 18:11:00 -05: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 16:24:44 -05:00
if ( empty ( $theme_root ) ) {
$theme_root = get_raw_theme_root ( $stylesheet );
2017-11-30 18:11:00 -05:00
if ( false === $theme_root ) {
2012-06-12 11:57:11 -04:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2020-04-04 23:02:11 -04:00
} elseif ( ! in_array ( $theme_root , ( array ) $wp_theme_directories , true ) ) {
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 16:24:44 -05:00
$theme_root = WP_CONTENT_DIR . $theme_root ;
2017-11-30 18:11:00 -05: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 16:24:44 -05:00
}
2012-04-04 21:05:49 -04: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 16:24:44 -05:00
}
2012-06-14 10:24:25 -04:00
/**
* Clears the cache held by get_theme_roots () and WP_Theme .
*
* @ since 3.5 . 0
2020-06-27 08:02:03 -04:00
* @ param bool $clear_update_cache Whether to clear the theme updates cache .
2012-06-14 10:24:25 -04:00
*/
2013-09-05 21:33:09 -04:00
function wp_clean_themes_cache ( $clear_update_cache = true ) {
2017-11-30 18:11:00 -05:00
if ( $clear_update_cache ) {
2013-09-05 21:33:09 -04:00
delete_site_transient ( 'update_themes' );
2017-11-30 18:11:00 -05:00
}
2012-06-14 10:24:25 -04:00
search_theme_directories ( true );
2017-11-30 18:11:00 -05:00
foreach ( wp_get_themes ( array ( 'errors' => null ) ) as $theme ) {
2012-06-14 10:24:25 -04:00
$theme -> cache_delete ();
2017-11-30 18:11:00 -05:00
}
2012-06-14 10:24:25 -04:00
}
2010-05-03 16:56:57 -04:00
/**
* Whether a child theme is in use .
*
* @ since 3.0 . 0
2024-02-21 14:26:08 -05:00
* @ since 6.5 . 0 Makes use of global template variables .
*
* @ global string $wp_stylesheet_path Path to current theme ' s stylesheet directory .
* @ global string $wp_template_path Path to current theme ' s template directory .
2010-05-03 16:56:57 -04:00
*
2020-06-27 08:02:03 -04:00
* @ return bool True if a child theme is in use , false otherwise .
2017-11-30 18:11:00 -05:00
*/
2010-05-03 16:56:57 -04:00
function is_child_theme () {
2024-02-21 14:26:08 -05:00
global $wp_stylesheet_path , $wp_template_path ;
return $wp_stylesheet_path !== $wp_template_path ;
2010-05-03 16:56:57 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2020-06-23 06:43:09 -04:00
* Retrieves name of the current stylesheet .
2008-09-01 01:44:16 -04:00
*
2020-06-27 08:02:03 -04:00
* The theme name that is currently set as the front end theme .
2008-09-01 01:44:16 -04:00
*
2020-06-27 08:02:03 -04:00
* For all intents and purposes , the template name and the stylesheet name
* are going to be the same for most cases .
2008-09-24 01:24:33 -04:00
*
2008-09-01 01:44:16 -04:00
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string Stylesheet name .
2006-04-18 00:44:33 -04:00
*/
function get_stylesheet () {
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters the name of current stylesheet .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
* @ param string $stylesheet Name of the current stylesheet .
*/
return apply_filters ( 'stylesheet' , get_option ( 'stylesheet' ) );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves stylesheet directory path for the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2023-09-25 16:49:18 -04:00
* @ since 6.4 . 0 Memoizes filter execution so that it only runs once for the current theme .
2023-11-20 17:29:24 -05:00
* @ since 6.4 . 2 Memoization removed .
2008-09-01 01:44:16 -04:00
*
2022-01-20 18:53:05 -05:00
* @ return string Path to active theme ' s stylesheet directory .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_stylesheet_directory () {
2023-11-20 17:29:24 -05:00
$stylesheet = get_stylesheet ();
$theme_root = get_theme_root ( $stylesheet );
$stylesheet_dir = " $theme_root / $stylesheet " ;
Themes: Deprecate usage of `TEMPLATEPATH` and `STYLESHEETPATH` constants.
While generally the functions `get_template_directory()` and `get_stylesheet_directory()` were long recommended to use to get the parent or child theme directory, the `TEMPLATEPATH` and `STYLESHEETPATH` constants were still used in a few places in core, most importantly in template related logic.
The remaining usage was problematic as it prevented testability of certain key components of WordPress core.
This changeset replaces all remaining usage with the corresponding functions and effectively marks these constants as deprecated. It also adds test coverage accordingly and even unlocks some existing, previously commented out test coverage to work as expected.
Performance of the new approach has been benchmarked and shows no notable differences. Yet, given that the current theme directories are not expected to change within a regular WordPress page load, the `get_template_directory()` and `get_stylesheet_directory()` functions were amended with in-memory caching of the result, unless one of the defining values is being filtered.
Props thekt12, spacedmonkey, mukesh27, aaroncampbell, scribu, lloydbudd, cais, chipbennett, toscho, omarabid, CrazyJaco, DrewAPicture, obenland, wonderboymusic, nacin, helen, dd32, chriscct7, SergeyBiryukov, swissspidy, joemcgill, flixos90.
Fixes #18298.
Built from https://develop.svn.wordpress.org/trunk@56635
git-svn-id: http://core.svn.wordpress.org/trunk@56147 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-20 13:27:23 -04:00
2023-11-20 17:29:24 -05:00
/**
* Filters the stylesheet directory path for the active theme .
*
* @ since 1.5 . 0
*
* @ param string $stylesheet_dir Absolute path to the active theme .
* @ param string $stylesheet Directory name of the active theme .
* @ param string $theme_root Absolute path to themes directory .
*/
return apply_filters ( 'stylesheet_directory' , $stylesheet_dir , $stylesheet , $theme_root );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves stylesheet directory URI for the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2022-01-20 18:53:05 -05:00
* @ return string URI to active theme ' s stylesheet directory .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_stylesheet_directory_uri () {
2017-11-30 18:11:00 -05:00
$stylesheet = str_replace ( '%2F' , '/' , rawurlencode ( get_stylesheet () ) );
$theme_root_uri = get_theme_root_uri ( $stylesheet );
2009-10-13 15:06:35 -04:00
$stylesheet_dir_uri = " $theme_root_uri / $stylesheet " ;
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters the stylesheet directory URI .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
* @ param string $stylesheet_dir_uri Stylesheet directory URI .
* @ param string $stylesheet Name of the activated theme ' s directory .
* @ param string $theme_root_uri Themes root URI .
*/
2009-10-13 15:06:35 -04:00
return apply_filters ( 'stylesheet_directory_uri' , $stylesheet_dir_uri , $stylesheet , $theme_root_uri );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves stylesheet URI for the active theme .
2008-09-01 01:44:16 -04:00
*
2016-05-22 13:39:28 -04:00
* The stylesheet file name is 'style.css' which is appended to the stylesheet directory URI path .
* See get_stylesheet_directory_uri () .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2022-01-20 18:53:05 -05:00
* @ return string URI to active theme ' s stylesheet .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_stylesheet_uri () {
$stylesheet_dir_uri = get_stylesheet_directory_uri ();
2017-11-30 18:11:00 -05:00
$stylesheet_uri = $stylesheet_dir_uri . '/style.css' ;
2013-12-01 12:24:11 -05:00
/**
2022-01-20 18:53:05 -05:00
* Filters the URI of the active theme stylesheet .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
2022-01-20 18:53:05 -05:00
* @ param string $stylesheet_uri Stylesheet URI for the active theme / child theme .
* @ param string $stylesheet_dir_uri Stylesheet directory URI for the active theme / child theme .
2013-12-01 12:24:11 -05:00
*/
return apply_filters ( 'stylesheet_uri' , $stylesheet_uri , $stylesheet_dir_uri );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2016-05-23 15:02:28 -04:00
* Retrieves the localized stylesheet URI .
2008-09-01 01:44:16 -04:00
*
2008-09-25 10:12:58 -04:00
* The stylesheet directory for the localized stylesheet files are located , by
* default , in the base theme directory . The name of the locale file will be the
* locale followed by '.css' . If that does not exist , then the text direction
* stylesheet will be checked for existence , for example 'ltr.css' .
*
* The theme may change the location of the stylesheet directory by either using
2016-05-23 15:02:28 -04:00
* the { @ see 'stylesheet_directory_uri' } or { @ see 'locale_stylesheet_uri' } filters .
*
2008-09-25 10:12:58 -04:00
* If you want to change the location of the stylesheet files for the entire
* WordPress workflow , then change the former . If you just have the locale in a
* separate folder , then change the latter .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
2019-08-03 21:46:55 -04:00
* @ global WP_Locale $wp_locale WordPress date and time locale object .
2015-05-27 18:21:25 -04:00
*
2022-01-20 18:53:05 -05:00
* @ return string URI to active theme ' s localized stylesheet .
2008-09-01 01:44:16 -04:00
*/
2006-09-18 19:40:19 -04:00
function get_locale_stylesheet_uri () {
global $wp_locale ;
$stylesheet_dir_uri = get_stylesheet_directory_uri ();
2017-11-30 18:11:00 -05:00
$dir = get_stylesheet_directory ();
$locale = get_locale ();
if ( file_exists ( " $dir / $locale .css " ) ) {
2006-09-18 19:40:19 -04:00
$stylesheet_uri = " $stylesheet_dir_uri / $locale .css " ;
2017-11-30 18:11:00 -05:00
} elseif ( ! empty ( $wp_locale -> text_direction ) && file_exists ( " $dir / { $wp_locale -> text_direction } .css " ) ) {
2006-09-18 19:40:19 -04:00
$stylesheet_uri = " $stylesheet_dir_uri / { $wp_locale -> text_direction } .css " ;
2017-11-30 18:11:00 -05:00
} else {
2006-09-18 19:40:19 -04:00
$stylesheet_uri = '' ;
2017-11-30 18:11:00 -05:00
}
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters the localized stylesheet URI .
2013-12-01 12:24:11 -05:00
*
* @ since 2.1 . 0
*
* @ param string $stylesheet_uri Localized stylesheet URI .
* @ param string $stylesheet_dir_uri Stylesheet directory URI .
*/
return apply_filters ( 'locale_stylesheet_uri' , $stylesheet_uri , $stylesheet_dir_uri );
2006-09-18 19:40:19 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves name of the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2008-09-24 01:24:33 -04:00
* @ return string Template name .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_template () {
2013-12-01 12:24:11 -05:00
/**
2022-01-20 18:53:05 -05:00
* Filters the name of the active theme .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
2022-01-20 18:53:05 -05:00
* @ param string $template active theme ' s directory name .
2013-12-01 12:24:11 -05:00
*/
return apply_filters ( 'template' , get_option ( 'template' ) );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves template directory path for the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
Themes: Deprecate usage of `TEMPLATEPATH` and `STYLESHEETPATH` constants.
While generally the functions `get_template_directory()` and `get_stylesheet_directory()` were long recommended to use to get the parent or child theme directory, the `TEMPLATEPATH` and `STYLESHEETPATH` constants were still used in a few places in core, most importantly in template related logic.
The remaining usage was problematic as it prevented testability of certain key components of WordPress core.
This changeset replaces all remaining usage with the corresponding functions and effectively marks these constants as deprecated. It also adds test coverage accordingly and even unlocks some existing, previously commented out test coverage to work as expected.
Performance of the new approach has been benchmarked and shows no notable differences. Yet, given that the current theme directories are not expected to change within a regular WordPress page load, the `get_template_directory()` and `get_stylesheet_directory()` functions were amended with in-memory caching of the result, unless one of the defining values is being filtered.
Props thekt12, spacedmonkey, mukesh27, aaroncampbell, scribu, lloydbudd, cais, chipbennett, toscho, omarabid, CrazyJaco, DrewAPicture, obenland, wonderboymusic, nacin, helen, dd32, chriscct7, SergeyBiryukov, swissspidy, joemcgill, flixos90.
Fixes #18298.
Built from https://develop.svn.wordpress.org/trunk@56635
git-svn-id: http://core.svn.wordpress.org/trunk@56147 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-20 13:27:23 -04:00
* @ since 6.4 . 0 Memoizes filter execution so that it only runs once for the current theme .
2023-11-20 17:29:24 -05:00
* @ since 6.4 . 1 Memoization removed .
2008-09-01 01:44:16 -04:00
*
2022-01-20 18:53:05 -05:00
* @ return string Path to active theme ' s template directory .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_template_directory () {
2023-11-20 17:29:24 -05:00
$template = get_template ();
$theme_root = get_theme_root ( $template );
$template_dir = " $theme_root / $template " ;
2009-10-15 16:26:21 -04:00
2023-11-20 17:29:24 -05:00
/**
* Filters the active theme directory path .
*
* @ since 1.5 . 0
*
* @ param string $template_dir The path of the active theme directory .
* @ param string $template Directory name of the active theme .
* @ param string $theme_root Absolute path to the themes directory .
*/
return apply_filters ( 'template_directory' , $template_dir , $template , $theme_root );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves template directory URI for the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2022-01-20 18:53:05 -05:00
* @ return string URI to active theme ' s template directory .
2008-09-01 01:44:16 -04:00
*/
2006-04-18 00:44:33 -04:00
function get_template_directory_uri () {
2017-11-30 18:11:00 -05:00
$template = str_replace ( '%2F' , '/' , rawurlencode ( get_template () ) );
$theme_root_uri = get_theme_root_uri ( $template );
2009-10-13 15:06:35 -04:00
$template_dir_uri = " $theme_root_uri / $template " ;
2009-10-15 16:26:21 -04:00
2013-12-01 12:24:11 -05:00
/**
2022-01-20 18:53:05 -05:00
* Filters the active theme directory URI .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
2022-01-20 18:53:05 -05:00
* @ param string $template_dir_uri The URI of the active theme directory .
* @ param string $template Directory name of the active theme .
2013-12-01 12:24:11 -05:00
* @ param string $theme_root_uri The themes root URI .
*/
2009-10-13 15:06:35 -04:00
return apply_filters ( 'template_directory_uri' , $template_dir_uri , $template , $theme_root_uri );
2006-04-18 00:44:33 -04:00
}
2009-10-13 15:06:35 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves theme roots .
2009-10-13 15:06:35 -04:00
*
* @ since 2.9 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2020-06-27 08:02:03 -04: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 15:06:35 -04:00
*/
function get_theme_roots () {
2010-09-21 15:41:35 -04:00
global $wp_theme_directories ;
2018-04-30 00:51:22 -04:00
if ( ! is_array ( $wp_theme_directories ) || count ( $wp_theme_directories ) <= 1 ) {
2012-02-28 11:22:26 -05:00
return '/themes' ;
2017-11-30 18:11:00 -05:00
}
2010-09-21 15:41:35 -04:00
2009-10-29 17:53:57 -04:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 15:06:35 -04: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 11:39:21 -04:00
search_theme_directories ( true ); // Regenerate the transient.
2012-02-28 15:08:08 -05:00
$theme_roots = get_site_transient ( 'theme_roots' );
2009-10-13 15:06:35 -04:00
}
return $theme_roots ;
}
/**
2020-06-27 08:02:03 -04:00
* Registers a directory that contains themes .
2009-10-13 15:06:35 -04:00
*
* @ since 2.9 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2020-06-27 08:02:03 -04:00
* @ param string $directory Either the full filesystem path to a theme folder
* or a folder within WP_CONTENT_DIR .
2020-07-15 08:10:06 -04:00
* @ return bool True if successfully registered a directory that contains themes ,
* false if the directory does not exist .
2009-10-13 15:06:35 -04:00
*/
2012-02-28 13:02:21 -05:00
function register_theme_directory ( $directory ) {
2009-10-13 15:06:35 -04:00
global $wp_theme_directories ;
2009-12-08 16:29:12 -05:00
2012-02-28 13:02:21 -05:00
if ( ! file_exists ( $directory ) ) {
2020-01-28 19:45:18 -05:00
// Try prepending as the theme directory could be relative to the content directory.
2012-02-28 13:02:21 -05:00
$directory = WP_CONTENT_DIR . '/' . $directory ;
2020-01-28 19:45:18 -05:00
// If this directory does not exist, return and do not register.
2014-07-19 19:07:15 -04:00
if ( ! file_exists ( $directory ) ) {
2012-02-28 13:02:21 -05:00
return false ;
2014-07-19 19:07:15 -04:00
}
}
if ( ! is_array ( $wp_theme_directories ) ) {
$wp_theme_directories = array ();
2012-02-28 13:02:21 -05:00
}
2012-02-28 11:22:26 -05:00
2014-07-19 19:07:15 -04:00
$untrailed = untrailingslashit ( $directory );
2020-04-04 23:02:11 -04:00
if ( ! empty ( $untrailed ) && ! in_array ( $untrailed , $wp_theme_directories , true ) ) {
2014-07-19 19:07:15 -04:00
$wp_theme_directories [] = $untrailed ;
}
2009-10-15 16:26:21 -04:00
2009-10-13 15:06:35 -04:00
return true ;
}
/**
2020-06-27 08:02:03 -04:00
* Searches all registered theme directories for complete and valid themes .
2009-10-13 15:06:35 -04:00
*
* @ since 2.9 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2020-06-27 08:02:03 -04:00
* @ param bool $force Optional . Whether to force a new directory scan . Default false .
* @ return array | false Valid themes found on success , false on failure .
2009-10-13 15:06:35 -04: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 11:39:21 -04:00
function search_theme_directories ( $force = false ) {
2012-02-28 15:05:00 -05:00
global $wp_theme_directories ;
2015-05-29 11:43:29 -04:00
static $found_themes = null ;
2017-11-30 18:11:00 -05:00
if ( empty ( $wp_theme_directories ) ) {
2009-10-13 15:06:35 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2009-10-13 15:06:35 -04:00
2017-11-30 18:11:00 -05:00
if ( ! $force && isset ( $found_themes ) ) {
2012-02-28 15:05:00 -05:00
return $found_themes ;
2017-11-30 18:11:00 -05:00
}
2009-10-13 15:06:35 -04:00
2012-02-28 15:05:00 -05:00
$found_themes = array ();
2009-10-15 16:26:21 -04:00
2012-04-05 16:38:42 -04:00
$wp_theme_directories = ( array ) $wp_theme_directories ;
2014-12-20 17:47:22 -05:00
$relative_theme_roots = array ();
2012-04-05 16:38:42 -04:00
2020-01-28 19:45:18 -05:00
/*
* Set up maybe - relative , maybe - absolute array of theme directories .
* We always want to return absolute , but we need to cache relative
* to use in get_theme_root () .
*/
2012-03-05 20:50:54 -05:00
foreach ( $wp_theme_directories as $theme_root ) {
Code Modernization: Replace usage of `strpos()` with `str_starts_with()`.
`str_starts_with()` was introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins with the given substring (needle).
WordPress core includes a polyfill for `str_starts_with()` on PHP < 8.0 as of WordPress 5.9.
This commit replaces `0 === strpos( ... )` with `str_starts_with()` in core files, making the code more readable and consistent, as well as improving performance.
While `strpos()` is slightly faster than the polyfill on PHP < 8.0, `str_starts_with()` is noticeably faster on PHP 8.0+, as it is optimized to avoid unnecessarily searching along the whole haystack if it does not find the needle.
Follow-up to [52039], [52040], [52326].
Props spacedmonkey, costdev, sabernhardt, mukesh27, desrosj, jorbin, TobiasBg, ayeshrajans, lgadzhev, SergeyBiryukov.
Fixes #58012.
Built from https://develop.svn.wordpress.org/trunk@55703
git-svn-id: http://core.svn.wordpress.org/trunk@55215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-02 11:45:22 -04:00
if ( str_starts_with ( $theme_root , WP_CONTENT_DIR ) ) {
2012-03-05 20:50:54 -05:00
$relative_theme_roots [ str_replace ( WP_CONTENT_DIR , '' , $theme_root ) ] = $theme_root ;
2017-11-30 18:11:00 -05:00
} else {
2012-03-05 20:50:54 -05:00
$relative_theme_roots [ $theme_root ] = $theme_root ;
2017-11-30 18:11:00 -05:00
}
2012-03-05 20:50:54 -05:00
}
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters whether to get the cache of the registered theme directories .
2013-12-01 12:24:11 -05:00
*
* @ since 3.4 . 0
*
* @ param bool $cache_expiration Whether to get the cache of the theme directories . Default false .
2020-06-27 08:02:03 -04:00
* @ param string $context The class or function name calling the filter .
2013-12-01 12:24:11 -05:00
*/
2019-07-02 19:42:58 -04:00
$cache_expiration = apply_filters ( 'wp_cache_themes_persistently' , false , 'search_theme_directories' );
2020-06-27 08:02:03 -04:00
2019-07-02 19:42:58 -04:00
if ( $cache_expiration ) {
2012-02-28 15:05:00 -05:00
$cached_roots = get_site_transient ( 'theme_roots' );
if ( is_array ( $cached_roots ) ) {
foreach ( $cached_roots as $theme_dir => $theme_root ) {
2012-04-20 09:22:54 -04:00
// A cached theme root is no longer around, so skip it.
2017-11-30 18:11:00 -05:00
if ( ! isset ( $relative_theme_roots [ $theme_root ] ) ) {
2012-04-20 09:22:54 -04:00
continue ;
2017-11-30 18:11:00 -05:00
}
2012-02-28 15:05:00 -05:00
$found_themes [ $theme_dir ] = array (
'theme_file' => $theme_dir . '/style.css' ,
2012-03-05 20:50:54 -05:00
'theme_root' => $relative_theme_roots [ $theme_root ], // Convert relative to absolute.
2012-02-28 15:05:00 -05:00
);
}
return $found_themes ;
}
2017-11-30 18:11:00 -05:00
if ( ! is_int ( $cache_expiration ) ) {
2020-01-28 19:45:18 -05:00
$cache_expiration = 30 * MINUTE_IN_SECONDS ;
2017-11-30 18:11:00 -05:00
}
2012-02-28 15:05:00 -05:00
} else {
2020-01-28 19:45:18 -05:00
$cache_expiration = 30 * MINUTE_IN_SECONDS ;
2012-02-28 15:05:00 -05:00
}
2009-10-13 15:06:35 -04:00
2012-02-28 15:05:00 -05:00
/* Loop the registered theme directories and extract all themes */
foreach ( $wp_theme_directories as $theme_root ) {
2009-10-13 15:06:35 -04:00
2022-01-20 18:53:05 -05:00
// Start with directories in the root of the active theme directory.
2012-02-28 15:05:00 -05:00
$dirs = @ scandir ( $theme_root );
2013-08-05 17:40:28 -04:00
if ( ! $dirs ) {
trigger_error ( " $theme_root is not readable " , E_USER_NOTICE );
continue ;
}
2012-02-28 15:05:00 -05:00
foreach ( $dirs as $dir ) {
2020-02-09 11:55:09 -05:00
if ( ! is_dir ( $theme_root . '/' . $dir ) || '.' === $dir [ 0 ] || 'CVS' === $dir ) {
2012-02-28 15:05:00 -05:00
continue ;
2017-11-30 18:11:00 -05:00
}
2012-02-28 15:05:00 -05:00
if ( file_exists ( $theme_root . '/' . $dir . '/style.css' ) ) {
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* wp - content / themes / a - single - theme
* wp - content / themes is $theme_root , a - single - theme is $dir .
*/
2012-02-28 15:05:00 -05:00
$found_themes [ $dir ] = array (
'theme_file' => $dir . '/style.css' ,
'theme_root' => $theme_root ,
);
} else {
$found_theme = false ;
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* wp - content / themes / a - folder - of - themes /*
* wp - content / themes is $theme_root , a - folder - of - themes is $dir , then themes are $sub_dirs .
*/
2012-02-28 15:05:00 -05:00
$sub_dirs = @ scandir ( $theme_root . '/' . $dir );
2013-08-05 17:40:28 -04:00
if ( ! $sub_dirs ) {
trigger_error ( " $theme_root / $dir is not readable " , E_USER_NOTICE );
continue ;
}
2012-02-28 15:05:00 -05:00
foreach ( $sub_dirs as $sub_dir ) {
2020-02-09 11:55:09 -05:00
if ( ! is_dir ( $theme_root . '/' . $dir . '/' . $sub_dir ) || '.' === $dir [ 0 ] || 'CVS' === $dir ) {
2012-02-28 15:05:00 -05:00
continue ;
2017-11-30 18:11:00 -05:00
}
if ( ! file_exists ( $theme_root . '/' . $dir . '/' . $sub_dir . '/style.css' ) ) {
2012-02-28 15:05:00 -05:00
continue ;
2017-11-30 18:11:00 -05:00
}
2012-02-28 15:05:00 -05:00
$found_themes [ $dir . '/' . $sub_dir ] = array (
'theme_file' => $dir . '/' . $sub_dir . '/style.css' ,
'theme_root' => $theme_root ,
);
2017-11-30 18:11:00 -05:00
$found_theme = true ;
2009-10-13 15:06:35 -04:00
}
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* Never mind the above , it ' s just a theme missing a style . css .
* Return it ; WP_Theme will catch the error .
*/
2017-11-30 18:11:00 -05:00
if ( ! $found_theme ) {
2012-02-28 15:05:00 -05:00
$found_themes [ $dir ] = array (
'theme_file' => $dir . '/style.css' ,
'theme_root' => $theme_root ,
);
2017-11-30 18:11:00 -05:00
}
2009-10-13 15:06:35 -04:00
}
}
}
2012-02-28 15:05:00 -05:00
asort ( $found_themes );
2017-11-30 18:11:00 -05:00
$theme_roots = array ();
2012-03-05 20:50:54 -05:00
$relative_theme_roots = array_flip ( $relative_theme_roots );
2012-02-28 15:05:00 -05:00
foreach ( $found_themes as $theme_dir => $theme_data ) {
2012-03-05 20:50:54 -05:00
$theme_roots [ $theme_dir ] = $relative_theme_roots [ $theme_data [ 'theme_root' ] ]; // Convert absolute to relative.
2012-02-28 15:05:00 -05:00
}
2020-02-09 11:55:09 -05:00
if ( get_site_transient ( 'theme_roots' ) != $theme_roots ) {
2012-02-28 15:05:00 -05:00
set_site_transient ( 'theme_roots' , $theme_roots , $cache_expiration );
2017-11-30 18:11:00 -05:00
}
2012-02-28 15:05:00 -05:00
return $found_themes ;
2009-10-13 15:06:35 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves path to themes directory .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* Does not have trailing slash .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2019-10-04 19:20:58 -04:00
* @ param string $stylesheet_or_template Optional . The stylesheet or template name of the theme .
* Default is to leverage the main theme root .
* @ return string Themes directory path .
2008-09-01 01:44:16 -04:00
*/
2019-10-04 19:20:58 -04:00
function get_theme_root ( $stylesheet_or_template = '' ) {
2012-02-28 13:02:21 -05:00
global $wp_theme_directories ;
2019-07-02 19:42:58 -04:00
$theme_root = '' ;
if ( $stylesheet_or_template ) {
$theme_root = get_raw_theme_root ( $stylesheet_or_template );
if ( $theme_root ) {
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* 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 .
*/
2020-04-04 23:02:11 -04:00
if ( ! in_array ( $theme_root , ( array ) $wp_theme_directories , true ) ) {
2019-07-02 19:42:58 -04:00
$theme_root = WP_CONTENT_DIR . $theme_root ;
}
2017-11-30 18:11:00 -05:00
}
2019-07-02 19:42:58 -04:00
}
if ( ! $theme_root ) {
2009-10-13 15:06:35 -04:00
$theme_root = WP_CONTENT_DIR . '/themes' ;
2012-02-28 11:22:26 -05:00
}
2009-12-08 16:29:12 -05:00
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters the absolute path to the themes directory .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
* @ param string $theme_root Absolute path to themes directory .
*/
2009-10-13 15:06:35 -04:00
return apply_filters ( 'theme_root' , $theme_root );
2006-04-18 00:44:33 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves URI for themes directory .
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* Does not have trailing slash .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2019-10-04 19:20:58 -04: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 . Default empty .
* @ return string Themes directory URI .
2008-09-01 01:44:16 -04:00
*/
2019-10-04 19:20:58 -04:00
function get_theme_root_uri ( $stylesheet_or_template = '' , $theme_root = '' ) {
2012-02-28 13:02:21 -05:00
global $wp_theme_directories ;
2017-11-30 18:11:00 -05:00
if ( $stylesheet_or_template && ! $theme_root ) {
2012-03-08 13:18:10 -05:00
$theme_root = get_raw_theme_root ( $stylesheet_or_template );
2017-11-30 18:11:00 -05:00
}
2012-03-08 13:18:10 -05:00
if ( $stylesheet_or_template && $theme_root ) {
2020-04-04 23:02:11 -04:00
if ( in_array ( $theme_root , ( array ) $wp_theme_directories , true ) ) {
2012-02-28 13:02:21 -05:00
// Absolute path. Make an educated guess. YMMV -- but note the filter below.
Code Modernization: Replace usage of `strpos()` with `str_starts_with()`.
`str_starts_with()` was introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins with the given substring (needle).
WordPress core includes a polyfill for `str_starts_with()` on PHP < 8.0 as of WordPress 5.9.
This commit replaces `0 === strpos( ... )` with `str_starts_with()` in core files, making the code more readable and consistent, as well as improving performance.
While `strpos()` is slightly faster than the polyfill on PHP < 8.0, `str_starts_with()` is noticeably faster on PHP 8.0+, as it is optimized to avoid unnecessarily searching along the whole haystack if it does not find the needle.
Follow-up to [52039], [52040], [52326].
Props spacedmonkey, costdev, sabernhardt, mukesh27, desrosj, jorbin, TobiasBg, ayeshrajans, lgadzhev, SergeyBiryukov.
Fixes #58012.
Built from https://develop.svn.wordpress.org/trunk@55703
git-svn-id: http://core.svn.wordpress.org/trunk@55215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-02 11:45:22 -04:00
if ( str_starts_with ( $theme_root , WP_CONTENT_DIR ) ) {
2012-02-28 13:02:21 -05:00
$theme_root_uri = content_url ( str_replace ( WP_CONTENT_DIR , '' , $theme_root ) );
Code Modernization: Replace usage of `strpos()` with `str_starts_with()`.
`str_starts_with()` was introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins with the given substring (needle).
WordPress core includes a polyfill for `str_starts_with()` on PHP < 8.0 as of WordPress 5.9.
This commit replaces `0 === strpos( ... )` with `str_starts_with()` in core files, making the code more readable and consistent, as well as improving performance.
While `strpos()` is slightly faster than the polyfill on PHP < 8.0, `str_starts_with()` is noticeably faster on PHP 8.0+, as it is optimized to avoid unnecessarily searching along the whole haystack if it does not find the needle.
Follow-up to [52039], [52040], [52326].
Props spacedmonkey, costdev, sabernhardt, mukesh27, desrosj, jorbin, TobiasBg, ayeshrajans, lgadzhev, SergeyBiryukov.
Fixes #58012.
Built from https://develop.svn.wordpress.org/trunk@55703
git-svn-id: http://core.svn.wordpress.org/trunk@55215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-02 11:45:22 -04:00
} elseif ( str_starts_with ( $theme_root , ABSPATH ) ) {
2012-02-28 13:02:21 -05:00
$theme_root_uri = site_url ( str_replace ( ABSPATH , '' , $theme_root ) );
Code Modernization: Replace usage of `strpos()` with `str_starts_with()`.
`str_starts_with()` was introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins with the given substring (needle).
WordPress core includes a polyfill for `str_starts_with()` on PHP < 8.0 as of WordPress 5.9.
This commit replaces `0 === strpos( ... )` with `str_starts_with()` in core files, making the code more readable and consistent, as well as improving performance.
While `strpos()` is slightly faster than the polyfill on PHP < 8.0, `str_starts_with()` is noticeably faster on PHP 8.0+, as it is optimized to avoid unnecessarily searching along the whole haystack if it does not find the needle.
Follow-up to [52039], [52040], [52326].
Props spacedmonkey, costdev, sabernhardt, mukesh27, desrosj, jorbin, TobiasBg, ayeshrajans, lgadzhev, SergeyBiryukov.
Fixes #58012.
Built from https://develop.svn.wordpress.org/trunk@55703
git-svn-id: http://core.svn.wordpress.org/trunk@55215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-05-02 11:45:22 -04:00
} elseif ( str_starts_with ( $theme_root , WP_PLUGIN_DIR ) || str_starts_with ( $theme_root , WPMU_PLUGIN_DIR ) ) {
2012-02-28 13:02:21 -05:00
$theme_root_uri = plugins_url ( basename ( $theme_root ), $theme_root );
2017-11-30 18:11:00 -05:00
} else {
2012-02-28 13:02:21 -05:00
$theme_root_uri = $theme_root ;
2017-11-30 18:11:00 -05:00
}
2012-02-28 13:02:21 -05:00
} else {
2012-02-28 11:22:26 -05:00
$theme_root_uri = content_url ( $theme_root );
2012-02-28 13:02:21 -05:00
}
2010-09-21 15:41:35 -04:00
} else {
2009-10-13 15:06:35 -04:00
$theme_root_uri = content_url ( 'themes' );
2010-09-21 15:41:35 -04:00
}
2009-10-13 15:06:35 -04:00
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters the URI for themes directory .
2013-12-01 12:24:11 -05:00
*
* @ since 1.5 . 0
*
* @ param string $theme_root_uri The URI for themes directory .
* @ param string $siteurl WordPress web address which is set in General Options .
2019-10-04 19:20:58 -04:00
* @ param string $stylesheet_or_template The stylesheet or template name of the theme .
2013-12-01 12:24:11 -05:00
*/
return apply_filters ( 'theme_root_uri' , $theme_root_uri , get_option ( 'siteurl' ), $stylesheet_or_template );
2006-04-18 00:44:33 -04:00
}
2010-09-21 15:41:35 -04:00
/**
2020-06-27 08:02:03 -04:00
* Gets the raw theme root relative to the content directory with no filters applied .
2010-09-21 15:41:35 -04:00
*
* @ since 3.1 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
*
2019-10-04 19:20:58 -04:00
* @ param string $stylesheet_or_template The stylesheet or template name of the theme .
2015-05-27 18:21:25 -04:00
* @ param bool $skip_cache Optional . Whether to skip the cache .
* Defaults to false , meaning the cache is used .
2019-10-04 19:20:58 -04:00
* @ return string Theme root .
2010-09-21 15:41:35 -04:00
*/
2012-02-28 14:59:53 -05:00
function get_raw_theme_root ( $stylesheet_or_template , $skip_cache = false ) {
2010-09-21 15:41:35 -04:00
global $wp_theme_directories ;
2017-07-27 13:00:44 -04:00
if ( ! is_array ( $wp_theme_directories ) || count ( $wp_theme_directories ) <= 1 ) {
2012-02-28 11:22:26 -05:00
return '/themes' ;
2017-07-27 13:00:44 -04:00
}
2010-09-21 15:41:35 -04:00
$theme_root = false ;
2022-01-20 18:53:05 -05:00
// If requesting the root for the active theme, consult options to avoid calling get_theme_roots().
2012-02-28 14:59:53 -05:00
if ( ! $skip_cache ) {
2017-11-30 18:11:00 -05: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-11-17 11:11:44 -05:00
}
2010-09-21 15:41:35 -04:00
2017-11-30 18:11:00 -05:00
if ( empty ( $theme_root ) ) {
2010-09-21 15:41:35 -04:00
$theme_roots = get_theme_roots ();
2017-11-30 18:11:00 -05:00
if ( ! empty ( $theme_roots [ $stylesheet_or_template ] ) ) {
$theme_root = $theme_roots [ $stylesheet_or_template ];
}
2010-09-21 15:41:35 -04:00
}
return $theme_root ;
}
2008-09-01 01:44:16 -04:00
/**
2020-06-27 08:02:03 -04:00
* Displays localized stylesheet link element .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2006-09-18 19:40:19 -04:00
function locale_stylesheet () {
$stylesheet = get_locale_stylesheet_uri ();
2017-11-30 18:11:00 -05:00
if ( empty ( $stylesheet ) ) {
2006-09-18 19:40:19 -04:00
return ;
2017-11-30 18:11:00 -05:00
}
2019-09-18 10:50:56 -04:00
$type_attr = current_theme_supports ( 'html5' , 'style' ) ? '' : ' type="text/css"' ;
printf (
'<link rel="stylesheet" href="%s"%s media="screen" />' ,
$stylesheet ,
$type_attr
);
2006-09-18 19:40:19 -04:00
}
2008-09-25 10:12:58 -04:00
/**
2012-06-26 01:21:04 -04:00
* Switches the theme .
*
* Accepts one argument : $stylesheet of the theme . It also accepts an additional function signature
2016-05-13 14:41:31 -04:00
* of two arguments : $template then $stylesheet . This is for backward compatibility .
2008-09-25 10:12:58 -04:00
*
2010-12-01 14:24:38 -05:00
* @ since 2.5 . 0
2008-09-25 10:12:58 -04:00
*
2015-05-27 18:21:25 -04:00
* @ global array $wp_theme_directories
* @ global WP_Customize_Manager $wp_customize
* @ global array $sidebars_widgets
Widgets: Preserve classic sidebars when switching to a block theme.
When switching to a block theme, classic sidebars were orphaned and their widgets remapping to the `'wp_inactive_widgets'` sidebar . This changeset preserves the sidebars and their widgets, providing a migration path to a block theme without losing the widgets.
Classic sidebars are now:
* Stored in a new theme mod called `'wp_classic_sidebars'`;
* Restored to the `$wp_registered_sidebars` global variable when the `'widgets_init'` action fires (via a new internal function called `_wp_block_theme_register_classic_sidebars()`);
* And marked as `'inactive'` when interacting with sidebars REST API endpoint.
References:
* [https://github.com/WordPress/gutenberg/pull/45509 Gutenberg PR 45509] which adds an option for importing widgets from sidebars into template parts.
Follow-up to [50995], [6334].
Props mamaduka, audrasjb, hellofromTonya, ironprogrammer, jameskoster, joen, matveb, mukesh27, noisysocks, poena, youknowriad.
Fixes #57531.
Built from https://develop.svn.wordpress.org/trunk@55200
git-svn-id: http://core.svn.wordpress.org/trunk@54733 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-02 19:15:21 -05:00
* @ global array $wp_registered_sidebars
2015-05-27 18:21:25 -04:00
*
2020-06-27 08:02:03 -04:00
* @ param string $stylesheet Stylesheet name .
2008-09-25 10:12:58 -04:00
*/
2012-06-26 01:21:04 -04:00
function switch_theme ( $stylesheet ) {
2023-11-20 17:29:24 -05:00
global $wp_theme_directories , $wp_customize , $sidebars_widgets , $wp_registered_sidebars ;
2011-09-08 15:25:20 -04:00
2020-04-13 11:28:11 -04:00
$requirements = validate_theme_requirements ( $stylesheet );
if ( is_wp_error ( $requirements ) ) {
wp_die ( $requirements );
}
2014-04-14 18:46:16 -04:00
$_sidebars_widgets = null ;
if ( 'wp_ajax_customize_save' === current_action () ) {
2017-09-21 14:46:46 -04:00
$old_sidebars_widgets_data_setting = $wp_customize -> get_setting ( 'old_sidebars_widgets_data' );
if ( $old_sidebars_widgets_data_setting ) {
$_sidebars_widgets = $wp_customize -> post_value ( $old_sidebars_widgets_data_setting );
}
2014-04-14 18:46:16 -04:00
} elseif ( is_array ( $sidebars_widgets ) ) {
$_sidebars_widgets = $sidebars_widgets ;
}
if ( is_array ( $_sidebars_widgets ) ) {
2017-11-30 18:11:00 -05:00
set_theme_mod (
2018-08-16 21:51:36 -04:00
'sidebars_widgets' ,
array (
2017-11-30 18:11:00 -05:00
'time' => time (),
'data' => $_sidebars_widgets ,
)
);
2014-04-14 18:46:16 -04:00
}
2010-09-21 15:41:35 -04:00
2015-08-29 23:01:21 -04:00
$nav_menu_locations = get_theme_mod ( 'nav_menu_locations' );
2017-10-24 14:35:48 -04:00
update_option ( 'theme_switch_menu_locations' , $nav_menu_locations );
2015-08-29 23:01:21 -04:00
2012-06-26 01:21:04 -04:00
if ( func_num_args () > 1 ) {
$stylesheet = func_get_arg ( 1 );
}
2011-09-02 18:13:55 -04:00
2015-08-30 17:45:23 -04:00
$old_theme = wp_get_theme ();
$new_theme = wp_get_theme ( $stylesheet );
$template = $new_theme -> get_template ();
2019-04-05 11:33:52 -04:00
if ( wp_is_recovery_mode () ) {
$paused_themes = wp_paused_themes ();
$paused_themes -> delete ( $old_theme -> get_stylesheet () );
$paused_themes -> delete ( $old_theme -> get_template () );
}
2012-02-29 00:09:29 -05:00
update_option ( 'template' , $template );
update_option ( 'stylesheet' , $stylesheet );
2011-09-02 18:13:55 -04:00
2012-02-29 00:09:29 -05: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 16:51:27 -05:00
} else {
delete_option ( 'template_root' );
delete_option ( 'stylesheet_root' );
2010-09-21 15:41:35 -04:00
}
2011-09-02 18:13:55 -04:00
2017-11-30 18:11:00 -05:00
$new_name = $new_theme -> get ( 'Name' );
2012-06-26 01:21:04 -04:00
2012-02-29 00:09:29 -05:00
update_option ( 'current_theme' , $new_name );
2011-09-02 18:13:55 -04:00
2014-04-14 18:46:16 -04:00
// Migrate from the old mods_{name} option to theme_mods_{slug}.
2012-02-29 00:09:29 -05:00
if ( is_admin () && false === get_option ( 'theme_mods_' . $stylesheet ) ) {
$default_theme_mods = ( array ) get_option ( 'mods_' . $new_name );
2015-08-29 23:01:21 -04:00
if ( ! empty ( $nav_menu_locations ) && empty ( $default_theme_mods [ 'nav_menu_locations' ] ) ) {
$default_theme_mods [ 'nav_menu_locations' ] = $nav_menu_locations ;
}
2010-12-15 12:39:00 -05:00
add_option ( " theme_mods_ $stylesheet " , $default_theme_mods );
2014-04-14 18:46:16 -04:00
} else {
/*
2021-09-09 17:40:57 -04:00
* Since retrieve_widgets () is called when initializing a theme in the Customizer ,
2015-12-06 16:50:25 -05:00
* we need to remove the theme mods to avoid overwriting changes made via
2014-10-15 13:21:19 -04:00
* the Customizer when accessing wp - admin / widgets . php .
2014-04-14 18:46:16 -04:00
*/
if ( 'wp_ajax_customize_save' === current_action () ) {
remove_theme_mod ( 'sidebars_widgets' );
}
2010-12-15 12:39:00 -05:00
}
2011-09-02 18:13:55 -04:00
Widgets: Preserve classic sidebars when switching to a block theme.
When switching to a block theme, classic sidebars were orphaned and their widgets remapping to the `'wp_inactive_widgets'` sidebar . This changeset preserves the sidebars and their widgets, providing a migration path to a block theme without losing the widgets.
Classic sidebars are now:
* Stored in a new theme mod called `'wp_classic_sidebars'`;
* Restored to the `$wp_registered_sidebars` global variable when the `'widgets_init'` action fires (via a new internal function called `_wp_block_theme_register_classic_sidebars()`);
* And marked as `'inactive'` when interacting with sidebars REST API endpoint.
References:
* [https://github.com/WordPress/gutenberg/pull/45509 Gutenberg PR 45509] which adds an option for importing widgets from sidebars into template parts.
Follow-up to [50995], [6334].
Props mamaduka, audrasjb, hellofromTonya, ironprogrammer, jameskoster, joen, matveb, mukesh27, noisysocks, poena, youknowriad.
Fixes #57531.
Built from https://develop.svn.wordpress.org/trunk@55200
git-svn-id: http://core.svn.wordpress.org/trunk@54733 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-02 19:15:21 -05:00
// Stores classic sidebars for later use by block themes.
if ( $new_theme -> is_block_theme () ) {
set_theme_mod ( 'wp_classic_sidebars' , $wp_registered_sidebars );
}
2012-03-08 16:22:24 -05:00
update_option ( 'theme_switched' , $old_theme -> get_stylesheet () );
2016-02-07 03:26:25 -05:00
2024-02-21 14:26:08 -05:00
/*
* Reset template globals when switching themes outside of a switched blog
* context to ensure templates will be loaded from the new theme .
*/
if ( ! is_multisite () || ! ms_is_switched () ) {
wp_set_template_globals ();
}
Editor: Improve performance of _register_theme_block_patterns function.
The `_register_theme_block_patterns` function imposed a significant resource overhead. This issue primarily stems from themes, such as TT4, that register a substantial number of block patterns. These patterns necessitate numerous file operations, including file lookups, file reading into memory, and related processes. To provide an overview, the _register_theme_block_patterns function performed the following file operations:
- is_dir
- is_readable
- file_exists
- glob
- file_get_contents (utilized via get_file_data)
To address these issues, caching using a transient has been added to a new function call `_wp_get_block_patterns`. If theme development mode is disabled and theme exists, the block patterns are saved in a transient cache. This cache is used all requests after that, saving file lookups and reading files into memory. Cache invalidation is done, when themes are switched, deleted or updated. Meaning that block patterns are not stored in the cache incorrectly.
Props flixos90, joemcgill, peterwilsoncc, costdev, swissspidy, aristath, westonruter, spacedmonkey.
Fixes #59490
Built from https://develop.svn.wordpress.org/trunk@56765
git-svn-id: http://core.svn.wordpress.org/trunk@56277 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-03 11:18:19 -04:00
// Clear pattern caches.
2024-02-13 03:54:11 -05:00
if ( ! is_multisite () ) {
$new_theme -> delete_pattern_cache ();
$old_theme -> delete_pattern_cache ();
}
Editor: Improve performance of _register_theme_block_patterns function.
The `_register_theme_block_patterns` function imposed a significant resource overhead. This issue primarily stems from themes, such as TT4, that register a substantial number of block patterns. These patterns necessitate numerous file operations, including file lookups, file reading into memory, and related processes. To provide an overview, the _register_theme_block_patterns function performed the following file operations:
- is_dir
- is_readable
- file_exists
- glob
- file_get_contents (utilized via get_file_data)
To address these issues, caching using a transient has been added to a new function call `_wp_get_block_patterns`. If theme development mode is disabled and theme exists, the block patterns are saved in a transient cache. This cache is used all requests after that, saving file lookups and reading files into memory. Cache invalidation is done, when themes are switched, deleted or updated. Meaning that block patterns are not stored in the cache incorrectly.
Props flixos90, joemcgill, peterwilsoncc, costdev, swissspidy, aristath, westonruter, spacedmonkey.
Fixes #59490
Built from https://develop.svn.wordpress.org/trunk@56765
git-svn-id: http://core.svn.wordpress.org/trunk@56277 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-03 11:18:19 -04:00
2023-12-04 14:38:22 -05:00
// Set autoload=no for the old theme, autoload=yes for the switched theme.
$theme_mods_options = array (
'theme_mods_' . $stylesheet => 'yes' ,
'theme_mods_' . $old_theme -> get_stylesheet () => 'no' ,
);
wp_set_option_autoload_values ( $theme_mods_options );
2013-12-01 12:24:11 -05:00
/**
* Fires after the theme is switched .
*
2023-04-27 19:15:17 -04:00
* See { @ see 'after_switch_theme' } .
*
2013-12-01 12:24:11 -05:00
* @ since 1.5 . 0
2016-02-07 03:26:25 -05:00
* @ since 4.5 . 0 Introduced the `$old_theme` parameter .
2013-12-01 12:24:11 -05:00
*
* @ param string $new_name Name of the new theme .
* @ param WP_Theme $new_theme WP_Theme instance of the new theme .
2016-02-07 03:26:25 -05:00
* @ param WP_Theme $old_theme WP_Theme instance of the old theme .
2013-12-01 12:24:11 -05:00
*/
2016-02-07 03:26:25 -05:00
do_action ( 'switch_theme' , $new_name , $new_theme , $old_theme );
2007-11-13 00:07:44 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2022-03-16 14:30:03 -04:00
* Checks that the active theme has the required files .
*
* Standalone themes need to have a `templates/index.html` or `index.php` template file .
* Child themes need to have a `Template` header in the `style.css` stylesheet .
2008-09-01 01:44:16 -04:00
*
2015-11-25 16:45:25 -05:00
* Does not initially check the default theme , which is the fallback and should always exist .
* But if it doesn 't exist, it' ll fall back to the latest core default theme that does exist .
2022-01-20 18:53:05 -05:00
* Will switch theme to the fallback theme if active theme does not validate .
2015-11-25 16:45:25 -05:00
*
2020-06-27 08:02:03 -04:00
* You can use the { @ see 'validate_current_theme' } filter to return false to disable
* this functionality .
2008-09-01 01:44:16 -04:00
*
* @ since 1.5 . 0
2022-03-16 14:30:03 -04:00
* @ since 6.0 . 0 Removed the requirement for block themes to have an `index.php` template .
2020-06-16 17:07:14 -04:00
*
2010-05-06 15:53:40 -04:00
* @ see WP_DEFAULT_THEME
2008-09-01 01:44:16 -04:00
*
2008-09-24 01:24:33 -04:00
* @ return bool
2008-09-01 01:44:16 -04:00
*/
2006-07-11 18:44:56 -04:00
function validate_current_theme () {
2013-12-01 12:24:11 -05:00
/**
2022-01-20 18:53:05 -05:00
* Filters whether to validate the active theme .
2013-12-01 12:24:11 -05:00
*
* @ since 2.7 . 0
*
2022-01-20 18:53:05 -05:00
* @ param bool $validate Whether to validate the active theme . Default true .
2013-12-01 12:24:11 -05:00
*/
2017-11-30 18:11:00 -05:00
if ( wp_installing () || ! apply_filters ( 'validate_current_theme' , true ) ) {
2006-07-21 15:00:04 -04:00
return true ;
2017-11-30 18:11:00 -05:00
}
2006-07-21 15:00:04 -04:00
Themes: Accept valid block themes.
Updates theme validation to accept block themes. This replaces the requirement for an `index.php` with a requirement for either an `index.php`, `/templates/index.html` or the deprecated `/block-templates/index.html`.
Validation is updated for theme uploads, within `WP_Theme::__construct` and `validate_current_theme()`.
A block theme using the deprecated file structure is now included in the unit tests.
Props peterwilsoncc, sergeybiryukov, hellofromtonya, costdev, azaozz, gziolo, FlorianBrinkmann, Boniu91, aristath, poena, audrasjb.
Fixes #55754.
Built from https://develop.svn.wordpress.org/trunk@53416
git-svn-id: http://core.svn.wordpress.org/trunk@53005 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-05-19 20:49:18 -04:00
if (
! file_exists ( get_template_directory () . '/templates/index.html' )
&& ! file_exists ( get_template_directory () . '/block-templates/index.html' ) // Deprecated path support since 5.9.0.
2022-03-16 14:30:03 -04:00
&& ! file_exists ( get_template_directory () . '/index.php' )
) {
2015-11-25 16:45:25 -05:00
// Invalid.
} elseif ( ! file_exists ( get_template_directory () . '/style.css' ) ) {
// Invalid.
} elseif ( is_child_theme () && ! file_exists ( get_stylesheet_directory () . '/style.css' ) ) {
// Invalid.
} else {
// Valid.
return true ;
2006-07-11 18:44:56 -04:00
}
2015-11-25 16:45:25 -05:00
$default = wp_get_theme ( WP_DEFAULT_THEME );
if ( $default -> exists () ) {
2012-06-26 01:21:04 -04:00
switch_theme ( WP_DEFAULT_THEME );
2006-07-11 18:44:56 -04:00
return false ;
}
2010-12-14 14:19:47 -05:00
2015-11-25 16:45:25 -05:00
/**
* If we 're in an invalid state but WP_DEFAULT_THEME doesn' t exist ,
* switch to the latest core default theme that ' s installed .
2020-06-27 08:02:03 -04:00
*
2015-11-25 16:45:25 -05:00
* If it turns out that this latest core default theme is our current
* theme , then there ' s nothing we can do about that , so we have to bail ,
* rather than going into an infinite loop . ( This is why there are
* checks against WP_DEFAULT_THEME above , also . ) We also can ' t do anything
* if it turns out there is no default theme installed . ( That ' s `false` . )
*/
$default = WP_Theme :: get_core_default_theme ();
if ( false === $default || get_stylesheet () == $default -> get_stylesheet () ) {
return true ;
2010-12-14 14:17:49 -05:00
}
2006-07-11 18:44:56 -04:00
2015-11-25 16:45:25 -05:00
switch_theme ( $default -> get_stylesheet () );
return false ;
2006-07-11 18:44:56 -04:00
}
2020-04-13 11:28:11 -04:00
/**
* Validates the theme requirements for WordPress version and PHP version .
*
* Uses the information from `Requires at least` and `Requires PHP` headers
* defined in the theme ' s `style.css` file .
*
* @ since 5.5 . 0
Upgrade/Install: Remove parsing of `readme.txt` files for plugin or theme requirements.
This affects:
* `validate_plugin_requirements()`
* `validate_theme_requirements()`
Historically, the `Requires PHP` header was introduced in #meta2952 for the Plugin Directory first, so at the time it made sense to have it defined in the same place as `Requires at least`, which only existed in `readme.txt`.
Since parsing of PHP and WordPress requirements was later added to WordPress core, the core should retrieve all the necessary data from the main plugin or theme file and not from `readme.txt`, which only contains the data meant for the Plugin or Theme Directory.
The recommended place for `Requires PHP` and `Requires at least` headers is as follows:
* The plugin's main PHP file
* The theme's `style.css` file
The place for the `Tested up to` header remains in `readme.txt` for the time being, as it's not used by WordPress core.
Follow-up to [44978], [45546], [47573], [47574], [meta5841], [meta9050].
Props afragen, Otto42, joyously, williampatton, audrasjb.
Fixes #48520. See #48515, #meta2952, #meta4514, #meta4621.
Built from https://develop.svn.wordpress.org/trunk@51092
git-svn-id: http://core.svn.wordpress.org/trunk@50701 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-06-08 06:13:00 -04:00
* @ since 5.8 . 0 Removed support for using `readme.txt` as a fallback .
2020-04-13 11:28:11 -04:00
*
* @ param string $stylesheet Directory name for the theme .
* @ return true | WP_Error True if requirements are met , WP_Error on failure .
*/
function validate_theme_requirements ( $stylesheet ) {
$theme = wp_get_theme ( $stylesheet );
$requirements = array (
'requires' => ! empty ( $theme -> get ( 'RequiresWP' ) ) ? $theme -> get ( 'RequiresWP' ) : '' ,
'requires_php' => ! empty ( $theme -> get ( 'RequiresPHP' ) ) ? $theme -> get ( 'RequiresPHP' ) : '' ,
);
$compatible_wp = is_wp_version_compatible ( $requirements [ 'requires' ] );
$compatible_php = is_php_version_compatible ( $requirements [ 'requires_php' ] );
if ( ! $compatible_wp && ! $compatible_php ) {
return new WP_Error (
'theme_wp_php_incompatible' ,
sprintf (
/* translators: %s: Theme name. */
2020-06-21 10:00:09 -04:00
_x ( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.' , 'theme' ),
2020-04-13 11:28:11 -04:00
$theme -> display ( 'Name' )
)
);
} elseif ( ! $compatible_php ) {
return new WP_Error (
'theme_php_incompatible' ,
sprintf (
/* translators: %s: Theme name. */
2020-06-21 10:00:09 -04:00
_x ( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.' , 'theme' ),
2020-04-13 11:28:11 -04:00
$theme -> display ( 'Name' )
)
);
} elseif ( ! $compatible_wp ) {
return new WP_Error (
'theme_wp_incompatible' ,
sprintf (
/* translators: %s: Theme name. */
2020-06-21 10:00:09 -04:00
_x ( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.' , 'theme' ),
2020-04-13 11:28:11 -04:00
$theme -> display ( 'Name' )
)
);
}
return true ;
}
2010-10-06 17:00:17 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves all theme modifications .
2010-10-06 17:00:17 -04:00
*
* @ since 3.1 . 0
2021-08-01 10:55:56 -04:00
* @ since 5.9 . 0 The return value is always an array .
2010-10-06 17:00:17 -04:00
*
2021-08-01 10:55:56 -04:00
* @ return array Theme modifications .
2010-10-06 17:00:17 -04:00
*/
function get_theme_mods () {
$theme_slug = get_option ( 'stylesheet' );
2017-11-30 18:11:00 -05:00
$mods = get_option ( " theme_mods_ $theme_slug " );
2021-08-01 10:55:56 -04:00
2015-05-28 01:51:25 -04:00
if ( false === $mods ) {
2012-02-29 15:07:22 -05:00
$theme_name = get_option ( 'current_theme' );
2017-11-30 18:11:00 -05:00
if ( false === $theme_name ) {
$theme_name = wp_get_theme () -> get ( 'Name' );
}
2021-08-01 10:55:56 -04:00
2010-10-07 01:59:50 -04:00
$mods = get_option ( " mods_ $theme_name " ); // Deprecated location.
2010-10-06 17:00:17 -04:00
if ( is_admin () && false !== $mods ) {
update_option ( " theme_mods_ $theme_slug " , $mods );
delete_option ( " mods_ $theme_name " );
}
}
2021-08-01 10:55:56 -04:00
if ( ! is_array ( $mods ) ) {
$mods = array ();
}
2015-05-28 01:51:25 -04:00
return $mods ;
2010-10-06 17:00:17 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Retrieves theme modification value for the active theme .
2008-09-01 01:44:16 -04:00
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
* If the modification name does not exist and `$default_value` is a string , then the
2021-08-07 09:55:04 -04:00
* default will be passed through the { @ link https :// www . php . net / sprintf sprintf ()}
* PHP function with the template directory URI as the first value and the
* stylesheet directory URI as the second value .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
* @ param string $name Theme modification name .
* @ param mixed $default_value Optional . Theme modification default value . Default false .
2019-10-04 20:40:58 -04:00
* @ return mixed Theme modification value .
2008-09-01 01:44:16 -04:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
function get_theme_mod ( $name , $default_value = false ) {
2010-10-06 17:00:17 -04:00
$mods = get_theme_mods ();
2006-10-16 02:06:18 -04:00
2017-11-30 18:11:00 -05:00
if ( isset ( $mods [ $name ] ) ) {
2013-12-01 12:24:11 -05:00
/**
2016-05-22 14:18:29 -04:00
* Filters the theme modification , or 'theme_mod' , value .
2013-12-01 12:24:11 -05:00
*
2019-10-04 20:40:58 -04:00
* 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 .
2013-12-01 12:24:11 -05:00
*
* @ since 2.2 . 0
*
2022-01-20 18:53:05 -05:00
* @ param mixed $current_mod The value of the active theme modification .
2013-12-01 12:24:11 -05:00
*/
2017-11-30 18:11:00 -05:00
return apply_filters ( " theme_mod_ { $name } " , $mods [ $name ] );
2013-12-01 12:24:11 -05:00
}
2006-10-16 02:06:18 -04:00
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
if ( is_string ( $default_value ) ) {
Themes: In `get_theme_mod()`, only run the `sprintf()` replacement on the default value if there's a string format pattern found in the value.
This prevents standalone percent symbols from being stripped out, e.g. in a default value like `100%`.
Props aristath, kuus, moonomo, westonruter, davetgreen, daviedR, katielgc, noisysocks, SergeyBiryukov.
Fixes #34290.
Built from https://develop.svn.wordpress.org/trunk@46395
git-svn-id: http://core.svn.wordpress.org/trunk@46194 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-10-04 20:54:58 -04:00
// Only run the replacement if an sprintf() string format pattern was found.
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
if ( preg_match ( '#(?<!%)%(?:\d+\$?)?s#' , $default_value ) ) {
2020-09-29 06:03:08 -04:00
// Remove a single trailing percent sign.
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
$default_value = preg_replace ( '#(?<!%)%$#' , '' , $default_value );
$default_value = sprintf ( $default_value , get_template_directory_uri (), get_stylesheet_directory_uri () );
Themes: In `get_theme_mod()`, only run the `sprintf()` replacement on the default value if there's a string format pattern found in the value.
This prevents standalone percent symbols from being stripped out, e.g. in a default value like `100%`.
Props aristath, kuus, moonomo, westonruter, davetgreen, daviedR, katielgc, noisysocks, SergeyBiryukov.
Fixes #34290.
Built from https://develop.svn.wordpress.org/trunk@46395
git-svn-id: http://core.svn.wordpress.org/trunk@46194 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-10-04 20:54:58 -04:00
}
2017-11-30 18:11:00 -05:00
}
2012-02-02 18:35:37 -05:00
2013-12-01 12:24:11 -05:00
/** This filter is documented in wp-includes/theme.php */
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
return apply_filters ( " theme_mod_ { $name } " , $default_value );
2006-10-16 02:06:18 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Updates theme modification value for the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
2020-10-19 18:45:03 -04:00
* @ since 5.6 . 0 A return value was added .
2008-09-01 01:44:16 -04:00
*
2015-05-27 18:21:25 -04:00
* @ param string $name Theme modification name .
* @ param mixed $value Theme modification value .
2020-10-19 18:45:03 -04:00
* @ return bool True if the value was updated , false otherwise .
2008-09-01 01:44:16 -04:00
*/
2010-10-07 01:59:50 -04:00
function set_theme_mod ( $name , $value ) {
2017-11-30 18:11:00 -05:00
$mods = get_theme_mods ();
2014-03-04 20:13:14 -05:00
$old_value = isset ( $mods [ $name ] ) ? $mods [ $name ] : false ;
2006-10-16 02:06:18 -04:00
2014-03-04 02:02:13 -05:00
/**
2019-10-04 20:40:58 -04:00
* Filters the theme modification , or 'theme_mod' , value on save .
2014-03-04 02:02:13 -05:00
*
2019-10-04 20:40:58 -04:00
* The dynamic portion of the hook name , `$name` , refers to the key name
* of the modification array . For example , 'header_textcolor' , 'header_image' ,
2014-03-04 02:02:13 -05:00
* and so on depending on the theme options .
*
* @ since 3.9 . 0
*
2021-08-07 09:55:04 -04:00
* @ param mixed $value The new value of the theme modification .
* @ param mixed $old_value The current value of the theme modification .
2014-03-04 02:02:13 -05:00
*/
2016-08-22 14:25:31 -04:00
$mods [ $name ] = apply_filters ( " pre_set_theme_mod_ { $name } " , $value , $old_value );
2006-10-16 02:06:18 -04:00
2010-10-06 17:00:17 -04:00
$theme = get_option ( 'stylesheet' );
2020-10-19 18:45:03 -04:00
return update_option ( " theme_mods_ $theme " , $mods );
2006-10-16 02:06:18 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Removes theme modification name from active theme list .
2008-09-01 01:44:16 -04:00
*
2020-06-27 08:02:03 -04:00
* If removing the name also removes all elements , then the entire option
* will be removed .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
2008-09-24 01:24:33 -04:00
* @ param string $name Theme modification name .
2008-09-01 01:44:16 -04:00
*/
2007-01-03 18:49:34 -05:00
function remove_theme_mod ( $name ) {
2010-10-06 17:00:17 -04:00
$mods = get_theme_mods ();
2007-01-03 18:49:34 -05:00
2017-11-30 18:11:00 -05:00
if ( ! isset ( $mods [ $name ] ) ) {
2007-01-03 18:49:34 -05:00
return ;
2017-11-30 18:11:00 -05:00
}
2007-01-03 18:49:34 -05:00
2010-10-07 01:59:50 -04:00
unset ( $mods [ $name ] );
2007-01-03 18:49:34 -05:00
2015-05-27 18:21:25 -04:00
if ( empty ( $mods ) ) {
remove_theme_mods ();
return ;
}
2020-10-19 18:45:03 -04:00
2010-10-06 17:00:17 -04:00
$theme = get_option ( 'stylesheet' );
2020-10-19 18:45:03 -04:00
2010-10-06 17:00:17 -04:00
update_option ( " theme_mods_ $theme " , $mods );
2007-01-03 18:49:34 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Removes theme modifications option for the active theme .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2006-10-16 02:06:18 -04:00
function remove_theme_mods () {
2010-10-06 17:00:17 -04:00
delete_option ( 'theme_mods_' . get_option ( 'stylesheet' ) );
2012-02-29 15:07:22 -05:00
// Old style.
$theme_name = get_option ( 'current_theme' );
2017-11-30 18:11:00 -05:00
if ( false === $theme_name ) {
$theme_name = wp_get_theme () -> get ( 'Name' );
}
2020-10-19 18:45:03 -04:00
2012-02-29 15:07:22 -05:00
delete_option ( 'mods_' . $theme_name );
2006-10-16 02:06:18 -04:00
}
2008-09-01 01:44:16 -04:00
/**
2017-01-12 00:56:40 -05:00
* Retrieves the custom header text color in 3 - or 6 - digit hexadecimal form .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
2017-01-12 00:56:40 -05:00
* @ return string Header text color in 3 - or 6 - digit hexadecimal form ( minus the hash symbol ) .
2008-09-01 01:44:16 -04:00
*/
2007-01-03 18:49:34 -05:00
function get_header_textcolor () {
2017-11-30 18:11:00 -05:00
return get_theme_mod ( 'header_textcolor' , get_theme_support ( 'custom-header' , 'default-text-color' ) );
2007-01-03 18:49:34 -05:00
}
2008-09-01 01:44:16 -04:00
/**
2017-01-12 00:56:40 -05:00
* Displays the custom header text color in 3 - or 6 - digit hexadecimal form ( minus the hash symbol ) .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2007-01-03 18:49:34 -05:00
function header_textcolor () {
2007-02-27 10:24:54 -05:00
echo get_header_textcolor ();
2007-01-03 18:49:34 -05:00
}
2012-03-21 14:48:57 -04:00
/**
* Whether to display the header text .
*
* @ since 3.4 . 0
*
* @ return bool
*/
function display_header_text () {
2017-11-30 18:11:00 -05:00
if ( ! current_theme_supports ( 'custom-header' , 'header-text' ) ) {
2012-03-21 14:48:57 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2012-03-21 14:48:57 -04:00
$text_color = get_theme_mod ( 'header_textcolor' , get_theme_support ( 'custom-header' , 'default-text-color' ) );
2015-05-27 18:21:25 -04:00
return 'blank' !== $text_color ;
2012-03-21 14:48:57 -04:00
}
2015-01-17 01:34:23 -05:00
/**
2020-06-27 08:02:03 -04:00
* Checks whether a header image is set or not .
2015-01-17 01:34:23 -05:00
*
* @ since 4.2 . 0
*
2015-04-05 13:11:28 -04:00
* @ see get_header_image ()
*
* @ return bool Whether a header image is set or not .
2015-01-17 01:34:23 -05:00
*/
function has_header_image () {
return ( bool ) get_header_image ();
}
2008-09-01 01:44:16 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves header image for custom header .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*
2015-03-08 22:11:28 -04:00
* @ return string | false
2008-09-01 01:44:16 -04:00
*/
2007-01-03 18:49:34 -05: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 13:12:44 -04:00
$url = get_theme_mod ( 'header_image' , get_theme_support ( 'custom-header' , 'default-image' ) );
2010-12-09 12:59:35 -05:00
2020-05-16 14:42:12 -04:00
if ( 'remove-header' === $url ) {
2011-04-29 15:45:30 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2011-04-29 15:45:30 -04:00
2017-11-30 18:11:00 -05:00
if ( is_random_header_image () ) {
2011-04-28 19:02:16 -04:00
$url = get_random_header_image ();
2017-11-30 18:11:00 -05:00
}
2011-04-28 19:02:16 -04:00
2022-07-20 17:13:09 -04:00
/**
* Filters the header image URL .
*
* @ since 6.1 . 0
*
* @ param string $url Header image URL .
*/
$url = apply_filters ( 'get_header_image' , $url );
if ( ! is_string ( $url ) ) {
return false ;
}
$url = trim ( $url );
2022-06-01 14:14:10 -04:00
return sanitize_url ( set_url_scheme ( $url ) );
2007-01-03 18:49:34 -05:00
}
2015-11-09 20:17:26 -05:00
/**
2020-06-27 08:02:03 -04:00
* Creates image tag markup for a custom header image .
2015-11-09 20:17:26 -05:00
*
* @ since 4.4 . 0
*
2015-11-09 20:59:25 -05:00
* @ param array $attr Optional . Additional attributes for the image tag . Can be used
* to override the default attributes . Default empty .
* @ return string HTML image element markup or empty string on failure .
2015-11-09 20:17:26 -05:00
*/
function get_header_image_tag ( $attr = array () ) {
2017-11-30 18:11:00 -05:00
$header = get_custom_header ();
2016-11-04 13:09:02 -04:00
$header -> url = get_header_image ();
2015-11-09 20:17:26 -05:00
2016-11-04 13:09:02 -04:00
if ( ! $header -> url ) {
2015-11-09 20:17:26 -05:00
return '' ;
}
2017-11-30 18:11:00 -05:00
$width = absint ( $header -> width );
2015-11-09 20:17:26 -05:00
$height = absint ( $header -> height );
2021-12-09 10:13:04 -05:00
$alt = '' ;
2015-11-09 20:17:26 -05:00
Media: Allow setting custom image alt text in custom header image.
This change applies the alternative text assigned to the custom header image, if available. Otherwise, it leaves it empty. It fixes an issue where the alternative text was always the site title, which is not relevant in most use cases.
Props webmandesign, mukesh27, afercia, anevins, mikeschroder, nrqsnchz, audrasjb, sabernhardt, joedolson, Boniu91.
Fixes #46124.
Built from https://develop.svn.wordpress.org/trunk@52256
git-svn-id: http://core.svn.wordpress.org/trunk@51848 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-11-26 17:56:02 -05:00
// Use alternative text assigned to the image, if available. Otherwise, leave it empty.
2021-12-09 10:13:04 -05:00
if ( ! empty ( $header -> attachment_id ) ) {
$image_alt = get_post_meta ( $header -> attachment_id , '_wp_attachment_image_alt' , true );
if ( is_string ( $image_alt ) ) {
$alt = $image_alt ;
}
Media: Allow setting custom image alt text in custom header image.
This change applies the alternative text assigned to the custom header image, if available. Otherwise, it leaves it empty. It fixes an issue where the alternative text was always the site title, which is not relevant in most use cases.
Props webmandesign, mukesh27, afercia, anevins, mikeschroder, nrqsnchz, audrasjb, sabernhardt, joedolson, Boniu91.
Fixes #46124.
Built from https://develop.svn.wordpress.org/trunk@52256
git-svn-id: http://core.svn.wordpress.org/trunk@51848 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-11-26 17:56:02 -05:00
}
2015-11-09 20:17:26 -05:00
$attr = wp_parse_args (
$attr ,
array (
Media: Rely on `wp_get_loading_optimization_attributes()` to add `decoding="async"` to images.
The `wp_get_loading_optimization_attributes()` function was introduced in 6.3, as a single centralized place to control loading optimization attributes for various tags, most importantly images.
This changeset consolidates the `decoding="async"` optimization, which was added in 6.1, to occur solely as part of `wp_get_loading_optimization_attributes()`, removing duplicate code and allowing centralized filtering based on [56651].
As part of the change, the `wp_img_tag_add_decoding_attr()` function has been deprecated. The filter of the same name continues to be maintained for backward compatibility, as before covering only images that are part of a content blob such as post content (`the_content`).
Props pereirinha, mukesh27, joemcgill, flixos90.
Fixes #58892.
See #53232.
Built from https://develop.svn.wordpress.org/trunk@56690
git-svn-id: http://core.svn.wordpress.org/trunk@56202 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 18:38:17 -04:00
'src' => $header -> url ,
'width' => $width ,
'height' => $height ,
'alt' => $alt ,
2015-11-09 20:17:26 -05:00
)
);
// Generate 'srcset' and 'sizes' if not already present.
if ( empty ( $attr [ 'srcset' ] ) && ! empty ( $header -> attachment_id ) ) {
$image_meta = get_post_meta ( $header -> attachment_id , '_wp_attachment_metadata' , true );
$size_array = array ( $width , $height );
if ( is_array ( $image_meta ) ) {
2015-11-09 20:59:25 -05:00
$srcset = wp_calculate_image_srcset ( $size_array , $header -> url , $image_meta , $header -> attachment_id );
2021-12-09 10:13:04 -05:00
if ( ! empty ( $attr [ 'sizes' ] ) ) {
$sizes = $attr [ 'sizes' ];
} else {
$sizes = wp_calculate_image_sizes ( $size_array , $header -> url , $image_meta , $header -> attachment_id );
}
2015-11-09 20:17:26 -05:00
2015-11-09 20:59:25 -05:00
if ( $srcset && $sizes ) {
2015-11-09 20:17:26 -05:00
$attr [ 'srcset' ] = $srcset ;
2017-11-30 18:11:00 -05:00
$attr [ 'sizes' ] = $sizes ;
2015-11-09 20:17:26 -05:00
}
}
}
2023-07-05 15:30:25 -04:00
$attr = array_merge (
$attr ,
wp_get_loading_optimization_attributes ( 'img' , $attr , 'get_header_image_tag' )
);
/*
* If the default value of `lazy` for the `loading` attribute is overridden
* to omit the attribute for this image , ensure it is not included .
*/
if ( isset ( $attr [ 'loading' ] ) && ! $attr [ 'loading' ] ) {
unset ( $attr [ 'loading' ] );
}
// If the `fetchpriority` attribute is overridden and set to false or an empty string.
if ( isset ( $attr [ 'fetchpriority' ] ) && ! $attr [ 'fetchpriority' ] ) {
unset ( $attr [ 'fetchpriority' ] );
}
// If the `decoding` attribute is overridden and set to false or an empty string.
if ( isset ( $attr [ 'decoding' ] ) && ! $attr [ 'decoding' ] ) {
unset ( $attr [ 'decoding' ] );
}
2021-11-08 05:44:59 -05:00
/**
2021-11-02 13:21:58 -04:00
* Filters the list of header image attributes .
*
* @ since 5.9 . 0
*
* @ param array $attr Array of the attributes for the image tag .
* @ param object $header The custom header object returned by 'get_custom_header()' .
*/
$attr = apply_filters ( 'get_header_image_tag_attributes' , $attr , $header );
2015-11-09 20:17:26 -05:00
$attr = array_map ( 'esc_attr' , $attr );
$html = '<img' ;
foreach ( $attr as $name => $value ) {
$html .= ' ' . $name . '="' . $value . '"' ;
}
$html .= ' />' ;
/**
2016-05-22 14:18:29 -04:00
* Filters the markup of header images .
2015-11-09 20:17:26 -05:00
*
* @ since 4.4 . 0
*
2015-11-09 20:59:25 -05:00
* @ param string $html The HTML image tag markup being filtered .
* @ param object $header The custom header object returned by 'get_custom_header()' .
* @ param array $attr Array of the attributes for the image tag .
2015-11-09 20:17:26 -05:00
*/
return apply_filters ( 'get_header_image_tag' , $html , $header , $attr );
}
/**
2020-06-27 08:02:03 -04:00
* Displays the image markup for a custom header image .
2015-11-09 20:17:26 -05:00
*
* @ since 4.4 . 0
*
* @ param array $attr Optional . Attributes for the image markup . Default empty .
*/
function the_header_image_tag ( $attr = array () ) {
echo get_header_image_tag ( $attr );
}
2011-04-28 19:02:16 -04:00
/**
2020-06-27 08:02:03 -04:00
* Gets random header image data from registered images in theme .
2011-04-28 19:02:16 -04:00
*
2012-02-02 18:35:37 -05:00
* @ since 3.4 . 0
*
* @ access private
2011-04-28 19:02:16 -04:00
*
2020-06-27 08:02:03 -04:00
* @ global array $_wp_default_headers
2015-05-27 18:21:25 -04:00
*
* @ return object
2011-04-28 19:02:16 -04:00
*/
2012-02-02 18:35:37 -05:00
function _get_random_header_data () {
2021-12-09 10:13:04 -05:00
global $_wp_default_headers ;
2015-05-29 11:43:29 -04:00
static $_wp_random_header = null ;
2011-04-28 19:02:16 -04:00
2012-02-02 18:35:37 -05:00
if ( empty ( $_wp_random_header ) ) {
$header_image_mod = get_theme_mod ( 'header_image' , '' );
2017-11-30 18:11:00 -05:00
$headers = array ();
2012-02-02 18:35:37 -05:00
2020-05-16 14:42:12 -04:00
if ( 'random-uploaded-image' === $header_image_mod ) {
2012-02-02 18:35:37 -05:00
$headers = get_uploaded_header_images ();
2017-11-30 18:11:00 -05:00
} elseif ( ! empty ( $_wp_default_headers ) ) {
2020-05-16 14:42:12 -04:00
if ( 'random-default-image' === $header_image_mod ) {
2011-06-22 15:09:23 -04:00
$headers = $_wp_default_headers ;
2012-02-02 18:35:37 -05:00
} else {
2017-11-30 18:11:00 -05:00
if ( current_theme_supports ( 'custom-header' , 'random-default' ) ) {
2012-02-02 18:35:37 -05:00
$headers = $_wp_default_headers ;
2017-11-30 18:11:00 -05:00
}
2012-02-02 18:35:37 -05:00
}
2011-06-22 15:09:23 -04:00
}
2011-04-28 19:02:16 -04:00
2017-11-30 18:11:00 -05:00
if ( empty ( $headers ) ) {
2022-11-29 10:51:14 -05:00
return new stdClass ();
2017-11-30 18:11:00 -05:00
}
2012-02-02 18:35:37 -05:00
$_wp_random_header = ( object ) $headers [ array_rand ( $headers ) ];
2021-12-09 10:13:04 -05:00
$_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 ()
);
2012-02-02 18:35:37 -05:00
}
2020-05-16 14:42:12 -04:00
2012-02-02 18:35:37 -05:00
return $_wp_random_header ;
}
2011-04-28 19:02:16 -04:00
2012-02-02 18:35:37 -05:00
/**
2020-06-27 08:02:03 -04:00
* Gets random header image URL from registered images in theme .
2012-02-02 18:35:37 -05:00
*
* @ since 3.2 . 0
*
2020-06-27 08:02:03 -04:00
* @ return string Path to header image .
2012-02-02 18:35:37 -05:00
*/
function get_random_header_image () {
$random_image = _get_random_header_data ();
2020-05-16 14:42:12 -04:00
2017-11-30 18:11:00 -05:00
if ( empty ( $random_image -> url ) ) {
2012-02-02 18:35:37 -05:00
return '' ;
2017-11-30 18:11:00 -05:00
}
2020-05-16 14:42:12 -04:00
2012-02-02 18:35:37 -05:00
return $random_image -> url ;
2011-04-28 19:02:16 -04:00
}
/**
2020-06-27 08:02:03 -04:00
* Checks if random header image is in use .
2011-04-28 19:02:16 -04:00
*
* Always true if user expressly chooses the option in Appearance > Header .
2011-06-22 15:09:23 -04:00
* Also true if theme has multiple header images registered , no specific header image
* is chosen , and theme turns on random headers with add_theme_support () .
2011-04-28 19:02:16 -04:00
*
2011-06-11 00:40:18 -04:00
* @ since 3.2 . 0
2011-04-28 19:02:16 -04:00
*
2020-06-27 08:02:03 -04:00
* @ param string $type The random pool to use . Possible values include 'any' ,
* 'default' , 'uploaded' . Default 'any' .
2015-06-26 21:03:25 -04:00
* @ return bool
2011-04-28 19:02:16 -04:00
*/
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 13:12:44 -04:00
$header_image_mod = get_theme_mod ( 'header_image' , get_theme_support ( 'custom-header' , 'default-image' ) );
2011-04-28 19:02:16 -04:00
2020-05-16 14:42:12 -04:00
if ( 'any' === $type ) {
if ( 'random-default-image' === $header_image_mod
|| 'random-uploaded-image' === $header_image_mod
2023-11-27 04:17:21 -05:00
|| ( empty ( $header_image_mod ) && '' !== get_random_header_image () )
2020-05-16 14:42:12 -04:00
) {
2011-04-28 19:02:16 -04:00
return true ;
2017-11-30 18:11:00 -05:00
}
2011-04-28 19:02:16 -04:00
} else {
2020-05-16 14:42:12 -04:00
if ( " random- $type -image " === $header_image_mod ) {
2011-04-28 19:02:16 -04:00
return true ;
2023-11-27 04:17:21 -05:00
} elseif ( 'default' === $type
&& empty ( $header_image_mod ) && '' !== get_random_header_image ()
) {
2011-04-29 15:45:30 -04:00
return true ;
2017-11-30 18:11:00 -05:00
}
2011-04-28 19:02:16 -04:00
}
return false ;
}
2008-09-01 01:44:16 -04:00
/**
2020-06-27 08:02:03 -04:00
* Displays header image URL .
2008-09-01 01:44:16 -04:00
*
* @ since 2.1 . 0
*/
2007-01-03 18:49:34 -05:00
function header_image () {
2015-03-08 22:11:28 -04:00
$image = get_header_image ();
2020-05-16 14:42:12 -04:00
2015-03-08 22:11:28 -04:00
if ( $image ) {
echo esc_url ( $image );
}
2007-01-03 18:49:34 -05:00
}
2011-04-28 19:02:16 -04:00
/**
2022-01-20 18:53:05 -05:00
* Gets the header images uploaded for the active theme .
2011-04-28 19:02:16 -04:00
*
* @ since 3.2 . 0
*
* @ return array
*/
function get_uploaded_header_images () {
$header_images = array ();
2020-01-28 19:45:18 -05:00
// @todo Caching.
2017-11-30 18:11:00 -05:00
$headers = get_posts (
array (
'post_type' => 'attachment' ,
'meta_key' => '_wp_attachment_is_custom_header' ,
'meta_value' => get_option ( 'stylesheet' ),
'orderby' => 'none' ,
'nopaging' => true ,
)
);
2011-04-28 19:02:16 -04:00
2017-11-30 18:11:00 -05:00
if ( empty ( $headers ) ) {
2011-04-28 19:02:16 -04:00
return array ();
2017-11-30 18:11:00 -05:00
}
2011-04-28 19:02:16 -04:00
foreach ( ( array ) $headers as $header ) {
2022-06-01 14:14:10 -04:00
$url = sanitize_url ( wp_get_attachment_url ( $header -> ID ) );
2017-11-30 18:11:00 -05:00
$header_data = wp_get_attachment_metadata ( $header -> ID );
2016-02-16 17:12:27 -05:00
$header_index = $header -> ID ;
2015-06-29 17:32:26 -04:00
2021-12-09 10:13:04 -05:00
$header_images [ $header_index ] = array ();
$header_images [ $header_index ][ 'attachment_id' ] = $header -> ID ;
$header_images [ $header_index ][ 'url' ] = $url ;
$header_images [ $header_index ][ 'thumbnail_url' ] = $url ;
$header_images [ $header_index ][ 'alt_text' ] = get_post_meta ( $header -> ID , '_wp_attachment_image_alt' , true );
if ( isset ( $header_data [ 'attachment_parent' ] ) ) {
$header_images [ $header_index ][ 'attachment_parent' ] = $header_data [ 'attachment_parent' ];
} else {
$header_images [ $header_index ][ 'attachment_parent' ] = '' ;
}
2015-06-29 17:32:26 -04:00
2017-11-30 18:11:00 -05:00
if ( isset ( $header_data [ 'width' ] ) ) {
$header_images [ $header_index ][ 'width' ] = $header_data [ 'width' ];
}
if ( isset ( $header_data [ 'height' ] ) ) {
$header_images [ $header_index ][ 'height' ] = $header_data [ 'height' ];
}
2011-04-28 19:02:16 -04:00
}
return $header_images ;
}
2012-02-02 18:35:37 -05:00
/**
2020-06-27 08:02:03 -04:00
* Gets the header image data .
2012-02-02 18:35:37 -05:00
*
* @ since 3.4 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $_wp_default_headers
*
2012-02-02 18:35:37 -05:00
* @ 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 13:12:44 -04:00
function get_custom_header () {
2012-11-07 15:12:47 -05: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 01:59:25 -05:00
if ( ! $data && current_theme_supports ( 'custom-header' , 'default-image' ) ) {
2019-07-02 19:42:58 -04:00
$directory_args = array ( get_template_directory_uri (), get_stylesheet_directory_uri () );
$data = array ();
$data [ 'url' ] = vsprintf ( get_theme_support ( 'custom-header' , 'default-image' ), $directory_args );
$data [ 'thumbnail_url' ] = $data [ 'url' ];
2012-11-19 01:59:25 -05:00
if ( ! empty ( $_wp_default_headers ) ) {
foreach ( ( array ) $_wp_default_headers as $default_header ) {
$url = vsprintf ( $default_header [ 'url' ], $directory_args );
if ( $data [ 'url' ] == $url ) {
2017-11-30 18:11:00 -05:00
$data = $default_header ;
$data [ 'url' ] = $url ;
2012-11-19 01:59:25 -05:00
$data [ 'thumbnail_url' ] = vsprintf ( $data [ 'thumbnail_url' ], $directory_args );
break ;
}
2012-11-07 15:12:47 -05:00
}
}
}
}
2012-02-02 18:35:37 -05:00
$default = array (
'url' => '' ,
'thumbnail_url' => '' ,
2012-03-19 14:00:27 -04:00
'width' => get_theme_support ( 'custom-header' , 'width' ),
'height' => get_theme_support ( 'custom-header' , 'height' ),
2016-10-27 17:51:31 -04:00
'video' => get_theme_support ( 'custom-header' , 'video' ),
2012-02-02 18:35:37 -05:00
);
return ( object ) wp_parse_args ( $data , $default );
}
2010-02-25 14:18:44 -05:00
/**
2020-06-27 08:02:03 -04:00
* Registers a selection of default headers to be displayed by the custom header admin UI .
2010-02-25 14:18:44 -05:00
*
* @ since 3.0 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $_wp_default_headers
*
2020-06-20 08:02:12 -04: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 14:18:44 -05:00
*/
function register_default_headers ( $headers ) {
global $_wp_default_headers ;
2010-04-01 23:15:18 -04:00
$_wp_default_headers = array_merge ( ( array ) $_wp_default_headers , ( array ) $headers );
}
/**
2020-06-27 08:02:03 -04:00
* Unregisters default headers .
2010-04-01 23:15:18 -04:00
*
* This function must be called after register_default_headers () has already added the
* header you want to remove .
*
* @ see register_default_headers ()
* @ since 3.0 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $_wp_default_headers
*
2010-09-07 07:21:11 -04:00
* @ param string | array $header The header string id ( key of array ) to remove , or an array thereof .
2014-03-17 20:12:15 -04: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-01 23:15:18 -04:00
*/
function unregister_default_headers ( $header ) {
global $_wp_default_headers ;
2021-12-09 10:13:04 -05:00
2010-04-01 23:15:18 -04:00
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 14:18:44 -05:00
}
2016-10-27 17:51:31 -04:00
/**
2020-06-27 08:02:03 -04:00
* Checks whether a header video is set or not .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*
* @ see get_header_video_url ()
*
* @ return bool Whether a header video is set or not .
*/
function has_header_video () {
return ( bool ) get_header_video_url ();
}
2017-01-04 08:44:43 -05:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves header video URL for custom header .
2016-10-27 17:51:31 -04:00
*
2017-01-04 08:44:43 -05:00
* Uses a local video if present , or falls back to an external video .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*
2017-01-04 08:44:43 -05:00
* @ return string | false Header video URL or false if there is no video .
2016-10-27 17:51:31 -04:00
*/
function get_header_video_url () {
2020-02-11 11:36:06 -05:00
$id = absint ( get_theme_mod ( 'header_video' ) );
2016-10-27 17:51:31 -04:00
if ( $id ) {
// Get the file URL from the attachment ID.
$url = wp_get_attachment_url ( $id );
2020-02-11 11:36:06 -05:00
} else {
$url = get_theme_mod ( 'external_header_video' );
2016-10-27 17:51:31 -04:00
}
2017-02-05 21:52:41 -05:00
/**
* Filters the header video URL .
*
2017-02-20 01:48:08 -05:00
* @ since 4.7 . 3
2017-02-05 21:52:41 -05:00
*
* @ param string $url Header video URL , if available .
*/
$url = apply_filters ( 'get_header_video_url' , $url );
if ( ! $id && ! $url ) {
return false ;
}
2022-06-01 14:14:10 -04:00
return sanitize_url ( set_url_scheme ( $url ) );
2016-10-27 17:51:31 -04:00
}
/**
2020-06-27 08:02:03 -04:00
* Displays header video URL .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*/
function the_header_video_url () {
$video = get_header_video_url ();
2020-05-16 14:42:12 -04:00
2016-10-27 17:51:31 -04:00
if ( $video ) {
echo esc_url ( $video );
}
}
/**
2020-06-27 08:02:03 -04:00
* Retrieves header video settings .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*
* @ return array
*/
function get_header_video_settings () {
$header = get_custom_header ();
$video_url = get_header_video_url ();
$video_type = wp_check_filetype ( $video_url , wp_get_mime_types () );
$settings = array (
'mimeType' => '' ,
'posterUrl' => get_header_image (),
'videoUrl' => $video_url ,
'width' => absint ( $header -> width ),
'height' => absint ( $header -> height ),
'minWidth' => 900 ,
'minHeight' => 500 ,
Themes: Improve a11y and extendability of custom video headers.
This adds play/pause controls to video headers, along with voice
assistance, using `wp.a11y.speak`, to make custom video headers more
accessible. To make styling the play/pause button easier for themes,
CSS has been omitted from the default implementation.
This also includes a refactor of the `wp.customHeader` code to introduce
a `BaseHandler` class, which can be extended by plugins and themes to modify
or enhance the default video handlers.
Props davidakennedy, afercia, bradyvercher, joemcgill, adamsilverstein, rianrietveld.
Fixes #38678.
Built from https://develop.svn.wordpress.org/trunk@39272
git-svn-id: http://core.svn.wordpress.org/trunk@39212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-11-16 18:26:31 -05:00
'l10n' => array (
'pause' => __ ( 'Pause' ),
'play' => __ ( 'Play' ),
2017-11-30 18:11:00 -05:00
'pauseSpeak' => __ ( 'Video is paused.' ),
'playSpeak' => __ ( 'Video is playing.' ),
Themes: Improve a11y and extendability of custom video headers.
This adds play/pause controls to video headers, along with voice
assistance, using `wp.a11y.speak`, to make custom video headers more
accessible. To make styling the play/pause button easier for themes,
CSS has been omitted from the default implementation.
This also includes a refactor of the `wp.customHeader` code to introduce
a `BaseHandler` class, which can be extended by plugins and themes to modify
or enhance the default video handlers.
Props davidakennedy, afercia, bradyvercher, joemcgill, adamsilverstein, rianrietveld.
Fixes #38678.
Built from https://develop.svn.wordpress.org/trunk@39272
git-svn-id: http://core.svn.wordpress.org/trunk@39212 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-11-16 18:26:31 -05:00
),
2016-10-27 17:51:31 -04:00
);
if ( preg_match ( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#' , $video_url ) ) {
$settings [ 'mimeType' ] = 'video/x-youtube' ;
} elseif ( ! empty ( $video_type [ 'type' ] ) ) {
$settings [ 'mimeType' ] = $video_type [ 'type' ];
}
2018-02-12 17:39:31 -05:00
/**
* Filters header video settings .
*
* @ since 4.7 . 0
*
* @ param array $settings An array of header video settings .
*/
2016-10-27 17:51:31 -04:00
return apply_filters ( 'header_video_settings' , $settings );
}
/**
2020-06-27 08:02:03 -04:00
* Checks whether a custom header is set or not .
2016-10-27 17:51:31 -04:00
*
* @ since 4.7 . 0
*
* @ return bool True if a custom header is set . False if not .
*/
function has_custom_header () {
2016-11-15 02:16:33 -05:00
if ( has_header_image () || ( has_header_video () && is_header_video_active () ) ) {
2016-10-27 17:51:31 -04:00
return true ;
}
return false ;
}
2016-11-15 02:16:33 -05:00
/**
* Checks whether the custom header video is eligible to show on the current page .
*
* @ since 4.7 . 0
*
* @ return bool True if the custom header video should be shown . False if not .
*/
function is_header_video_active () {
if ( ! get_theme_support ( 'custom-header' , 'video' ) ) {
return false ;
}
$video_active_cb = get_theme_support ( 'custom-header' , 'video-active-callback' );
if ( empty ( $video_active_cb ) || ! is_callable ( $video_active_cb ) ) {
$show_video = true ;
} else {
$show_video = call_user_func ( $video_active_cb );
}
/**
2020-06-27 08:02:03 -04:00
* Filters whether the custom header video is eligible to show on the current page .
2016-11-15 02:16:33 -05:00
*
* @ since 4.7 . 0
*
* @ param bool $show_video Whether the custom header video should be shown . Returns the value
* of the theme setting for the `custom-header` ' s `video-active-callback` .
* If no callback is set , the default value is that of `is_front_page()` .
*/
return apply_filters ( 'is_header_video_active' , $show_video );
}
2016-10-27 17:51:31 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves the markup for a custom header .
2016-10-27 17:51:31 -04:00
*
2016-11-14 13:41:32 -05:00
* The container div will always be returned in the Customizer preview .
*
2016-10-27 17:51:31 -04:00
* @ since 4.7 . 0
*
2016-11-14 13:41:32 -05:00
* @ return string The markup for a custom header on success .
2016-10-27 17:51:31 -04:00
*/
function get_custom_header_markup () {
2016-11-14 13:41:32 -05:00
if ( ! has_custom_header () && ! is_customize_preview () ) {
return '' ;
2016-10-27 17:51:31 -04:00
}
return sprintf (
'<div id="wp-custom-header" class="wp-custom-header">%s</div>' ,
get_header_image_tag ()
);
}
/**
2020-06-27 08:02:03 -04:00
* Prints the markup for a custom header .
2016-10-27 17:51:31 -04:00
*
2016-11-14 13:41:32 -05:00
* A container div will always be printed in the Customizer preview .
*
2016-10-27 17:51:31 -04:00
* @ since 4.7 . 0
*/
function the_custom_header_markup () {
2016-11-14 13:41:32 -05:00
$custom_header = get_custom_header_markup ();
if ( empty ( $custom_header ) ) {
2016-10-27 17:51:31 -04:00
return ;
}
2016-11-14 13:41:32 -05:00
2016-10-27 17:51:31 -04:00
echo $custom_header ;
2016-11-15 02:16:33 -05:00
if ( is_header_video_active () && ( has_header_video () || is_customize_preview () ) ) {
2016-10-27 17:51:31 -04:00
wp_enqueue_script ( 'wp-custom-header' );
wp_localize_script ( 'wp-custom-header' , '_wpCustomHeaderSettings' , get_header_video_settings () );
}
}
2010-02-09 15:37:12 -05:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves background image for custom background .
2010-02-09 15:37:12 -05:00
*
* @ since 3.0 . 0
*
* @ return string
*/
function get_background_image () {
2017-11-30 18:11:00 -05:00
return get_theme_mod ( 'background_image' , get_theme_support ( 'custom-background' , 'default-image' ) );
2010-02-09 15:37:12 -05:00
}
/**
2020-06-27 08:02:03 -04:00
* Displays background image path .
2010-02-09 15:37:12 -05:00
*
* @ since 3.0 . 0
*/
function background_image () {
echo get_background_image ();
}
2010-03-03 12:10:43 -05:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves value for custom background color .
2010-03-03 12:10:43 -05:00
*
* @ since 3.0 . 0
*
* @ return string
*/
function get_background_color () {
2017-11-30 18:11:00 -05:00
return get_theme_mod ( 'background_color' , get_theme_support ( 'custom-background' , 'default-color' ) );
2010-03-03 12:10:43 -05:00
}
/**
2020-06-27 08:02:03 -04:00
* Displays background color value .
2010-03-03 12:10:43 -05:00
*
* @ since 3.0 . 0
*/
function background_color () {
echo get_background_color ();
}
2010-02-09 15:37:12 -05:00
/**
* Default custom background callback .
*
* @ since 3.0 . 0
*/
function _custom_background_cb () {
2012-06-05 14:44:31 -04:00
// $background is the saved custom image, or the default image.
2012-08-27 16:25:53 -04:00
$background = set_url_scheme ( get_background_image () );
2012-06-05 14:44:31 -04:00
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04: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 07:53:14 -04:00
$color = get_background_color ();
2020-02-09 11:55:09 -05:00
if ( get_theme_support ( 'custom-background' , 'default-color' ) === $color ) {
2014-03-25 07:53:14 -04:00
$color = false ;
}
2012-06-01 16:31:50 -04:00
2019-09-23 16:09:57 -04:00
$type_attr = current_theme_supports ( 'html5' , 'style' ) ? '' : ' type="text/css"' ;
2016-11-12 21:43:29 -05:00
if ( ! $background && ! $color ) {
if ( is_customize_preview () ) {
2019-09-18 10:50:56 -04:00
printf ( '<style%s id="custom-background-css"></style>' , $type_attr );
2016-11-12 21:43:29 -05:00
}
2010-02-09 15:37:12 -05:00
return ;
2016-11-12 21:43:29 -05:00
}
2010-02-09 15:37:12 -05:00
2010-06-10 14:28:25 -04:00
$style = $color ? " background-color: # $color ; " : '' ;
if ( $background ) {
2022-06-01 14:14:10 -04:00
$image = ' background-image: url("' . sanitize_url ( $background ) . '");' ;
2010-06-10 14:28:25 -04:00
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
// Background Position.
$position_x = get_theme_mod ( 'background_position_x' , get_theme_support ( 'custom-background' , 'default-position-x' ) );
$position_y = get_theme_mod ( 'background_position_y' , get_theme_support ( 'custom-background' , 'default-position-y' ) );
if ( ! in_array ( $position_x , array ( 'left' , 'center' , 'right' ), true ) ) {
$position_x = 'left' ;
}
if ( ! in_array ( $position_y , array ( 'top' , 'center' , 'bottom' ), true ) ) {
$position_y = 'top' ;
}
$position = " background-position: $position_x $position_y ; " ;
// Background Size.
$size = get_theme_mod ( 'background_size' , get_theme_support ( 'custom-background' , 'default-size' ) );
if ( ! in_array ( $size , array ( 'auto' , 'contain' , 'cover' ), true ) ) {
$size = 'auto' ;
}
$size = " background-size: $size ; " ;
// Background Repeat.
2013-12-03 16:36:10 -05:00
$repeat = get_theme_mod ( 'background_repeat' , get_theme_support ( 'custom-background' , 'default-repeat' ) );
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
if ( ! in_array ( $repeat , array ( 'repeat-x' , 'repeat-y' , 'repeat' , 'no-repeat' ), true ) ) {
2010-06-10 14:28:25 -04:00
$repeat = 'repeat' ;
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
}
2010-06-11 16:19:35 -04:00
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
$repeat = " background-repeat: $repeat ; " ;
2010-06-11 16:19:35 -04:00
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
// Background Scroll.
2013-12-03 16:36:10 -05:00
$attachment = get_theme_mod ( 'background_attachment' , get_theme_support ( 'custom-background' , 'default-attachment' ) );
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
if ( 'fixed' !== $attachment ) {
2010-06-10 14:28:25 -04:00
$attachment = 'scroll' ;
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
}
2010-06-10 14:28:25 -04:00
$attachment = " background-attachment: $attachment ; " ;
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
$style .= $image . $position . $size . $repeat . $attachment ;
2010-03-27 22:53:04 -04:00
}
2018-08-16 21:51:36 -04:00
?>
2019-09-18 10:50:56 -04:00
< style < ? php echo $type_attr ; ?> id="custom-background-css">
2011-10-05 13:20:43 -04:00
body . custom - background { < ? php echo trim ( $style ); ?> }
2010-02-09 15:37:12 -05:00
</ style >
2018-08-16 21:51:36 -04:00
< ? php
2010-02-09 15:37:12 -05:00
}
2016-10-19 14:15:31 -04:00
/**
2020-06-27 08:02:03 -04:00
* Renders the Custom CSS style element .
2016-10-19 14:15:31 -04:00
*
* @ since 4.7 . 0
*/
function wp_custom_css_cb () {
$styles = wp_get_custom_css ();
2017-11-30 18:11:00 -05:00
if ( $styles || is_customize_preview () ) :
2019-09-18 10:50:56 -04:00
$type_attr = current_theme_supports ( 'html5' , 'style' ) ? '' : ' type="text/css"' ;
2018-08-16 21:51:36 -04:00
?>
2019-09-18 10:50:56 -04:00
< style < ? php echo $type_attr ; ?> id="wp-custom-css">
2021-12-09 10:13:04 -05:00
< ? php
// Note that esc_html() cannot be used because `div > span` is not interpreted properly.
echo strip_tags ( $styles );
?>
2016-10-19 14:15:31 -04:00
</ style >
2018-08-16 21:51:36 -04:00
< ? php
2017-11-30 18:11:00 -05:00
endif ;
2016-10-19 14:15:31 -04:00
}
/**
2020-06-27 08:02:03 -04:00
* Fetches the `custom_css` post for a given theme .
2016-10-19 14:15:31 -04:00
*
* @ since 4.7 . 0
*
2022-01-20 18:53:05 -05:00
* @ param string $stylesheet Optional . A theme object stylesheet name . Defaults to the active theme .
2016-11-09 15:43:30 -05:00
* @ return WP_Post | null The custom_css post or null if none exists .
2016-10-19 14:15:31 -04:00
*/
2016-11-09 15:43:30 -05:00
function wp_get_custom_css_post ( $stylesheet = '' ) {
2016-10-19 14:15:31 -04:00
if ( empty ( $stylesheet ) ) {
$stylesheet = get_stylesheet ();
}
$custom_css_query_vars = array (
2016-11-09 15:43:30 -05:00
'post_type' => 'custom_css' ,
'post_status' => get_post_stati (),
'name' => sanitize_title ( $stylesheet ),
2016-11-22 06:41:34 -05:00
'posts_per_page' => 1 ,
2016-11-09 15:43:30 -05:00
'no_found_rows' => true ,
'cache_results' => true ,
2016-10-19 14:15:31 -04:00
'update_post_meta_cache' => false ,
2017-01-05 03:12:42 -05:00
'update_post_term_cache' => false ,
'lazy_load_term_meta' => false ,
2016-10-19 14:15:31 -04:00
);
$post = null ;
if ( get_stylesheet () === $stylesheet ) {
$post_id = get_theme_mod ( 'custom_css_post_id' );
2016-11-22 06:41:34 -05:00
if ( $post_id > 0 && get_post ( $post_id ) ) {
$post = get_post ( $post_id );
2017-01-05 02:13:42 -05:00
}
// `-1` indicates no post exists; no query necessary.
if ( ! $post && - 1 !== $post_id ) {
2016-10-19 14:15:31 -04:00
$query = new WP_Query ( $custom_css_query_vars );
2017-11-30 18:11:00 -05:00
$post = $query -> post ;
2016-10-19 14:15:31 -04:00
/*
2017-01-05 02:13:42 -05:00
* Cache the lookup . See wp_update_custom_css_post () .
2016-10-19 14:15:31 -04:00
* @ todo This should get cleared if a custom_css post is added / removed .
*/
2017-01-05 02:13:42 -05:00
set_theme_mod ( 'custom_css_post_id' , $post ? $post -> ID : - 1 );
2016-10-19 14:15:31 -04:00
}
} else {
$query = new WP_Query ( $custom_css_query_vars );
2017-11-30 18:11:00 -05:00
$post = $query -> post ;
2016-10-19 14:15:31 -04:00
}
2016-11-09 15:43:30 -05:00
return $post ;
}
/**
2020-06-27 08:02:03 -04:00
* Fetches the saved Custom CSS content for rendering .
2016-11-09 15:43:30 -05:00
*
* @ since 4.7 . 0
*
2022-01-20 18:53:05 -05:00
* @ param string $stylesheet Optional . A theme object stylesheet name . Defaults to the active theme .
2016-11-09 15:43:30 -05:00
* @ return string The Custom CSS Post content .
*/
function wp_get_custom_css ( $stylesheet = '' ) {
$css = '' ;
if ( empty ( $stylesheet ) ) {
$stylesheet = get_stylesheet ();
}
$post = wp_get_custom_css_post ( $stylesheet );
2016-10-19 14:15:31 -04:00
if ( $post ) {
$css = $post -> post_content ;
}
/**
2022-04-02 09:55:11 -04:00
* Filters the custom CSS output into the head element .
2016-10-19 14:15:31 -04:00
*
* @ since 4.7 . 0
*
2021-11-10 09:18:06 -05:00
* @ param string $css CSS pulled in from the Custom CSS post type .
2016-10-19 14:15:31 -04:00
* @ param string $stylesheet The theme stylesheet name .
*/
$css = apply_filters ( 'wp_get_custom_css' , $css , $stylesheet );
return $css ;
}
2016-11-23 12:34:31 -05:00
/**
2020-06-27 08:02:03 -04:00
* Updates the `custom_css` post for a given theme .
2016-11-23 12:34:31 -05:00
*
* Inserts a `custom_css` post when one doesn ' t yet exist .
*
* @ since 4.7 . 0
*
* @ param string $css CSS , stored in `post_content` .
* @ param array $args {
* Args .
*
2021-12-09 10:13:04 -05:00
* @ type string $preprocessed Optional . Pre - processed CSS , stored in `post_content_filtered` .
* Normally empty string .
* @ type string $stylesheet Optional . Stylesheet ( child theme ) to update .
2022-01-20 18:53:05 -05:00
* Defaults to active theme / stylesheet .
2016-11-23 12:34:31 -05:00
* }
* @ return WP_Post | WP_Error Post on success , error on failure .
*/
function wp_update_custom_css_post ( $css , $args = array () ) {
2017-11-30 18:11:00 -05:00
$args = wp_parse_args (
2018-08-16 21:51:36 -04:00
$args ,
array (
2017-11-30 18:11:00 -05:00
'preprocessed' => '' ,
'stylesheet' => get_stylesheet (),
)
);
2016-11-23 12:34:31 -05:00
$data = array (
2017-11-30 18:11:00 -05:00
'css' => $css ,
2016-11-23 12:34:31 -05:00
'preprocessed' => $args [ 'preprocessed' ],
);
/**
2021-12-09 10:13:04 -05:00
* Filters the `css` ( `post_content` ) and `preprocessed` ( `post_content_filtered` ) args
* for a `custom_css` post being updated .
2016-11-23 12:34:31 -05:00
*
* This filter can be used by plugin that offer CSS pre - processors , to store the original
* pre - processed CSS in `post_content_filtered` and then store processed CSS in `post_content` .
* When used in this way , the `post_content_filtered` should be supplied as the setting value
* instead of `post_content` via a the `customize_value_custom_css` filter , for example :
*
* < code >
* add_filter ( 'customize_value_custom_css' , function ( $value , $setting ) {
* $post = wp_get_custom_css_post ( $setting -> stylesheet );
* if ( $post && ! empty ( $post -> post_content_filtered ) ) {
* $css = $post -> post_content_filtered ;
* }
* return $css ;
* }, 10 , 2 );
* </ code >
*
* @ since 4.7 . 0
* @ param array $data {
* Custom CSS data .
*
* @ type string $css CSS stored in `post_content` .
2021-12-09 10:13:04 -05:00
* @ type string $preprocessed Pre - processed CSS stored in `post_content_filtered` .
* Normally empty string .
2016-11-23 12:34:31 -05:00
* }
* @ param array $args {
* The args passed into `wp_update_custom_css_post()` merged with defaults .
*
* @ type string $css The original CSS passed in to be updated .
* @ type string $preprocessed The original preprocessed CSS passed in to be updated .
* @ type string $stylesheet The stylesheet ( theme ) being updated .
* }
*/
$data = apply_filters ( 'update_custom_css_data' , $data , array_merge ( $args , compact ( 'css' ) ) );
$post_data = array (
2017-11-30 18:11:00 -05:00
'post_title' => $args [ 'stylesheet' ],
'post_name' => sanitize_title ( $args [ 'stylesheet' ] ),
'post_type' => 'custom_css' ,
'post_status' => 'publish' ,
'post_content' => $data [ 'css' ],
2016-11-23 12:34:31 -05:00
'post_content_filtered' => $data [ 'preprocessed' ],
);
// Update post if it already exists, otherwise create a new one.
$post = wp_get_custom_css_post ( $args [ 'stylesheet' ] );
if ( $post ) {
$post_data [ 'ID' ] = $post -> ID ;
2017-11-30 18:11:00 -05:00
$r = wp_update_post ( wp_slash ( $post_data ), true );
2016-11-23 12:34:31 -05:00
} else {
$r = wp_insert_post ( wp_slash ( $post_data ), true );
2016-12-04 12:31:33 -05:00
2017-01-05 02:13:42 -05:00
if ( ! is_wp_error ( $r ) ) {
if ( get_stylesheet () === $args [ 'stylesheet' ] ) {
set_theme_mod ( 'custom_css_post_id' , $r );
}
// Trigger creation of a revision. This should be removed once #30854 is resolved.
2022-08-05 09:39:11 -04:00
$revisions = wp_get_latest_revision_id_and_total_count ( $r );
if ( ! is_wp_error ( $revisions ) && 0 === $revisions [ 'count' ] ) {
2017-01-05 02:13:42 -05:00
wp_save_post_revision ( $r );
}
2016-12-04 12:31:33 -05:00
}
2016-11-23 12:34:31 -05:00
}
2016-12-04 12:31:33 -05:00
if ( is_wp_error ( $r ) ) {
2016-11-23 12:34:31 -05:00
return $r ;
}
return get_post ( $r );
}
2010-02-26 15:12:06 -05:00
/**
2020-06-27 08:02:03 -04:00
* Adds callback for custom TinyMCE editor stylesheets .
2010-02-26 15:12:06 -05:00
*
* The parameter $stylesheet is the name of the stylesheet , relative to
2010-02-26 16:07:41 -05:00
* the theme root . It also accepts an array of stylesheets .
* It is optional and defaults to 'editor-style.css' .
2010-02-26 15:12:06 -05:00
*
2012-02-29 19:18:26 -05: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 05:09:00 -05:00
* RTL is only added for the first stylesheet .
*
2012-02-29 19:18:26 -05: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 15:12:06 -05:00
* @ since 3.0 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $editor_styles
*
2014-11-30 17:44:22 -05:00
* @ param array | string $stylesheet Optional . Stylesheet name or array thereof , relative to theme root .
2017-11-30 18:11:00 -05:00
* Defaults to 'editor-style.css'
2010-02-26 15:12:06 -05:00
*/
function add_editor_style ( $stylesheet = 'editor-style.css' ) {
2019-07-11 14:30:57 -04:00
global $editor_styles ;
2010-02-26 15:12:06 -05:00
2019-07-11 14:30:57 -04:00
add_theme_support ( 'editor-style' );
2010-02-26 15:12:06 -05:00
2010-02-27 02:36:35 -05:00
$editor_styles = ( array ) $editor_styles ;
$stylesheet = ( array ) $stylesheet ;
2019-07-11 14:30:57 -04:00
2010-05-03 01:49:19 -04:00
if ( is_rtl () ) {
2017-11-30 18:11:00 -05:00
$rtl_stylesheet = str_replace ( '.css' , '-rtl.css' , $stylesheet [ 0 ] );
$stylesheet [] = $rtl_stylesheet ;
2010-04-26 10:56:57 -04:00
}
2010-02-27 02:36:35 -05:00
$editor_styles = array_merge ( $editor_styles , $stylesheet );
2010-02-26 15:12:06 -05:00
}
2010-12-04 05:09:00 -05:00
/**
* Removes all visual editor stylesheets .
*
* @ since 3.1 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $editor_styles
*
2010-12-04 05:09:00 -05:00
* @ return bool True on success , false if there were no stylesheets to remove .
*/
function remove_editor_styles () {
2017-11-30 18:11:00 -05:00
if ( ! current_theme_supports ( 'editor-style' ) ) {
2010-12-04 05:09:00 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2010-12-04 05:09:00 -05:00
_remove_theme_support ( 'editor-style' );
2017-11-30 18:11:00 -05:00
if ( is_admin () ) {
2010-12-04 05:09:00 -05:00
$GLOBALS [ 'editor_styles' ] = array ();
2017-11-30 18:11:00 -05:00
}
2010-12-04 05:09:00 -05:00
return true ;
}
2014-07-15 17:51:15 -04:00
/**
2020-06-27 08:02:03 -04:00
* Retrieves any registered editor stylesheet URLs .
2014-07-15 17:51:15 -04:00
*
* @ since 4.0 . 0
*
2015-05-27 18:21:25 -04:00
* @ global array $editor_styles Registered editor stylesheets
2014-07-15 17:51:15 -04:00
*
2019-11-05 16:23:02 -05:00
* @ return string [] If registered , a list of editor stylesheet URLs .
2014-07-15 17:51:15 -04:00
*/
function get_editor_stylesheets () {
$stylesheets = array ();
2022-01-20 18:53:05 -05:00
// Load editor_style.css if the active theme supports it.
2014-07-15 17:51:15 -04:00
if ( ! empty ( $GLOBALS [ 'editor_styles' ] ) && is_array ( $GLOBALS [ 'editor_styles' ] ) ) {
$editor_styles = $GLOBALS [ 'editor_styles' ];
$editor_styles = array_unique ( array_filter ( $editor_styles ) );
2017-11-30 18:11:00 -05:00
$style_uri = get_stylesheet_directory_uri ();
$style_dir = get_stylesheet_directory ();
2014-07-15 17:51:15 -04:00
// Support externally referenced styles (like, say, fonts).
foreach ( $editor_styles as $key => $file ) {
if ( preg_match ( '~^(https?:)?//~' , $file ) ) {
2022-06-01 14:14:10 -04:00
$stylesheets [] = sanitize_url ( $file );
2014-07-15 17:51:15 -04:00
unset ( $editor_styles [ $key ] );
}
}
// Look in a parent theme first, that way child theme CSS overrides.
if ( is_child_theme () ) {
$template_uri = get_template_directory_uri ();
$template_dir = get_template_directory ();
foreach ( $editor_styles as $key => $file ) {
if ( $file && file_exists ( " $template_dir / $file " ) ) {
$stylesheets [] = " $template_uri / $file " ;
}
}
}
foreach ( $editor_styles as $file ) {
if ( $file && file_exists ( " $style_dir / $file " ) ) {
$stylesheets [] = " $style_uri / $file " ;
}
}
}
2015-07-13 18:01:24 -04:00
2015-06-24 09:32:32 -04:00
/**
2019-11-05 16:23:02 -05:00
* Filters the array of URLs of stylesheets applied to the editor .
2015-06-24 09:32:32 -04:00
*
* @ since 4.3 . 0
*
2019-11-05 16:23:02 -05:00
* @ param string [] $stylesheets Array of URLs of stylesheets to be applied to the editor .
2015-06-24 09:32:32 -04:00
*/
return apply_filters ( 'editor_stylesheets' , $stylesheets );
2014-07-15 17:51:15 -04:00
}
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
/**
2020-06-27 08:02:03 -04:00
* Expands a theme ' s starter content configuration using core - provided data .
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
*
* @ since 4.7 . 0
*
* @ return array Array of starter content .
*/
function get_theme_starter_content () {
$theme_support = get_theme_support ( 'starter-content' );
2016-11-17 03:18:32 -05:00
if ( is_array ( $theme_support ) && ! empty ( $theme_support [ 0 ] ) && is_array ( $theme_support [ 0 ] ) ) {
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
$config = $theme_support [ 0 ];
} else {
$config = array ();
}
2016-11-15 04:03:32 -05:00
$core_content = array (
2017-11-30 18:11:00 -05:00
'widgets' => array (
'text_business_info' => array (
'text' ,
array (
'title' => _x ( 'Find Us' , 'Theme starter content' ),
2020-10-18 13:27:06 -04:00
'text' => implode (
2018-08-16 21:51:36 -04:00
'' ,
array (
2017-11-30 18:11:00 -05:00
'<strong>' . _x ( 'Address' , 'Theme starter content' ) . " </strong> \n " ,
2021-12-09 10:13:04 -05:00
_x ( '123 Main Street' , 'Theme starter content' ) . " \n " ,
_x ( 'New York, NY 10001' , 'Theme starter content' ) . " \n \n " ,
2017-11-30 18:11:00 -05:00
'<strong>' . _x ( 'Hours' , 'Theme starter content' ) . " </strong> \n " ,
2021-12-09 10:13:04 -05:00
_x ( 'Monday–Friday: 9:00AM–5:00PM' , 'Theme starter content' ) . " \n " ,
_x ( 'Saturday & Sunday: 11:00AM–3:00PM' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
)
),
'filter' => true ,
'visual' => true ,
),
),
'text_about' => array (
'text' ,
array (
'title' => _x ( 'About This Site' , 'Theme starter content' ),
'text' => _x ( 'This may be a good place to introduce yourself and your site or include some credits.' , 'Theme starter content' ),
'filter' => true ,
'visual' => true ,
),
),
'archives' => array (
'archives' ,
array (
'title' => _x ( 'Archives' , 'Theme starter content' ),
),
),
'calendar' => array (
'calendar' ,
array (
'title' => _x ( 'Calendar' , 'Theme starter content' ),
),
),
'categories' => array (
'categories' ,
array (
'title' => _x ( 'Categories' , 'Theme starter content' ),
),
),
'meta' => array (
'meta' ,
array (
'title' => _x ( 'Meta' , 'Theme starter content' ),
),
),
'recent-comments' => array (
'recent-comments' ,
array (
'title' => _x ( 'Recent Comments' , 'Theme starter content' ),
),
),
'recent-posts' => array (
'recent-posts' ,
array (
'title' => _x ( 'Recent Posts' , 'Theme starter content' ),
),
),
'search' => array (
'search' ,
array (
'title' => _x ( 'Search' , 'Theme starter content' ),
),
),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2016-11-15 04:03:32 -05:00
'nav_menus' => array (
2017-11-30 18:11:00 -05:00
'link_home' => array (
'type' => 'custom' ,
2016-12-10 18:39:43 -05:00
'title' => _x ( 'Home' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => home_url ( '/' ),
2016-12-10 18:39:43 -05:00
),
2020-01-28 19:45:18 -05:00
'page_home' => array ( // Deprecated in favor of 'link_home'.
2017-11-30 18:11:00 -05:00
'type' => 'post_type' ,
'object' => 'page' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
'object_id' => '{{home}}' ,
),
2017-11-30 18:11:00 -05:00
'page_about' => array (
'type' => 'post_type' ,
'object' => 'page' ,
2016-11-15 19:29:31 -05:00
'object_id' => '{{about}}' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'page_blog' => array (
'type' => 'post_type' ,
'object' => 'page' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
'object_id' => '{{blog}}' ,
),
2017-11-30 18:11:00 -05:00
'page_news' => array (
'type' => 'post_type' ,
'object' => 'page' ,
2016-11-15 19:29:31 -05:00
'object_id' => '{{news}}' ,
),
2017-11-30 18:11:00 -05:00
'page_contact' => array (
'type' => 'post_type' ,
'object' => 'page' ,
2016-11-15 19:29:31 -05:00
'object_id' => '{{contact}}' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'link_email' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'Email' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'mailto:wordpress@example.com' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'link_facebook' => array (
2016-11-14 16:38:32 -05:00
'title' => _x ( 'Facebook' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://www.facebook.com/wordpress' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2016-11-15 16:20:31 -05:00
'link_foursquare' => array (
'title' => _x ( 'Foursquare' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://foursquare.com/' ,
2016-11-15 16:20:31 -05:00
),
2017-11-30 18:11:00 -05:00
'link_github' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'GitHub' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://github.com/wordpress/' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'link_instagram' => array (
2016-11-14 16:38:32 -05:00
'title' => _x ( 'Instagram' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://www.instagram.com/explore/tags/wordcamp/' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'link_linkedin' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'LinkedIn' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://www.linkedin.com/company/1089783' ,
2016-11-15 16:20:31 -05:00
),
2017-11-30 18:11:00 -05:00
'link_pinterest' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'Pinterest' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://www.pinterest.com/' ,
2016-11-15 16:20:31 -05:00
),
2017-11-30 18:11:00 -05:00
'link_twitter' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'Twitter' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://twitter.com/wordpress' ,
2016-11-15 16:20:31 -05:00
),
2017-11-30 18:11:00 -05:00
'link_yelp' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'Yelp' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://www.yelp.com' ,
2016-11-15 16:20:31 -05:00
),
2017-11-30 18:11:00 -05:00
'link_youtube' => array (
2016-11-15 16:20:31 -05:00
'title' => _x ( 'YouTube' , 'Theme starter content' ),
2017-11-30 18:11:00 -05:00
'url' => 'https://www.youtube.com/channel/UCdof4Ju7amm1chz1gi1T2ZA' ,
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
),
2017-11-30 18:11:00 -05:00
'posts' => array (
'home' => array (
'post_type' => 'page' ,
'post_title' => _x ( 'Home' , 'Theme starter content' ),
2019-10-10 15:07:05 -04:00
'post_content' => sprintf (
" <!-- wp:paragraph --> \n <p>%s</p> \n <!-- /wp:paragraph --> " ,
_x ( 'Welcome to your site! This is your homepage, which is what most visitors will see when they come to your site for the first time.' , 'Theme starter content' )
),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'about' => array (
'post_type' => 'page' ,
'post_title' => _x ( 'About' , 'Theme starter content' ),
2019-10-10 15:07:05 -04:00
'post_content' => sprintf (
" <!-- wp:paragraph --> \n <p>%s</p> \n <!-- /wp:paragraph --> " ,
2023-06-22 01:25:29 -04:00
_x ( 'You might be an artist who would like to introduce yourself and your work here or maybe you are a business with a mission to describe.' , 'Theme starter content' )
2019-10-10 15:07:05 -04:00
),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'contact' => array (
'post_type' => 'page' ,
'post_title' => _x ( 'Contact' , 'Theme starter content' ),
2019-10-10 15:07:05 -04:00
'post_content' => sprintf (
" <!-- wp:paragraph --> \n <p>%s</p> \n <!-- /wp:paragraph --> " ,
_x ( 'This is a page with some basic contact information, such as an address and phone number. You might also try a plugin to add a contact form.' , 'Theme starter content' )
),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'blog' => array (
'post_type' => 'page' ,
2016-11-14 16:38:32 -05:00
'post_title' => _x ( 'Blog' , 'Theme starter content' ),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
2017-11-30 18:11:00 -05:00
'news' => array (
'post_type' => 'page' ,
2016-11-15 19:29:31 -05:00
'post_title' => _x ( 'News' , 'Theme starter content' ),
),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
'homepage-section' => array (
2017-11-30 18:11:00 -05:00
'post_type' => 'page' ,
'post_title' => _x ( 'A homepage section' , 'Theme starter content' ),
2019-10-10 15:07:05 -04:00
'post_content' => sprintf (
" <!-- wp:paragraph --> \n <p>%s</p> \n <!-- /wp:paragraph --> " ,
_x ( 'This is an example of a homepage section. Homepage sections can be any page other than the homepage itself, including the page that shows your latest blog posts.' , 'Theme starter content' )
),
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
),
),
);
$content = array ();
foreach ( $config as $type => $args ) {
2017-11-30 18:11:00 -05:00
switch ( $type ) {
2016-11-15 04:03:32 -05:00
// Use options and theme_mods as-is.
2017-11-30 18:11:00 -05:00
case 'options' :
case 'theme_mods' :
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
$content [ $type ] = $config [ $type ];
break ;
2016-11-15 04:03:32 -05:00
// Widgets are grouped into sidebars.
2017-11-30 18:11:00 -05:00
case 'widgets' :
2016-11-15 04:03:32 -05:00
foreach ( $config [ $type ] as $sidebar_id => $widgets ) {
2016-11-23 04:53:33 -05:00
foreach ( $widgets as $id => $widget ) {
2016-11-15 04:03:32 -05:00
if ( is_array ( $widget ) ) {
2016-11-23 04:53:33 -05:00
// Item extends core content.
if ( ! empty ( $core_content [ $type ][ $id ] ) ) {
$widget = array (
$core_content [ $type ][ $id ][ 0 ],
array_merge ( $core_content [ $type ][ $id ][ 1 ], $widget ),
);
}
2016-11-15 04:03:32 -05:00
$content [ $type ][ $sidebar_id ][] = $widget ;
2021-12-09 10:13:04 -05:00
} elseif ( is_string ( $widget )
&& ! empty ( $core_content [ $type ] )
&& ! empty ( $core_content [ $type ][ $widget ] )
) {
2016-11-15 04:03:32 -05:00
$content [ $type ][ $sidebar_id ][] = $core_content [ $type ][ $widget ];
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
}
}
break ;
2016-11-15 04:03:32 -05:00
// And nav menu items are grouped into nav menus.
2017-11-30 18:11:00 -05:00
case 'nav_menus' :
2016-11-15 04:03:32 -05:00
foreach ( $config [ $type ] as $nav_menu_location => $nav_menu ) {
// Ensure nav menus get a name.
if ( empty ( $nav_menu [ 'name' ] ) ) {
$nav_menu [ 'name' ] = $nav_menu_location ;
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
2016-11-15 04:03:32 -05:00
$content [ $type ][ $nav_menu_location ][ 'name' ] = $nav_menu [ 'name' ];
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
2016-11-23 04:53:33 -05:00
foreach ( $nav_menu [ 'items' ] as $id => $nav_menu_item ) {
2016-11-15 04:03:32 -05:00
if ( is_array ( $nav_menu_item ) ) {
2016-11-23 04:53:33 -05:00
// Item extends core content.
if ( ! empty ( $core_content [ $type ][ $id ] ) ) {
$nav_menu_item = array_merge ( $core_content [ $type ][ $id ], $nav_menu_item );
}
2016-11-15 04:03:32 -05:00
$content [ $type ][ $nav_menu_location ][ 'items' ][] = $nav_menu_item ;
2021-12-09 10:13:04 -05:00
} elseif ( is_string ( $nav_menu_item )
&& ! empty ( $core_content [ $type ] )
&& ! empty ( $core_content [ $type ][ $nav_menu_item ] )
) {
2016-11-15 04:03:32 -05:00
$content [ $type ][ $nav_menu_location ][ 'items' ][] = $core_content [ $type ][ $nav_menu_item ];
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
}
}
break ;
2016-11-23 04:53:33 -05:00
// Attachments are posts but have special treatment.
2017-11-30 18:11:00 -05:00
case 'attachments' :
2016-11-23 04:53:33 -05:00
foreach ( $config [ $type ] as $id => $item ) {
if ( ! empty ( $item [ 'file' ] ) ) {
$content [ $type ][ $id ] = $item ;
}
}
break ;
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* All that ' s left now are posts ( besides attachments ) .
* Not a default case for the sake of clarity and future work .
*/
2017-11-30 18:11:00 -05:00
case 'posts' :
2016-11-23 04:53:33 -05:00
foreach ( $config [ $type ] as $id => $item ) {
2016-11-15 04:03:32 -05:00
if ( is_array ( $item ) ) {
2016-11-23 04:53:33 -05:00
// Item extends core content.
if ( ! empty ( $core_content [ $type ][ $id ] ) ) {
$item = array_merge ( $core_content [ $type ][ $id ], $item );
}
// Enforce a subset of fields.
$content [ $type ][ $id ] = wp_array_slice_assoc (
$item ,
array (
'post_type' ,
'post_title' ,
'post_excerpt' ,
'post_name' ,
'post_content' ,
'menu_order' ,
'comment_status' ,
'thumbnail' ,
'template' ,
)
);
} elseif ( is_string ( $item ) && ! empty ( $core_content [ $type ][ $item ] ) ) {
2016-11-15 04:03:32 -05:00
$content [ $type ][ $item ] = $core_content [ $type ][ $item ];
Customize: Introduce starter content and site freshness state.
A theme can opt-in for tailored starter content to apply to the customizer when previewing the theme on a fresh install, when `fresh_site` is at its initial `1` value. Starter content is staged in the customizer and does not go live unless the changes are published. Initial starter content is added to Twenty Seventeen.
* The `fresh_site` flag is cleared when a published post or page is saved, when widgets are modified, or when the customizer state is saved.
* Starter content is registered via `starter-content` theme support, where the argument is an array containing `widgets`, `posts`, `nav_menus`, `options`, and `theme_mods`. Posts/pages in starter content are created with the `auto-draft` status, re-using the page/post stubs feature added to nav menus and the static front page controls.
* A `get_theme_starter_content` filter allows for plugins to extend a theme's starter content.
* Starter content in themes can/should re-use existing starter content items in core by using named placeholders.
* Import theme starter content into customized state when fresh site.
* Prevent original_title differences from causing refreshes if title is present.
* Ensure nav menu item url is set according to object when previewing.
* Make sure initial saved state is false if there are dirty settings without an existing changeset.
* Ensure dirty settings are cleaned upon changeset publishing.
Props helen, westonruter, ocean90.
Fixes #38114, #38533.
Built from https://develop.svn.wordpress.org/trunk@38991
git-svn-id: http://core.svn.wordpress.org/trunk@38934 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 22:57:35 -04:00
}
}
break ;
}
}
/**
* Filters the expanded array of starter content .
*
* @ since 4.7 . 0
*
* @ param array $content Array of starter content .
* @ param array $config Array of theme - specific starter content configuration .
*/
return apply_filters ( 'get_theme_starter_content' , $content , $config );
}
2009-11-01 01:27:39 -04:00
/**
2016-06-09 20:07:30 -04:00
* Registers theme support for a given feature .
2010-01-15 17:11:12 -05:00
*
2010-03-31 05:06:11 -04:00
* Must be called in the theme ' s functions . php file to work .
2016-05-23 15:02:28 -04:00
* If attached to a hook , it must be { @ see 'after_setup_theme' } .
* The { @ see 'init' } hook may be too late for some features .
2009-11-01 01:27:39 -04:00
*
2019-05-25 19:41:54 -04:00
* Example usage :
*
* add_theme_support ( 'title-tag' );
* add_theme_support ( 'custom-logo' , array (
* 'height' => 480 ,
* 'width' => 720 ,
* ) );
*
2010-03-26 15:23:39 -04:00
* @ since 2.9 . 0
2020-06-25 13:41:08 -04:00
* @ since 3.4 . 0 The `custom-header-uploads` feature was deprecated .
2019-09-18 10:50:56 -04:00
* @ since 3.6 . 0 The `html5` feature was added .
Docs: Add `@since` notes for `html5` theme feature changes in `add_theme_support()`:
* As of WordPress 3.6.1, the `html5` feature requires an array of types to be passed. Defaults to `comment-list`, `comment-form`, `search-form` for backward compatibility.
* As of WordPress 6.0, the previously added `_doing_it_wrong()` notice is actually displayed as expected.
Follow-up to [25193], [25235], [25785], [49344], [49354], [52828].
Props bobbingwide.
See #51657, #55646.
Built from https://develop.svn.wordpress.org/trunk@53513
git-svn-id: http://core.svn.wordpress.org/trunk@53102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-06-16 11:21:15 -04:00
* @ since 3.6 . 1 The `html5` feature requires an array of types to be passed . Defaults to
* 'comment-list' , 'comment-form' , 'search-form' for backward compatibility .
2019-09-18 10:50:56 -04:00
* @ since 3.9 . 0 The `html5` feature now also accepts 'gallery' and 'caption' .
* @ since 4.1 . 0 The `title-tag` feature was added .
* @ since 4.5 . 0 The `customize-selective-refresh-widgets` feature was added .
* @ since 4.7 . 0 The `starter-content` feature was added .
2018-12-13 22:41:37 -05:00
* @ since 5.0 . 0 The `responsive-embeds` , `align-wide` , `dark-editor-style` , `disable-custom-colors` ,
2019-05-25 19:46:52 -04:00
* `disable-custom-font-sizes` , `editor-color-palette` , `editor-font-sizes` ,
2018-12-13 22:41:37 -05:00
* `editor-styles` , and `wp-block-styles` features were added .
2019-09-18 10:50:56 -04:00
* @ since 5.3 . 0 The `html5` feature now also accepts 'script' and 'style' .
2019-10-09 00:28:02 -04:00
* @ since 5.3 . 0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature .
2024-02-08 23:17:13 -05:00
* @ since 5.4 . 0 The `disable-custom-gradients` feature limits to default gradients or gradients added
* through `editor-gradient-presets` theme support .
2020-07-22 20:48:06 -04:00
* @ since 5.5 . 0 The `core-block-patterns` feature was added and is enabled by default .
2020-08-07 11:26:03 -04:00
* @ since 5.5 . 0 The `custom-logo` feature now also accepts 'unlink-homepage-logo' .
Docs: Add `@since` notes for `html5` theme feature changes in `add_theme_support()`:
* As of WordPress 3.6.1, the `html5` feature requires an array of types to be passed. Defaults to `comment-list`, `comment-form`, `search-form` for backward compatibility.
* As of WordPress 6.0, the previously added `_doing_it_wrong()` notice is actually displayed as expected.
Follow-up to [25193], [25235], [25785], [49344], [49354], [52828].
Props bobbingwide.
See #51657, #55646.
Built from https://develop.svn.wordpress.org/trunk@53513
git-svn-id: http://core.svn.wordpress.org/trunk@53102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-06-16 11:21:15 -04:00
* @ since 5.6 . 0 The `post-formats` feature warns if no array is passed as the second parameter .
2021-06-22 21:10:57 -04:00
* @ since 5.8 . 0 The `widgets-block-editor` feature enables the Widgets block editor .
2024-02-08 23:17:13 -05:00
* @ since 5.8 . 0 The `block-templates` feature indicates whether a theme uses block - based templates .
Docs: Add `@since` notes for `html5` theme feature changes in `add_theme_support()`:
* As of WordPress 3.6.1, the `html5` feature requires an array of types to be passed. Defaults to `comment-list`, `comment-form`, `search-form` for backward compatibility.
* As of WordPress 6.0, the previously added `_doing_it_wrong()` notice is actually displayed as expected.
Follow-up to [25193], [25235], [25785], [49344], [49354], [52828].
Props bobbingwide.
See #51657, #55646.
Built from https://develop.svn.wordpress.org/trunk@53513
git-svn-id: http://core.svn.wordpress.org/trunk@53102 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-06-16 11:21:15 -04:00
* @ since 6.0 . 0 The `html5` feature warns if no array is passed as the second parameter .
2024-02-08 23:17:13 -05:00
* @ since 6.1 . 0 The `block-template-parts` feature allows to edit any reusable template part from site editor .
* @ since 6.1 . 0 The `disable-layout-styles` feature disables the default layout styles .
* @ since 6.3 . 0 The `link-color` feature allows to enable the link color setting .
* @ since 6.3 . 0 The `border` feature allows themes without theme . json to add border styles to blocks .
2024-01-09 06:41:18 -05:00
* @ since 6.5 . 0 The `appearance-tools` feature enables a few design tools for blocks ,
* see `WP_Theme_JSON::APPEARANCE_TOOLS_OPT_INS` for a complete list .
2014-03-31 18:20:16 -04:00
*
2015-05-27 18:21:25 -04:00
* @ global array $_wp_theme_features
*
2021-02-20 12:10:11 -05:00
* @ param string $feature The feature being added . Likely core values include :
* - 'admin-bar'
* - 'align-wide'
2024-01-09 06:41:18 -05:00
* - 'appearance-tools'
2021-02-20 12:10:11 -05:00
* - 'automatic-feed-links'
2024-02-08 23:17:13 -05:00
* - 'block-templates'
* - 'block-template-parts'
* - 'border'
2021-02-20 12:10:11 -05:00
* - 'core-block-patterns'
* - 'custom-background'
* - 'custom-header'
* - 'custom-line-height'
* - 'custom-logo'
* - 'customize-selective-refresh-widgets'
* - 'custom-spacing'
* - 'custom-units'
* - 'dark-editor-style'
* - 'disable-custom-colors'
* - 'disable-custom-font-sizes'
2024-02-08 23:17:13 -05:00
* - 'disable-custom-gradients'
* - 'disable-layout-styles'
2021-02-20 12:10:11 -05:00
* - 'editor-color-palette'
* - 'editor-gradient-presets'
* - 'editor-font-sizes'
* - 'editor-styles'
* - 'featured-content'
* - 'html5'
2024-02-08 23:17:13 -05:00
* - 'link-color'
2021-02-20 12:10:11 -05:00
* - 'menus'
* - 'post-formats'
* - 'post-thumbnails'
* - 'responsive-embeds'
* - 'starter-content'
* - 'title-tag'
* - 'widgets'
2021-06-22 21:08:58 -04:00
* - 'widgets-block-editor'
2024-02-08 23:17:13 -05:00
* - 'wp-block-styles'
2019-05-25 17:59:51 -04:00
* @ param mixed ... $args Optional extra arguments to pass along with certain features .
2021-01-05 11:48:07 -05:00
* @ return void | false Void on success , false on failure .
2009-11-01 01:27:39 -04:00
*/
2019-07-11 20:10:56 -04:00
function add_theme_support ( $feature , ... $args ) {
2009-11-01 01:27:39 -04:00
global $_wp_theme_features ;
2009-12-09 10:39:20 -05:00
2019-07-11 20:10:56 -04:00
if ( ! $args ) {
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 13:12:44 -04:00
$args = true ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
switch ( $feature ) {
2016-04-26 13:05:31 -04:00
case 'post-thumbnails' :
// All post types are already supported.
if ( true === get_theme_support ( 'post-thumbnails' ) ) {
return ;
}
/*
* Merge post types with any that already declared their support
* for post thumbnails .
*/
2019-07-15 02:25:57 -04:00
if ( isset ( $args [ 0 ] ) && is_array ( $args [ 0 ] ) && isset ( $_wp_theme_features [ 'post-thumbnails' ] ) ) {
2016-04-26 16:29:27 -04:00
$args [ 0 ] = array_unique ( array_merge ( $_wp_theme_features [ 'post-thumbnails' ][ 0 ], $args [ 0 ] ) );
2016-04-26 13:05:31 -04:00
}
break ;
2017-11-30 18:11:00 -05:00
case 'post-formats' :
2019-07-15 02:25:57 -04:00
if ( isset ( $args [ 0 ] ) && is_array ( $args [ 0 ] ) ) {
2014-10-27 07:26:18 -04:00
$post_formats = get_post_format_slugs ();
unset ( $post_formats [ 'standard' ] );
$args [ 0 ] = array_intersect ( $args [ 0 ], array_keys ( $post_formats ) );
2020-10-27 16:00:06 -04:00
} else {
2021-12-09 10:13:04 -05:00
_doing_it_wrong (
" add_theme_support( 'post-formats' ) " ,
__ ( 'You need to pass an array of post formats.' ),
'5.6.0'
);
2020-10-27 16:00:06 -04:00
return false ;
2014-10-27 07:26:18 -04: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 13:12:44 -04:00
break ;
2017-11-30 18:11:00 -05:00
case 'html5' :
2013-08-30 21:30:09 -04:00
// You can't just pass 'html5', you need to pass an array of types.
2022-03-07 09:44:01 -05:00
if ( empty ( $args [ 0 ] ) || ! is_array ( $args [ 0 ] ) ) {
2021-12-09 10:13:04 -05:00
_doing_it_wrong (
" add_theme_support( 'html5' ) " ,
__ ( 'You need to pass an array of types.' ),
'3.6.1'
);
2022-03-07 09:44:01 -05:00
if ( ! empty ( $args [ 0 ] ) && ! is_array ( $args [ 0 ] ) ) {
return false ;
}
// Build an array of types for back-compat.
$args = array ( 0 => array ( 'comment-list' , 'comment-form' , 'search-form' ) );
2013-09-04 13:44:09 -04:00
}
2013-08-30 21:30:09 -04:00
// Calling 'html5' again merges, rather than overwrites.
2017-11-30 18:11:00 -05:00
if ( isset ( $_wp_theme_features [ 'html5' ] ) ) {
2013-08-30 21:30:09 -04:00
$args [ 0 ] = array_merge ( $_wp_theme_features [ 'html5' ][ 0 ], $args [ 0 ] );
2017-11-30 18:11:00 -05:00
}
2013-08-30 21:30:09 -04:00
break ;
2016-03-23 22:02:27 -04:00
case 'custom-logo' :
2019-07-15 02:25:57 -04:00
if ( true === $args ) {
2016-03-29 22:22:26 -04:00
$args = array ( 0 => array () );
}
2016-03-23 22:02:27 -04:00
$defaults = array (
2020-08-07 11:26:03 -04:00
'width' => null ,
'height' => null ,
'flex-width' => false ,
'flex-height' => false ,
'header-text' => '' ,
'unlink-homepage-logo' => false ,
2016-03-23 22:02:27 -04:00
);
2017-11-30 18:11:00 -05:00
$args [ 0 ] = wp_parse_args ( array_intersect_key ( $args [ 0 ], $defaults ), $defaults );
2016-03-23 22:02:27 -04:00
// Allow full flexibility if no size is specified.
if ( is_null ( $args [ 0 ][ 'width' ] ) && is_null ( $args [ 0 ][ 'height' ] ) ) {
$args [ 0 ][ 'flex-width' ] = true ;
$args [ 0 ][ 'flex-height' ] = true ;
}
break ;
2017-11-30 18:11:00 -05:00
case 'custom-header-uploads' :
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 13:12:44 -04:00
return add_theme_support ( 'custom-header' , array ( 'uploads' => true ) );
2017-11-30 18:11:00 -05:00
case 'custom-header' :
2019-07-15 02:25:57 -04:00
if ( true === $args ) {
2012-03-20 16:34:49 -04:00
$args = array ( 0 => array () );
2017-11-30 18:11:00 -05:00
}
2012-03-20 16:34:49 -04: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 13:12:44 -04:00
$defaults = array (
2017-11-30 18:11:00 -05:00
'default-image' => '' ,
'random-default' => false ,
'width' => 0 ,
'height' => 0 ,
'flex-height' => false ,
'flex-width' => false ,
'default-text-color' => '' ,
'header-text' => true ,
'uploads' => true ,
'wp-head-callback' => '' ,
'admin-head-callback' => '' ,
2012-03-20 23:36:17 -04:00
'admin-preview-callback' => '' ,
2017-11-30 18:11:00 -05:00
'video' => false ,
'video-active-callback' => 'is_front_page' ,
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 13:12:44 -04:00
);
$jit = isset ( $args [ 0 ][ '__jit' ] );
unset ( $args [ 0 ][ '__jit' ] );
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* Merge in data from previous add_theme_support () calls .
* The first value registered wins . ( A child theme is set up first . )
*/
2017-11-30 18:11:00 -05:00
if ( isset ( $_wp_theme_features [ 'custom-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 13:12:44 -04:00
$args [ 0 ] = wp_parse_args ( $_wp_theme_features [ 'custom-header' ][ 0 ], $args [ 0 ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* 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 .
*/
2017-11-30 18:11:00 -05:00
if ( $jit ) {
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 13:12:44 -04:00
$args [ 0 ] = wp_parse_args ( $args [ 0 ], $defaults );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2020-01-28 19:45:18 -05:00
/*
* 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 .
2024-02-11 14:14:19 -05:00
* Constants should be avoided . Don ' t reference them . This is just for backward compatibility .
2020-01-28 19:45:18 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( 'NO_HEADER_TEXT' ) ) {
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 13:12:44 -04:00
$args [ 0 ][ 'header-text' ] = ! NO_HEADER_TEXT ;
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $args [ 0 ][ 'header-text' ] ) ) {
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 13:12:44 -04:00
define ( 'NO_HEADER_TEXT' , empty ( $args [ 0 ][ 'header-text' ] ) );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( 'HEADER_IMAGE_WIDTH' ) ) {
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 13:12:44 -04:00
$args [ 0 ][ 'width' ] = ( int ) HEADER_IMAGE_WIDTH ;
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $args [ 0 ][ 'width' ] ) ) {
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 13:12:44 -04:00
define ( 'HEADER_IMAGE_WIDTH' , ( int ) $args [ 0 ][ 'width' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( 'HEADER_IMAGE_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 13:12:44 -04:00
$args [ 0 ][ 'height' ] = ( int ) HEADER_IMAGE_HEIGHT ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
define ( 'HEADER_IMAGE_HEIGHT' , ( int ) $args [ 0 ][ 'height' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( '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 13:12:44 -04:00
$args [ 0 ][ 'default-text-color' ] = HEADER_TEXTCOLOR ;
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $args [ 0 ][ 'default-text-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 13:12:44 -04:00
define ( 'HEADER_TEXTCOLOR' , $args [ 0 ][ 'default-text-color' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( '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 13:12:44 -04:00
$args [ 0 ][ 'default-image' ] = HEADER_IMAGE ;
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $args [ 0 ][ 'default-image' ] ) ) {
2012-03-20 16:34:49 -04:00
define ( 'HEADER_IMAGE' , $args [ 0 ][ 'default-image' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( $jit && ! empty ( $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 13:12:44 -04:00
$args [ 0 ][ 'random-default' ] = false ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* If headers are supported , and we still don ' t have a defined width or height ,
* we have implicit flex sizes .
*/
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 13:12:44 -04:00
if ( $jit ) {
2017-11-30 18:11:00 -05:00
if ( empty ( $args [ 0 ][ 'width' ] ) && empty ( $args [ 0 ][ 'flex-width' ] ) ) {
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 13:12:44 -04:00
$args [ 0 ][ 'flex-width' ] = true ;
2017-11-30 18:11:00 -05:00
}
if ( empty ( $args [ 0 ][ 'height' ] ) && empty ( $args [ 0 ][ 'flex-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 13:12:44 -04:00
$args [ 0 ][ 'flex-height' ] = true ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
}
break ;
2017-11-30 18:11:00 -05:00
case 'custom-background' :
2019-07-15 02:25:57 -04:00
if ( true === $args ) {
2012-03-20 16:34:49 -04:00
$args = array ( 0 => array () );
2017-11-30 18:11:00 -05:00
}
2012-03-20 16:34:49 -04: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 13:12:44 -04:00
$defaults = array (
2013-11-24 09:05:10 -05:00
'default-image' => '' ,
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
'default-preset' => 'default' ,
2013-12-03 16:36:10 -05:00
'default-position-x' => 'left' ,
Customize: Improve custom background properties UI.
Introduces new control for managing the background position. Adds control for setting the `background-size`.
Props cdog, celloexpressions, grapplerulrich, MikeHansenMe, FolioVision, afercia, helen, melchoyce, karmatosed, westonruter, Kelderic, sebastian.pisula.
Fixes #22058.
Built from https://develop.svn.wordpress.org/trunk@38948
git-svn-id: http://core.svn.wordpress.org/trunk@38891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 02:52:29 -04:00
'default-position-y' => 'top' ,
'default-size' => 'auto' ,
'default-repeat' => 'repeat' ,
2013-12-03 16:36:10 -05:00
'default-attachment' => 'scroll' ,
2013-11-24 09:05:10 -05:00
'default-color' => '' ,
'wp-head-callback' => '_custom_background_cb' ,
'admin-head-callback' => '' ,
2012-03-20 23:36:17 -04: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 13:12:44 -04:00
);
$jit = isset ( $args [ 0 ][ '__jit' ] );
unset ( $args [ 0 ][ '__jit' ] );
// Merge in data from previous add_theme_support() calls. The first value registered wins.
2017-11-30 18:11:00 -05:00
if ( isset ( $_wp_theme_features [ '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 13:12:44 -04:00
$args [ 0 ] = wp_parse_args ( $_wp_theme_features [ 'custom-background' ][ 0 ], $args [ 0 ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( $jit ) {
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 13:12:44 -04:00
$args [ 0 ] = wp_parse_args ( $args [ 0 ], $defaults );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( '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 13:12:44 -04:00
$args [ 0 ][ 'default-color' ] = BACKGROUND_COLOR ;
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $args [ 0 ][ 'default-color' ] ) || $jit ) {
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 13:12:44 -04:00
define ( 'BACKGROUND_COLOR' , $args [ 0 ][ 'default-color' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( defined ( '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 13:12:44 -04:00
$args [ 0 ][ 'default-image' ] = BACKGROUND_IMAGE ;
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $args [ 0 ][ 'default-image' ] ) || $jit ) {
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 13:12:44 -04:00
define ( 'BACKGROUND_IMAGE' , $args [ 0 ][ 'default-image' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
break ;
2014-10-28 17:12:22 -04:00
// Ensure that 'title-tag' is accessible in the admin.
2017-11-30 18:11:00 -05:00
case 'title-tag' :
2014-10-28 17:12:22 -04:00
// Can be called in functions.php but must happen before wp_loaded, i.e. not in header.php.
if ( did_action ( 'wp_loaded' ) ) {
2017-11-30 18:11:00 -05:00
_doing_it_wrong (
2018-08-16 21:51:36 -04:00
" add_theme_support( 'title-tag' ) " ,
sprintf (
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
/* translators: 1: title-tag, 2: wp_loaded */
2017-11-30 18:11:00 -05:00
__ ( 'Theme support for %1$s should be registered before the %2$s hook.' ),
2018-08-16 21:51:36 -04:00
'<code>title-tag</code>' ,
'<code>wp_loaded</code>'
),
'4.1.0'
2017-11-30 18:11:00 -05:00
);
2014-10-28 17:12:22 -04: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 13:12:44 -04:00
}
$_wp_theme_features [ $feature ] = $args ;
}
/**
* Registers the internal custom header and background routines .
*
* @ since 3.4 . 0
* @ access private
2015-05-27 18:21:25 -04:00
*
* @ global Custom_Image_Header $custom_image_header
* @ global Custom_Background $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 13:12:44 -04:00
*/
function _custom_header_background_just_in_time () {
global $custom_image_header , $custom_background ;
if ( current_theme_supports ( 'custom-header' ) ) {
// In case any constants were defined after an add_custom_image_header() call, re-run.
add_theme_support ( 'custom-header' , array ( '__jit' => true ) );
$args = get_theme_support ( 'custom-header' );
2017-11-30 18:11:00 -05:00
if ( $args [ 0 ][ 'wp-head-callback' ] ) {
2012-03-20 23:36:17 -04:00
add_action ( 'wp_head' , $args [ 0 ][ 'wp-head-callback' ] );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2012-05-03 09:30:55 -04:00
if ( is_admin () ) {
2020-02-06 01:33:11 -05:00
require_once ABSPATH . 'wp-admin/includes/class-custom-image-header.php' ;
2012-05-03 09:30:55 -04:00
$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 13:12:44 -04:00
}
}
2011-01-05 23:11:14 -05: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 13:12:44 -04: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-20 23:36:17 -04: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 13:12:44 -04:00
if ( is_admin () ) {
2020-02-06 01:33:11 -05:00
require_once ABSPATH . 'wp-admin/includes/class-custom-background.php' ;
2012-03-20 23:36:17 -04: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 13:12:44 -04:00
}
2012-03-19 17:14:41 -04:00
}
2009-11-01 01:27:39 -04:00
}
2016-03-10 00:37:27 -05:00
/**
* Adds CSS to hide header text for custom logo , based on Customizer setting .
*
* @ since 4.5 . 0
* @ access private
*/
function _custom_logo_header_styles () {
2021-12-09 10:13:04 -05:00
if ( ! current_theme_supports ( 'custom-header' , 'header-text' )
&& get_theme_support ( 'custom-logo' , 'header-text' )
&& ! get_theme_mod ( 'header_text' , true )
) {
2016-03-10 00:37:27 -05:00
$classes = ( array ) get_theme_support ( 'custom-logo' , 'header-text' );
$classes = array_map ( 'sanitize_html_class' , $classes );
$classes = '.' . implode ( ', .' , $classes );
2019-09-18 10:50:56 -04:00
$type_attr = current_theme_supports ( 'html5' , 'style' ) ? '' : ' type="text/css"' ;
2016-03-10 00:37:27 -05:00
?>
<!-- Custom Logo : hide header text -->
2019-09-18 10:50:56 -04:00
< style id = " custom-logo-css " < ? php echo $type_attr ; ?> >
2016-03-10 00:37:27 -05:00
< ? php echo $classes ; ?> {
position : absolute ;
clip : rect ( 1 px , 1 px , 1 px , 1 px );
}
</ style >
2018-08-16 21:51:36 -04:00
< ? php
2016-03-10 00:37:27 -05:00
}
}
2010-11-04 03:41:07 -04:00
/**
2020-07-15 07:23:06 -04:00
* Gets the theme support arguments passed when registering that support .
2010-11-04 03:41:07 -04:00
*
2019-05-25 19:41:54 -04:00
* Example usage :
*
* get_theme_support ( 'custom-logo' );
* get_theme_support ( 'custom-header' , 'width' );
*
2013-12-24 13:57:12 -05:00
* @ since 3.1 . 0
2019-10-09 00:28:02 -04:00
* @ since 5.3 . 0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature .
2013-12-24 13:57:12 -05:00
*
2015-05-27 18:21:25 -04:00
* @ global array $_wp_theme_features
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The feature to check . See add_theme_support () for the list
* of possible values .
2019-05-25 19:41:54 -04:00
* @ param mixed ... $args Optional extra arguments to be checked against certain features .
2014-11-03 00:18:22 -05:00
* @ return mixed The array of extra arguments or the value for the registered feature .
2010-11-04 03:41:07 -04:00
*/
2019-07-11 20:10:56 -04:00
function get_theme_support ( $feature , ... $args ) {
2010-11-04 03:41:07 -04:00
global $_wp_theme_features ;
2021-12-09 10:13:04 -05:00
2017-11-30 18:11:00 -05:00
if ( ! isset ( $_wp_theme_features [ $feature ] ) ) {
2010-11-04 03:41:07 -04:00
return false ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2019-07-11 20:10:56 -04:00
if ( ! $args ) {
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 13:12:44 -04:00
return $_wp_theme_features [ $feature ];
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
switch ( $feature ) {
2017-11-30 18:11:00 -05:00
case 'custom-logo' :
case 'custom-header' :
case 'custom-background' :
if ( isset ( $_wp_theme_features [ $feature ][ 0 ][ $args [ 0 ] ] ) ) {
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 13:12:44 -04:00
return $_wp_theme_features [ $feature ][ 0 ][ $args [ 0 ] ];
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
return false ;
2014-05-06 23:50:14 -04:00
2017-11-30 18:11:00 -05:00
default :
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 13:12:44 -04:00
return $_wp_theme_features [ $feature ];
}
2010-11-04 03:41:07 -04:00
}
2010-03-29 12:26:54 -04:00
/**
* Allows a theme to de - register its support of a certain feature
*
2010-03-31 05:06:11 -04: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 12:26:54 -04:00
*
* @ since 3.0 . 0
2020-06-16 17:07:14 -04:00
*
2010-03-31 05:06:11 -04:00
* @ see add_theme_support ()
2020-06-16 17:07:14 -04:00
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The feature being removed . See add_theme_support () for the list
* of possible values .
2015-05-27 18:21:25 -04:00
* @ return bool | void Whether feature was removed .
2010-03-29 12:26:54 -04:00
*/
function remove_theme_support ( $feature ) {
General: Remove “whitelist” and “blacklist” in favor of more clear and inclusive language.
“The WordPress open source community cares about diversity. We strive to maintain a welcoming environment where everyone can feel included.”
With this commit, all occurrences of “whitelist” and “blacklist” (with the single exception of the `$new_whitelist_options` global variable) are removed. A new ticket has been opened to explore renaming the `$new_whitelist_options` variable (#50434).
Changing to more specific names or rewording sentences containing these terms not only makes the code more inclusive, but also helps provide clarity. These terms are often ambiguous. What is being blocked or allowed is not always immediately clear. This can make it more difficult for non-native English speakers to read through the codebase.
Words matter. If one contributor feels more welcome because these terms are removed, this was worth the effort.
Props strangerstudios, jorbin, desrosj, joemcgill, timothyblynjacobs, ocean90, ayeshrajans, davidbaumwald, earnjam.
See #48900, #50434.
Fixes #50413.
Built from https://develop.svn.wordpress.org/trunk@48121
git-svn-id: http://core.svn.wordpress.org/trunk@47890 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-22 13:26:13 -04:00
// Do not remove internal registrations that are not used directly by themes.
2020-04-04 23:02:11 -04:00
if ( in_array ( $feature , array ( 'editor-style' , 'widgets' , 'menus' ), true ) ) {
2010-03-31 05:06:11 -04:00
return false ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2010-12-01 19:16:35 -05:00
return _remove_theme_support ( $feature );
}
2010-03-31 05:06:11 -04:00
2010-12-01 19:16:35 -05:00
/**
2020-06-27 08:02:03 -04:00
* Do not use . Removes theme support internally without knowledge of those not used
* by themes directly .
2010-12-01 19:16:35 -05:00
*
* @ access private
* @ since 3.1 . 0
2015-05-27 18:21:25 -04:00
* @ global array $_wp_theme_features
* @ global Custom_Image_Header $custom_image_header
* @ global Custom_Background $custom_background
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The feature being removed . See add_theme_support () for the list
* of possible values .
2020-06-20 08:02:12 -04:00
* @ return bool True if support was removed , false if the feature was not registered .
2010-12-01 19:16:35 -05:00
*/
function _remove_theme_support ( $feature ) {
2010-03-29 12:26:54 -04: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 13:12:44 -04:00
switch ( $feature ) {
2017-11-30 18:11:00 -05:00
case 'custom-header-uploads' :
if ( ! isset ( $_wp_theme_features [ 'custom-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 13:12:44 -04:00
return false ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
add_theme_support ( 'custom-header' , array ( 'uploads' => false ) );
return ; // Do not continue - custom-header-uploads no longer exists.
}
2017-11-30 18:11:00 -05:00
if ( ! isset ( $_wp_theme_features [ $feature ] ) ) {
2010-03-31 05:06:11 -04:00
return false ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
switch ( $feature ) {
2017-11-30 18:11:00 -05:00
case 'custom-header' :
if ( ! did_action ( 'wp_loaded' ) ) {
2012-10-26 00:17:25 -04:00
break ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
$support = get_theme_support ( 'custom-header' );
2016-11-15 02:16:33 -05:00
if ( isset ( $support [ 0 ][ 'wp-head-callback' ] ) ) {
2012-03-20 23:36:17 -04:00
remove_action ( 'wp_head' , $support [ 0 ][ 'wp-head-callback' ] );
2016-11-15 02:16:33 -05:00
}
if ( isset ( $GLOBALS [ 'custom_image_header' ] ) ) {
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 13:12:44 -04:00
break ;
2017-11-30 18:11:00 -05:00
case 'custom-background' :
if ( ! did_action ( 'wp_loaded' ) ) {
2012-10-26 00:17:25 -04:00
break ;
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
$support = get_theme_support ( 'custom-background' );
2019-04-01 12:18:52 -04:00
if ( isset ( $support [ 0 ][ 'wp-head-callback' ] ) ) {
remove_action ( 'wp_head' , $support [ 0 ][ 'wp-head-callback' ] );
}
2012-10-26 00:16:49 -04:00
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 13:12:44 -04:00
break ;
}
unset ( $_wp_theme_features [ $feature ] );
2020-06-20 08:02:12 -04:00
2010-03-31 05:06:11 -04:00
return true ;
2010-03-29 12:26:54 -04:00
}
2009-11-01 01:27:39 -04:00
/**
2019-04-01 12:21:50 -04:00
* Checks a theme ' s support for a given feature .
2009-11-01 01:27:39 -04:00
*
2019-05-25 19:41:54 -04:00
* Example usage :
*
* current_theme_supports ( 'custom-logo' );
* current_theme_supports ( 'html5' , 'comment-form' );
*
2010-03-26 15:23:39 -04:00
* @ since 2.9 . 0
2019-10-09 00:28:02 -04:00
* @ since 5.3 . 0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature .
2015-05-27 18:21:25 -04:00
*
* @ global array $_wp_theme_features
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The feature being checked . See add_theme_support () for the list
* of possible values .
2019-05-25 19:41:54 -04:00
* @ param mixed ... $args Optional extra arguments to be checked against certain features .
2022-01-20 18:53:05 -05:00
* @ return bool True if the active theme supports the feature , false otherwise .
2009-11-01 01:27:39 -04:00
*/
2019-07-11 20:10:56 -04:00
function current_theme_supports ( $feature , ... $args ) {
2009-11-01 01:27:39 -04:00
global $_wp_theme_features ;
2009-12-09 10:39:20 -05:00
2020-05-16 14:42:12 -04:00
if ( 'custom-header-uploads' === $feature ) {
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 13:12:44 -04:00
return current_theme_supports ( 'custom-header' , 'uploads' );
2017-11-30 18:11:00 -05: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 13:12:44 -04:00
2017-11-30 18:11:00 -05:00
if ( ! isset ( $_wp_theme_features [ $feature ] ) ) {
2009-12-09 10:39:20 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2009-12-09 10:39:20 -05:00
2022-03-01 11:07:05 -05:00
// If no args passed then no extra checks need to be performed.
2019-07-11 20:10:56 -04:00
if ( ! $args ) {
2022-03-01 11:07:05 -05:00
/** This filter is documented in wp-includes/theme.php */
return apply_filters ( " current_theme_supports- { $feature } " , true , $args , $_wp_theme_features [ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
2017-11-30 18:11:00 -05:00
}
2009-12-09 10:39:20 -05:00
switch ( $feature ) {
2009-12-10 01:14:36 -05:00
case 'post-thumbnails' :
2020-01-28 19:45:18 -05:00
/*
* post - thumbnails can be registered for only certain content / post types
* by passing an array of types to add_theme_support () .
* If no array was passed , then any type is accepted .
*/
2020-04-04 23:02:11 -04:00
if ( true === $_wp_theme_features [ $feature ] ) { // Registered for all types.
2009-12-09 10:39:20 -05:00
return true ;
2017-11-30 18:11:00 -05:00
}
2009-12-09 10:39:20 -05:00
$content_type = $args [ 0 ];
2020-04-04 23:02:11 -04:00
return in_array ( $content_type , $_wp_theme_features [ $feature ][ 0 ], true );
2011-09-19 12:29:03 -04:00
2013-08-30 21:30:09 -04:00
case 'html5' :
2011-09-19 12:29:03 -04:00
case 'post-formats' :
2020-01-28 19:45:18 -05:00
/*
* Specific post formats can be registered by passing an array of types
* to add_theme_support () .
*
* Specific areas of HTML5 support * must * be passed via an array to add_theme_support () .
*/
2013-08-30 21:30:09 -04:00
$type = $args [ 0 ];
2020-04-04 23:02:11 -04:00
return in_array ( $type , $_wp_theme_features [ $feature ][ 0 ], true );
2012-02-02 18:35:37 -05:00
2016-03-09 16:51:27 -05:00
case 'custom-logo' :
2012-02-02 18:35:37 -05:00
case 'custom-header' :
2016-03-09 16:51:27 -05:00
case 'custom-background' :
// Specific capabilities can be registered by passing an array to add_theme_support().
return ( isset ( $_wp_theme_features [ $feature ][ 0 ][ $args [ 0 ] ] ) && $_wp_theme_features [ $feature ][ 0 ][ $args [ 0 ] ] );
2009-12-09 10:39:20 -05:00
}
2013-12-01 12:24:11 -05:00
/**
2022-01-20 18:53:05 -05:00
* Filters whether the active theme supports a specific feature .
2013-12-01 12:24:11 -05:00
*
2020-07-15 07:23:06 -04:00
* The dynamic portion of the hook name , `$feature` , refers to the specific
* theme feature . See add_theme_support () for the list of possible values .
2013-12-01 12:24:11 -05:00
*
* @ since 3.4 . 0
*
2022-01-20 18:53:05 -05:00
* @ param bool $supports Whether the active theme supports the given feature . Default true .
2019-10-27 15:11:02 -04:00
* @ param array $args Array of arguments for the feature .
* @ param string $feature The theme feature .
2013-12-01 12:24:11 -05:00
*/
2019-07-04 21:45:56 -04:00
return apply_filters ( " current_theme_supports- { $feature } " , true , $args , $_wp_theme_features [ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
2009-11-01 01:27:39 -04:00
}
2012-04-29 22:02:11 -04:00
/**
* Checks a theme ' s support for a given feature before loading the functions which implement it .
*
* @ since 2.9 . 0
2014-02-20 17:11:14 -05:00
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The feature being checked . See add_theme_support () for the list
* of possible values .
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
* @ param string $file Path to the file .
2022-01-20 18:53:05 -05:00
* @ return bool True if the active theme supports the supplied feature , false otherwise .
2012-04-29 22:02:11 -04:00
*/
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
function require_if_theme_supports ( $feature , $file ) {
2014-02-20 17:11:14 -05:00
if ( current_theme_supports ( $feature ) ) {
Code Modernization: Rename parameters that use reserved keywords in `wp-includes/theme.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit:
* Renames the `$default` parameter to `$default_value` in `get_theme_mod()`.
* Renames the `$include` parameter to `$file` in `require_if_theme_supports()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@55014
git-svn-id: http://core.svn.wordpress.org/trunk@54547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-23 06:38:15 -05:00
require $file ;
2014-02-20 17:11:14 -05:00
return true ;
}
return false ;
2012-04-29 22:02:11 -04:00
}
2020-06-25 18:13:10 -04:00
/**
2020-06-27 08:02:03 -04:00
* Registers a theme feature for use in add_theme_support () .
2020-06-25 18:13:10 -04:00
*
2022-01-20 18:53:05 -05:00
* This does not indicate that the active theme supports the feature , it only describes
2020-06-27 08:02:03 -04:00
* the feature ' s supported options .
2020-06-25 18:13:10 -04:00
*
* @ since 5.5 . 0
*
2020-06-27 08:02:03 -04:00
* @ see add_theme_support ()
*
2020-07-23 03:39:02 -04:00
* @ global array $_wp_registered_theme_features
2020-06-25 18:13:10 -04:00
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The name uniquely identifying the feature . See add_theme_support ()
* for the list of possible values .
2020-07-23 17:11:05 -04:00
* @ param array $args {
* Data used to describe the theme .
*
* @ type string $type The type of data associated with this feature .
* Valid values are 'string' , 'boolean' , 'integer' ,
* 'number' , 'array' , and 'object' . Defaults to 'boolean' .
2021-10-29 19:13:05 -04:00
* @ type bool $variadic Does this feature utilize the variadic support
2020-07-23 17:11:05 -04:00
* of add_theme_support (), or are all arguments specified
* as the second parameter . Must be used with the " array " type .
* @ type string $description A short description of the feature . Included in
* the Themes REST API schema . Intended for developers .
* @ type bool | array $show_in_rest {
* Whether this feature should be included in the Themes REST API endpoint .
* Defaults to not being included . When registering an 'array' or 'object' type ,
* this argument must be an array with the 'schema' key .
*
* @ type array $schema Specifies the JSON Schema definition describing
* the feature . If any objects in the schema do not include
* the 'additionalProperties' keyword , it is set to false .
* @ type string $name An alternate name to be used as the property name
* in the REST API .
* @ type callable $prepare_callback A function used to format the theme support in the REST API .
* Receives the raw theme support value .
2020-06-25 18:13:10 -04:00
* }
* }
* @ return true | WP_Error True if the theme feature was successfully registered , a WP_Error object if not .
*/
function register_theme_feature ( $feature , $args = array () ) {
global $_wp_registered_theme_features ;
if ( ! is_array ( $_wp_registered_theme_features ) ) {
$_wp_registered_theme_features = array ();
}
$defaults = array (
'type' => 'boolean' ,
'variadic' => false ,
'description' => '' ,
'show_in_rest' => false ,
);
$args = wp_parse_args ( $args , $defaults );
if ( true === $args [ 'show_in_rest' ] ) {
$args [ 'show_in_rest' ] = array ();
}
if ( is_array ( $args [ 'show_in_rest' ] ) ) {
$args [ 'show_in_rest' ] = wp_parse_args (
$args [ 'show_in_rest' ],
array (
'schema' => array (),
'name' => $feature ,
'prepare_callback' => null ,
)
);
}
if ( ! in_array ( $args [ 'type' ], array ( 'string' , 'boolean' , 'integer' , 'number' , 'array' , 'object' ), true ) ) {
2020-06-27 08:02:03 -04:00
return new WP_Error (
'invalid_type' ,
__ ( 'The feature "type" is not valid JSON Schema type.' )
);
2020-06-25 18:13:10 -04:00
}
if ( true === $args [ 'variadic' ] && 'array' !== $args [ 'type' ] ) {
2020-06-27 08:02:03 -04:00
return new WP_Error (
'variadic_must_be_array' ,
__ ( 'When registering a "variadic" theme feature, the "type" must be an "array".' )
);
2020-06-25 18:13:10 -04:00
}
if ( false !== $args [ 'show_in_rest' ] && in_array ( $args [ 'type' ], array ( 'array' , 'object' ), true ) ) {
if ( ! is_array ( $args [ 'show_in_rest' ] ) || empty ( $args [ 'show_in_rest' ][ 'schema' ] ) ) {
2020-06-27 08:02:03 -04:00
return new WP_Error (
'missing_schema' ,
__ ( 'When registering an "array" or "object" feature to show in the REST API, the feature\'s schema must also be defined.' )
);
2020-06-25 18:13:10 -04:00
}
if ( 'array' === $args [ 'type' ] && ! isset ( $args [ 'show_in_rest' ][ 'schema' ][ 'items' ] ) ) {
2020-06-27 08:02:03 -04:00
return new WP_Error (
'missing_schema_items' ,
__ ( 'When registering an "array" feature, the feature\'s schema must include the "items" keyword.' )
);
2020-06-25 18:13:10 -04:00
}
if ( 'object' === $args [ 'type' ] && ! isset ( $args [ 'show_in_rest' ][ 'schema' ][ 'properties' ] ) ) {
2020-06-27 08:02:03 -04:00
return new WP_Error (
'missing_schema_properties' ,
__ ( 'When registering an "object" feature, the feature\'s schema must include the "properties" keyword.' )
);
2020-06-25 18:13:10 -04:00
}
}
if ( is_array ( $args [ 'show_in_rest' ] ) ) {
2021-12-09 10:13:04 -05:00
if ( isset ( $args [ 'show_in_rest' ][ 'prepare_callback' ] )
&& ! is_callable ( $args [ 'show_in_rest' ][ 'prepare_callback' ] )
) {
2020-06-27 08:02:03 -04:00
return new WP_Error (
'invalid_rest_prepare_callback' ,
2020-07-25 12:31:05 -04:00
sprintf (
/* translators: %s: prepare_callback */
2020-07-25 12:39:05 -04:00
__ ( 'The "%s" must be a callable function.' ),
'prepare_callback'
2020-07-25 12:31:05 -04:00
)
2020-06-27 08:02:03 -04:00
);
2020-06-25 18:13:10 -04:00
}
$args [ 'show_in_rest' ][ 'schema' ] = wp_parse_args (
$args [ 'show_in_rest' ][ 'schema' ],
array (
'description' => $args [ 'description' ],
'type' => $args [ 'type' ],
'default' => false ,
)
);
2020-06-27 08:02:03 -04:00
if ( is_bool ( $args [ 'show_in_rest' ][ 'schema' ][ 'default' ] )
&& ! in_array ( 'boolean' , ( array ) $args [ 'show_in_rest' ][ 'schema' ][ 'type' ], true )
) {
2020-06-25 18:13:10 -04:00
// Automatically include the "boolean" type when the default value is a boolean.
$args [ 'show_in_rest' ][ 'schema' ][ 'type' ] = ( array ) $args [ 'show_in_rest' ][ 'schema' ][ 'type' ];
array_unshift ( $args [ 'show_in_rest' ][ 'schema' ][ 'type' ], 'boolean' );
}
$args [ 'show_in_rest' ][ 'schema' ] = rest_default_additional_properties_to_false ( $args [ 'show_in_rest' ][ 'schema' ] );
}
$_wp_registered_theme_features [ $feature ] = $args ;
return true ;
}
/**
* Gets the list of registered theme features .
*
* @ since 5.5 . 0
*
2020-07-23 03:39:02 -04:00
* @ global array $_wp_registered_theme_features
2020-06-25 18:13:10 -04:00
*
* @ return array [] List of theme features , keyed by their name .
*/
function get_registered_theme_features () {
global $_wp_registered_theme_features ;
if ( ! is_array ( $_wp_registered_theme_features ) ) {
return array ();
}
return $_wp_registered_theme_features ;
}
/**
* Gets the registration config for a theme feature .
*
* @ since 5.5 . 0
*
2020-07-23 03:39:02 -04:00
* @ global array $_wp_registered_theme_features
2020-06-25 18:13:10 -04:00
*
2020-07-15 07:23:06 -04:00
* @ param string $feature The feature name . See add_theme_support () for the list
* of possible values .
2020-06-25 18:13:10 -04:00
* @ return array | null The registration args , or null if the feature was not registered .
*/
function get_registered_theme_feature ( $feature ) {
global $_wp_registered_theme_features ;
if ( ! is_array ( $_wp_registered_theme_features ) ) {
return null ;
}
return isset ( $_wp_registered_theme_features [ $feature ] ) ? $_wp_registered_theme_features [ $feature ] : null ;
}
2010-05-24 15:42:43 -04:00
/**
2010-05-24 17:26:49 -04:00
* Checks an attachment being deleted to see if it ' s a header or background image .
2010-05-25 22:42:15 -04:00
*
2010-05-24 17:26:49 -04:00
* If true it removes the theme modification which would be pointing at the deleted
2015-07-15 12:28:25 -04:00
* attachment .
2010-05-24 15:42:43 -04:00
*
2010-05-24 17:26:49 -04:00
* @ access private
2010-05-24 15:42:43 -04:00
* @ since 3.0 . 0
2015-07-15 12:28:25 -04:00
* @ since 4.3 . 0 Also removes `header_image_data` .
2016-03-10 00:37:27 -05:00
* @ since 4.5 . 0 Also removes custom logo theme mods .
2024-05-27 12:41:10 -04:00
* @ since 6.6 . 0 Also removes `site_logo` option set by the site logo block .
2015-07-15 12:28:25 -04:00
*
2020-06-20 08:02:12 -04:00
* @ param int $id The attachment ID .
2010-05-24 15:42:43 -04:00
*/
function _delete_attachment_theme_mod ( $id ) {
$attachment_image = wp_get_attachment_url ( $id );
2015-07-15 12:28:25 -04:00
$header_image = get_header_image ();
2010-05-24 15:42:43 -04:00
$background_image = get_background_image ();
2016-03-10 00:37:27 -05:00
$custom_logo_id = get_theme_mod ( 'custom_logo' );
2024-05-27 12:41:10 -04:00
$site_logo_id = get_option ( 'site_logo' );
2016-03-10 00:37:27 -05:00
if ( $custom_logo_id && $custom_logo_id == $id ) {
remove_theme_mod ( 'custom_logo' );
remove_theme_mod ( 'header_text' );
}
2010-05-25 22:42:15 -04:00
2024-05-27 12:41:10 -04:00
if ( $site_logo_id && $site_logo_id == $id ) {
delete_option ( 'site_logo' );
}
2015-07-15 12:28:25 -04:00
if ( $header_image && $header_image == $attachment_image ) {
2010-05-24 15:42:43 -04:00
remove_theme_mod ( 'header_image' );
2015-07-15 12:28:25 -04:00
remove_theme_mod ( 'header_image_data' );
}
2010-05-24 15:42:43 -04:00
2015-07-15 12:28:25 -04:00
if ( $background_image && $background_image == $attachment_image ) {
2010-05-24 15:42:43 -04:00
remove_theme_mod ( 'background_image' );
2015-07-15 12:28:25 -04:00
}
2010-05-24 15:42:43 -04:00
}
2011-09-08 16:07:15 -04:00
/**
2016-05-23 15:02:28 -04:00
* Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load .
*
* See { @ see 'after_switch_theme' } .
2011-09-08 16:07:15 -04:00
*
2012-01-04 14:03:33 -05:00
* @ since 3.3 . 0
2011-09-08 16:59:41 -04:00
*/
2011-09-08 16:07:15 -04:00
function check_theme_switched () {
2019-07-02 19:42:58 -04:00
$stylesheet = get_option ( 'theme_switched' );
2021-12-09 10:13:04 -05:00
2019-07-02 19:42:58 -04:00
if ( $stylesheet ) {
2012-03-08 16:22:24 -05:00
$old_theme = wp_get_theme ( $stylesheet );
2012-03-30 11:13:12 -04:00
2020-01-28 19:45:18 -05:00
// Prevent widget & menu mapping from running since Customizer already called it up front.
2014-04-14 18:46:16 -04:00
if ( get_option ( 'theme_switched_via_customizer' ) ) {
2017-10-24 14:35:48 -04:00
remove_action ( 'after_switch_theme' , '_wp_menus_changed' );
2014-04-14 18:46:16 -04:00
remove_action ( 'after_switch_theme' , '_wp_sidebars_changed' );
update_option ( 'theme_switched_via_customizer' , false );
}
2013-12-01 12:24:11 -05:00
if ( $old_theme -> exists () ) {
/**
2023-04-27 19:15:17 -04:00
* Fires on the next WP load after the theme has been switched .
2013-12-01 12:24:11 -05:00
*
2023-04-27 19:15:17 -04:00
* The parameters differ according to whether the old theme exists or not .
* If the old theme is missing , the old name will instead be the slug
2013-12-01 12:24:11 -05:00
* of the old theme .
*
2023-04-27 19:15:17 -04:00
* See { @ see 'switch_theme' } .
*
2013-12-01 12:24:11 -05:00
* @ 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 */
2017-08-03 11:43:43 -04:00
do_action ( 'after_switch_theme' , $stylesheet , $old_theme );
2013-12-01 12:24:11 -05:00
}
2021-12-09 10:13:04 -05:00
2015-09-10 19:50:24 -04:00
flush_rewrite_rules ();
2012-03-30 11:13:12 -04:00
2011-09-08 16:07:15 -04:00
update_option ( 'theme_switched' , false );
}
}
2012-02-24 23:12:43 -05:00
2012-04-09 22:25:03 -04:00
/**
2012-05-23 13:56:42 -04:00
* Includes and instantiates the WP_Customize_Manager class .
2012-04-09 22:25:03 -04:00
*
2015-09-25 15:36:25 -04:00
* Loads the Customizer at plugins_loaded when accessing the customize . php admin
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* page or when any request includes a wp_customize = on param or a customize_changeset
* param ( a UUID ) . This param is a signal for whether to bootstrap the Customizer when
* WordPress is loading , especially in the Customizer preview
2015-09-25 15:36:25 -04:00
* or when making Customizer Ajax requests for widgets or menus .
2012-04-09 22:25:03 -04:00
*
* @ since 3.4 . 0
2015-05-27 18:21:25 -04:00
*
* @ global WP_Customize_Manager $wp_customize
2012-04-09 22:25:03 -04:00
*/
function _wp_customize_include () {
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
2020-05-16 14:42:12 -04:00
$is_customize_admin_page = ( is_admin () && 'customize.php' === basename ( $_SERVER [ 'PHP_SELF' ] ) );
2017-11-30 18:11:00 -05:00
$should_include = (
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$is_customize_admin_page
||
2020-05-16 14:42:12 -04:00
( isset ( $_REQUEST [ 'wp_customize' ] ) && 'on' === $_REQUEST [ 'wp_customize' ] )
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
||
( ! empty ( $_GET [ 'customize_changeset_uuid' ] ) || ! empty ( $_POST [ 'customize_changeset_uuid' ] ) )
);
if ( ! $should_include ) {
2012-02-24 23:12:43 -05:00
return ;
2015-09-25 15:36:25 -04:00
}
2012-02-24 23:12:43 -05:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/*
* Note that wp_unslash () is not being used on the input vars because it is
* called before wp_magic_quotes () gets called . Besides this fact , none of
* the values should contain any characters needing slashes anyway .
*/
2021-12-09 10:13:04 -05:00
$keys = array (
'changeset_uuid' ,
'customize_changeset_uuid' ,
'customize_theme' ,
'theme' ,
'customize_messenger_channel' ,
'customize_autosaved' ,
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$input_vars = array_merge (
wp_array_slice_assoc ( $_GET , $keys ),
wp_array_slice_assoc ( $_POST , $keys )
);
2017-11-30 18:11:00 -05:00
$theme = null ;
$autosaved = null ;
2020-01-28 19:45:18 -05:00
$messenger_channel = null ;
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
* Value false indicates UUID should be determined after_setup_theme
* to either re - use existing saved changeset or else generate a new UUID if none exists .
*/
2020-01-28 19:45:18 -05:00
$changeset_uuid = false ;
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
/*
2024-04-12 13:47:13 -04:00
* Set initially to false since defaults to true for back - compat ;
Docs: Replace multiple single line comments with multi-line comments.
This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.
Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].
Props costdev, audrasjb.
See #58459.
Built from https://develop.svn.wordpress.org/trunk@56194
git-svn-id: http://core.svn.wordpress.org/trunk@55706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-10 19:11:22 -04:00
* can be overridden via the customize_changeset_branching filter .
*/
2020-01-28 19:45:18 -05:00
$branching = false ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( $is_customize_admin_page && isset ( $input_vars [ 'changeset_uuid' ] ) ) {
$changeset_uuid = sanitize_key ( $input_vars [ 'changeset_uuid' ] );
} elseif ( ! empty ( $input_vars [ 'customize_changeset_uuid' ] ) ) {
$changeset_uuid = sanitize_key ( $input_vars [ 'customize_changeset_uuid' ] );
}
// Note that theme will be sanitized via WP_Theme.
if ( $is_customize_admin_page && isset ( $input_vars [ 'theme' ] ) ) {
$theme = $input_vars [ 'theme' ];
} elseif ( isset ( $input_vars [ 'customize_theme' ] ) ) {
$theme = $input_vars [ 'customize_theme' ];
}
Customize: Extend changesets to support autosave revisions with restoration notifications, and introduce a new default linear history mode for saved changesets (with a filter for opt-in to changeset branching).
* Autosaved changes made on top of `auto-draft` changesets get written on top of the `auto-draft` itself, similar to how autosaves for posts will overwrite post drafts.
* Autosaved changes made to saved changesets (e.g. `draft`, `future`) will be placed into an autosave revision for that changeset and that user.
* Opening the Customizer will now prompt the user to restore their most recent auto-draft changeset; if notification is dismissed or ignored then the auto-draft will be marked as dismissed and will not be prompted to user in a notification again.
* Customizer will no longer automatically supply the `changeset_uuid` param in the `customize.php` URL when branching changesets are not active.
* If user closes Customizer explicitly via clicking on X link, then autosave auto-draft/autosave will be dismissed so as to not be prompted again.
* If there is a changeset already saved as a `draft` or `future` (UI is forthcoming) then this changeset will now be autoloaded for the user to keep making additional changes. This is the linear model for changesets.
* To restore the previous behavior of the Customizer where each session started a new changeset, regardless of whether or not there was an existing changeset saved, there is now a `customize_changeset_branching` hook which can be filtered to return `true`.
* `wp.customize.requestChangesetUpdate()` now supports a second with options including `autosave`, `title`, and `date`.
* The window `blur` event for `customize.php` has been replaced with a `visibilitychange` event to reduce autosave requests when clicking into preview window.
* Adds `autosaved` and `branching` args to `WP_Customize_Manager`.
* The `changeset_uuid` param for `WP_Customize_Manager` is extended to recognize a `false` value which causes the Customizer to defer identifying the UUID until `after_setup_theme` in the new `WP_Customize_Manager::establish_loaded_changeset()` method.
* A new `customize_autosaved` query parameter can now be supplied which is passed into the `autosaved` arg in `WP_Customize_Manager`; this option is an opt-in to source data from the autosave revision, allowing a user to restore autosaved changes.
Props westonruter, dlh, sayedwp, JoshuaWold, melchoyce.
See #39896.
Built from https://develop.svn.wordpress.org/trunk@41597
git-svn-id: http://core.svn.wordpress.org/trunk@41430 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-09-26 03:38:45 -04:00
if ( ! empty ( $input_vars [ 'customize_autosaved' ] ) ) {
$autosaved = true ;
}
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
if ( isset ( $input_vars [ 'customize_messenger_channel' ] ) ) {
$messenger_channel = sanitize_key ( $input_vars [ 'customize_messenger_channel' ] );
}
2017-08-02 01:35:41 -04:00
/*
* Note that settings must be previewed even outside the customizer preview
* and also in the customizer pane itself . This is to enable loading an existing
* changeset into the customizer . Previewing the settings only has to be prevented
* here in the case of a customize_save action because this will cause WP to think
* there is nothing changed that needs to be saved .
*/
$is_customize_save_action = (
wp_doing_ajax ()
&&
isset ( $_REQUEST [ 'action' ] )
&&
'customize_save' === wp_unslash ( $_REQUEST [ 'action' ] )
);
2017-11-30 18:11:00 -05:00
$settings_previewed = ! $is_customize_save_action ;
2017-08-02 01:35:41 -04:00
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php' ;
2021-12-09 10:13:04 -05:00
$GLOBALS [ 'wp_customize' ] = new WP_Customize_Manager (
compact (
'changeset_uuid' ,
'theme' ,
'messenger_channel' ,
'settings_previewed' ,
'autosaved' ,
2021-12-09 10:32:01 -05:00
'branching'
2021-12-09 10:13:04 -05:00
)
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
/**
2017-07-30 11:34:42 -04:00
* Publishes a snapshot ' s changes .
*
* @ since 4.7 . 0
* @ access private
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*
2017-07-30 11:31:42 -04:00
* @ global WP_Customize_Manager $wp_customize Customizer instance .
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ param string $new_status New post status .
* @ param string $old_status Old post status .
* @ param WP_Post $changeset_post Changeset post object .
*/
function _wp_customize_publish_changeset ( $new_status , $old_status , $changeset_post ) {
2023-12-23 09:43:22 -05:00
global $wp_customize ;
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
$is_publishing_changeset = (
'customize_changeset' === $changeset_post -> post_type
&&
'publish' === $new_status
&&
'publish' !== $old_status
);
if ( ! $is_publishing_changeset ) {
return ;
}
if ( empty ( $wp_customize ) ) {
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php' ;
2017-11-30 18:11:00 -05:00
$wp_customize = new WP_Customize_Manager (
array (
'changeset_uuid' => $changeset_post -> post_name ,
'settings_previewed' => false ,
)
);
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
if ( ! did_action ( 'customize_register' ) ) {
/*
* When running from CLI or Cron , the customize_register action will need
* to be triggered in order for core , themes , and plugins to register their
* settings . Normally core will add_action ( 'customize_register' ) at
* priority 10 to register the core settings , and if any themes / plugins
* also add_action ( 'customize_register' ) at the same priority , they
* will have a $wp_customize with those settings registered since they
* call add_action () afterward , normally . However , when manually doing
* the customize_register action after the setup_theme , then the order
* will be reversed for two actions added at priority 10 , resulting in
* the core settings no longer being available as expected to themes / plugins .
* So the following manually calls the method that registers the core
* settings up front before doing the action .
*/
remove_action ( 'customize_register' , array ( $wp_customize , 'register_controls' ) );
$wp_customize -> register_controls ();
Docs: Update various DocBlocks and inline comments per the documentation standards.
Includes minor formatting edits for consistency.
Follow-up to [53/tests], [12179], [12946], [35288], [37884], [38810], [38928], [46596], [48131], [52955], [53548], [53813], [53873], [54118], [54316], [54420], [54421], [54803].
See #56792.
Built from https://develop.svn.wordpress.org/trunk@54855
git-svn-id: http://core.svn.wordpress.org/trunk@54407 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-11-17 13:15:19 -05:00
/** This filter is documented in wp-includes/class-wp-customize-manager.php */
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
do_action ( 'customize_register' , $wp_customize );
}
2017-11-30 18:11:00 -05:00
$wp_customize -> _publish_changeset_values ( $changeset_post -> ID );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
/*
* Trash the changeset post if revisions are not enabled . Unpublished
* changesets by default get garbage collected due to the auto - draft status .
* When a changeset post is published , however , it would no longer get cleaned
2019-03-13 15:32:53 -04:00
* out . This is a problem when the changeset posts are never displayed anywhere ,
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* since they would just be endlessly piling up . So here we use the revisions
* feature to indicate whether or not a published changeset should get trashed
* and thus garbage collected .
*/
if ( ! wp_revisions_enabled ( $changeset_post ) ) {
2017-10-11 01:42:49 -04:00
$wp_customize -> trash_changeset_post ( $changeset_post -> ID );
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
}
}
/**
* Filters changeset post data upon insert to ensure post_name is intact .
*
* This is needed to prevent the post_name from being dropped when the post is
* transitioned into pending status by a contributor .
*
* @ since 4.7 . 0
2020-06-16 17:07:14 -04:00
*
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
* @ see wp_insert_post ()
*
* @ param array $post_data An array of slashed post data .
* @ param array $supplied_post_data An array of sanitized , but otherwise unmodified post data .
2019-12-06 17:23:04 -05:00
* @ return array Filtered data .
Customize: Implement customized state persistence with changesets.
Includes infrastructure developed in the Customize Snapshots feature plugin.
See https://make.wordpress.org/core/2016/10/12/customize-changesets-technical-design-decisions/
Props westonruter, valendesigns, utkarshpatel, stubgo, lgedeon, ocean90, ryankienstra, mihai2u, dlh, aaroncampbell, jonathanbardo, jorbin.
See #28721.
See #31089.
Fixes #30937.
Fixes #31517.
Fixes #30028.
Fixes #23225.
Fixes #34142.
Fixes #36485.
Built from https://develop.svn.wordpress.org/trunk@38810
git-svn-id: http://core.svn.wordpress.org/trunk@38753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-18 16:05:31 -04:00
*/
function _wp_customize_changeset_filter_insert_post_data ( $post_data , $supplied_post_data ) {
if ( isset ( $post_data [ 'post_type' ] ) && 'customize_changeset' === $post_data [ 'post_type' ] ) {
// Prevent post_name from being dropped, such as when contributor saves a changeset post as pending.
if ( empty ( $post_data [ 'post_name' ] ) && ! empty ( $supplied_post_data [ 'post_name' ] ) ) {
$post_data [ 'post_name' ] = $supplied_post_data [ 'post_name' ];
}
}
return $post_data ;
2012-02-24 23:12:43 -05:00
}
2012-04-09 22:25:03 -04:00
/**
2012-05-24 17:13:21 -04:00
* Adds settings for the customize - loader script .
2012-04-09 22:25:03 -04:00
*
* @ since 3.4 . 0
*/
2012-05-24 17:13:21 -04:00
function _wp_customize_loader_settings () {
$admin_origin = parse_url ( admin_url () );
$home_origin = parse_url ( home_url () );
Coding Standards: Use strict comparison where `strtolower()` is involved.
Follow-up to [649], [7736], [18821], [19444], [20886], [20893], [23303], [55642], [55652], [55653], [55654].
Props aristath, poena, afercia, SergeyBiryukov.
See #57839.
Built from https://develop.svn.wordpress.org/trunk@55677
git-svn-id: http://core.svn.wordpress.org/trunk@55189 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-04-22 11:19:22 -04:00
$cross_domain = ( strtolower ( $admin_origin [ 'host' ] ) !== strtolower ( $home_origin [ 'host' ] ) );
2012-05-24 17:13:21 -04:00
2012-06-06 17:45:17 -04:00
$browser = array (
'mobile' => wp_is_mobile (),
'ios' => wp_is_mobile () && preg_match ( '/iPad|iPod|iPhone/' , $_SERVER [ 'HTTP_USER_AGENT' ] ),
);
2012-05-24 17:13:21 -04:00
$settings = array (
2012-05-24 18:45:27 -04:00
'url' => esc_url ( admin_url ( 'customize.php' ) ),
2012-05-24 17:13:21 -04:00
'isCrossDomain' => $cross_domain ,
2012-06-06 17:45:17 -04:00
'browser' => $browser ,
2014-07-08 13:04:15 -04:00
'l10n' => array (
2015-03-10 17:20:26 -04:00
'saveAlert' => __ ( 'The changes you made will be lost if you navigate away from this page.' ),
'mainIframeTitle' => __ ( 'Customizer' ),
2014-07-08 13:04:15 -04:00
),
2012-05-24 17:13:21 -04:00
);
2014-10-28 14:35:19 -04:00
$script = 'var _wpCustomizeLoaderSettings = ' . wp_json_encode ( $settings ) . ';' ;
2012-05-24 17:13:21 -04:00
2015-05-27 18:21:25 -04:00
$wp_scripts = wp_scripts ();
2017-11-30 18:11:00 -05:00
$data = $wp_scripts -> get_data ( 'customize-loader' , 'data' );
if ( $data ) {
2012-05-24 17:13:21 -04:00
$script = " $data\n $script " ;
2017-11-30 18:11:00 -05:00
}
2012-05-24 17:13:21 -04:00
$wp_scripts -> add_data ( 'customize-loader' , 'data' , $script );
2012-04-09 22:25:03 -04:00
}
/**
2014-10-15 13:21:19 -04:00
* Returns a URL to load the Customizer .
2012-04-09 22:25:03 -04:00
*
* @ since 3.4 . 0
2012-05-26 11:32:05 -04:00
*
2022-01-20 18:53:05 -05:00
* @ param string $stylesheet Optional . Theme to customize . Defaults to active theme .
2017-11-30 18:11:00 -05:00
* The theme ' s stylesheet will be urlencoded if necessary .
2015-05-27 18:21:25 -04:00
* @ return string
2012-04-09 22:25:03 -04:00
*/
2019-10-04 19:20:58 -04:00
function wp_customize_url ( $stylesheet = '' ) {
2012-05-26 11:32:05 -04:00
$url = admin_url ( 'customize.php' );
2017-11-30 18:11:00 -05:00
if ( $stylesheet ) {
2012-09-03 19:58:30 -04:00
$url .= '?theme=' . urlencode ( $stylesheet );
2017-11-30 18:11:00 -05:00
}
2012-05-26 11:32:05 -04:00
return esc_url ( $url );
2012-05-24 17:13:21 -04:00
}
2012-05-24 20:15:12 -04:00
/**
2014-10-15 13:21:19 -04:00
* Prints a script to check whether or not the Customizer is supported ,
2012-05-24 20:15:12 -04:00
* and apply either the no - customize - support or customize - support class
* to the body .
*
* This function MUST be called inside the body tag .
*
* Ideally , call this function immediately after the body tag is opened .
* This prevents a flash of unstyled content .
*
* It is also recommended that you add the " no-customize-support " class
* to the body tag by default .
*
* @ since 3.4 . 0
2016-09-25 00:35:32 -04:00
* @ since 4.7 . 0 Support for IE8 and below is explicitly removed via conditional comments .
Administration: Remove any CSS related to Internet Explorer versions 6 – 10.
In WordPress 3.2 support for IE6 was dropped, IE7 followed a few versions later. With the 4.8 release, WordPress officially ended support for Internet Explorer versions 8, 9, and 10. Yet, we still have shipped CSS for the unsupported IE versions....until now! Goodbye to ie.css and star hacks!
* Removes ie.css and `ie` style handle.
* Removes IE specific class names and any related CSS.
* Drops support for IE8 and older in `wp_customize_support_script()`.
* Updates compatibility mode for CSS minification to `ie11`.
Props ayeshrajans, isabel_brison, afercia, netweb, peterwilsoncc, ocean90.
Fixes #17232, #46015.
Built from https://develop.svn.wordpress.org/trunk@47771
git-svn-id: http://core.svn.wordpress.org/trunk@47547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-05-06 16:15:07 -04:00
* @ since 5.5 . 0 IE8 and older are no longer supported .
2012-05-24 20:15:12 -04:00
*/
function wp_customize_support_script () {
$admin_origin = parse_url ( admin_url () );
$home_origin = parse_url ( home_url () );
Coding Standards: Use strict comparison where `strtolower()` is involved.
Follow-up to [649], [7736], [18821], [19444], [20886], [20893], [23303], [55642], [55652], [55653], [55654].
Props aristath, poena, afercia, SergeyBiryukov.
See #57839.
Built from https://develop.svn.wordpress.org/trunk@55677
git-svn-id: http://core.svn.wordpress.org/trunk@55189 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-04-22 11:19:22 -04:00
$cross_domain = ( strtolower ( $admin_origin [ 'host' ] ) !== strtolower ( $home_origin [ 'host' ] ) );
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
ob_start ();
2012-05-24 20:15:12 -04:00
?>
Script Loader: Use `wp_get_script_tag()` and `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()` helper functions to output scripts on the frontend and login screen.
Using script tag helper functions allows plugins to employ the `wp_script_attributes` and `wp_inline_script_attributes` filters to inject the `nonce` attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in `WP_Scripts`.
* Update `wp_get_inline_script_tag()` to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
* Ensure the `type` attribute is printed first in `wp_get_inline_script_tag()` for back-compat.
* Wrap existing `<script>` tags in output buffering to retain IDE supports.
* In `wp_get_inline_script_tag()`, append the newline to `$javascript` before it is passed into the `wp_inline_script_attributes` filter so that the CSP hash can be computed properly.
* In `the_block_template_skip_link()`, opt to enqueue the inline script rather than print it.
* Add `ext-php` to `composer.json` under `suggest` as previously it was an undeclared dependency for running PHPUnit tests.
* Update tests to rely on `DOMDocument` to compare script markup, normalizing unsemantic differences.
Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.
Built from https://develop.svn.wordpress.org/trunk@56687
git-svn-id: http://core.svn.wordpress.org/trunk@56199 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-09-25 17:05:21 -04:00
< script >
Administration: Remove any CSS related to Internet Explorer versions 6 – 10.
In WordPress 3.2 support for IE6 was dropped, IE7 followed a few versions later. With the 4.8 release, WordPress officially ended support for Internet Explorer versions 8, 9, and 10. Yet, we still have shipped CSS for the unsupported IE versions....until now! Goodbye to ie.css and star hacks!
* Removes ie.css and `ie` style handle.
* Removes IE specific class names and any related CSS.
* Drops support for IE8 and older in `wp_customize_support_script()`.
* Updates compatibility mode for CSS minification to `ie11`.
Props ayeshrajans, isabel_brison, afercia, netweb, peterwilsoncc, ocean90.
Fixes #17232, #46015.
Built from https://develop.svn.wordpress.org/trunk@47771
git-svn-id: http://core.svn.wordpress.org/trunk@47547 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-05-06 16:15:07 -04:00
( function () {
var request , b = document . body , c = 'className' , cs = 'customize-support' , rcs = new RegExp ( '(^|\\s+)(no-)?' + cs + '(\\s+|$)' );
< ? php if ( $cross_domain ) : ?>
request = ( function (){ var xhr = new XMLHttpRequest (); return ( 'withCredentials' in xhr ); })();
< ? php else : ?>
request = true ;
< ? php endif ; ?>
b [ c ] = b [ c ] . replace ( rcs , ' ' );
// The customizer requires postMessage and CORS (if the site is cross domain).
b [ c ] += ( window . postMessage && request ? ' ' : ' no-' ) + cs ;
}());
</ script >
2012-05-24 20:15:12 -04:00
< ? php
2023-09-29 15:47:21 -04:00
wp_print_inline_script_tag ( wp_remove_surrounding_empty_script_tags ( ob_get_clean () ) );
2014-04-14 18:46:16 -04:00
}
2014-07-04 12:17:15 -04:00
/**
* Whether the site is being previewed in the Customizer .
*
* @ since 4.0 . 0
*
2014-07-13 21:02:15 -04:00
* @ global WP_Customize_Manager $wp_customize Customizer instance .
*
2014-07-04 12:17:15 -04:00
* @ return bool True if the site is being previewed in the Customizer , false otherwise .
*/
function is_customize_preview () {
global $wp_customize ;
2015-01-15 20:06:24 -05:00
return ( $wp_customize instanceof WP_Customize_Manager ) && $wp_customize -> is_preview ();
2014-07-04 12:17:15 -04:00
}
2017-05-16 01:37:44 -04:00
/**
2021-12-09 10:13:04 -05:00
* Makes sure that auto - draft posts get their post_date bumped or status changed
* to draft to prevent premature garbage - collection .
2017-05-16 01:37:44 -04:00
*
* When a changeset is updated but remains an auto - draft , ensure the post_date
* for the auto - draft posts remains the same so that it will be
* garbage - collected at the same time by `wp_delete_auto_drafts()` . Otherwise ,
* if the changeset is updated to be a draft then update the posts
* to have a far - future post_date so that they will never be garbage collected
* unless the changeset post itself is deleted .
*
2017-10-17 16:15:52 -04:00
* When a changeset is updated to be a persistent draft or to be scheduled for
* publishing , then transition any dependent auto - drafts to a draft status so
* that they likewise will not be garbage - collected but also so that they can
* be edited in the admin before publishing since there is not yet a post / page
* editing flow in the Customizer . See #39752.
*
* @ link https :// core . trac . wordpress . org / ticket / 39752
*
2017-05-16 01:37:44 -04:00
* @ since 4.8 . 0
* @ access private
* @ see wp_delete_auto_drafts ()
*
2019-08-03 21:12:56 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
*
2017-05-16 01:37:44 -04:00
* @ param string $new_status Transition to this post status .
* @ param string $old_status Previous post status .
* @ param \WP_Post $post Post data .
*/
function _wp_keep_alive_customize_changeset_dependent_auto_drafts ( $new_status , $old_status , $post ) {
global $wpdb ;
unset ( $old_status );
// Short-circuit if not a changeset or if the changeset was published.
if ( 'customize_changeset' !== $post -> post_type || 'publish' === $new_status ) {
return ;
}
2017-10-17 16:15:52 -04:00
$data = json_decode ( $post -> post_content , true );
if ( empty ( $data [ 'nav_menus_created_posts' ][ 'value' ] ) ) {
return ;
}
/*
* Actually , in lieu of keeping alive , trash any customization drafts here if the changeset itself is
* getting trashed . This is needed because when a changeset transitions to a draft , then any of the
* dependent auto - draft post / page stubs will also get transitioned to customization drafts which
* are then visible in the WP Admin . We cannot wait for the deletion of the changeset in which
* _wp_delete_customize_changeset_dependent_auto_drafts () will be called , since they need to be
* trashed to remove from visibility immediately .
*/
if ( 'trash' === $new_status ) {
foreach ( $data [ 'nav_menus_created_posts' ][ 'value' ] as $post_id ) {
if ( ! empty ( $post_id ) && 'draft' === get_post_status ( $post_id ) ) {
wp_trash_post ( $post_id );
}
}
return ;
}
$post_args = array ();
2017-05-16 01:37:44 -04:00
if ( 'auto-draft' === $new_status ) {
/*
* Keep the post date for the post matching the changeset
* so that it will not be garbage - collected before the changeset .
*/
2017-10-17 16:15:52 -04:00
$post_args [ 'post_date' ] = $post -> post_date ; // Note wp_delete_auto_drafts() only looks at this date.
2017-05-16 01:37:44 -04:00
} else {
/*
* Since the changeset no longer has an auto - draft ( and it is not published )
* it is now a persistent changeset , a long - lived draft , and so any
2017-10-17 16:15:52 -04:00
* associated auto - draft posts should likewise transition into having a draft
* status . These drafts will be treated differently than regular drafts in
2019-04-17 09:26:51 -04:00
* that they will be tied to the given changeset . The publish meta box is
2017-10-17 16:15:52 -04:00
* replaced with a notice about how the post is part of a set of customized changes
* which will be published when the changeset is published .
2017-05-16 01:37:44 -04:00
*/
2017-10-17 16:15:52 -04:00
$post_args [ 'post_status' ] = 'draft' ;
2017-05-16 01:37:44 -04:00
}
foreach ( $data [ 'nav_menus_created_posts' ][ 'value' ] as $post_id ) {
if ( empty ( $post_id ) || 'auto-draft' !== get_post_status ( $post_id ) ) {
continue ;
}
$wpdb -> update (
$wpdb -> posts ,
2017-10-17 16:15:52 -04:00
$post_args ,
2017-05-16 01:37:44 -04:00
array ( 'ID' => $post_id )
);
clean_post_cache ( $post_id );
}
}
2020-06-25 18:13:10 -04:00
/**
* Creates the initial theme features when the 'setup_theme' action is fired .
*
* See { @ see 'setup_theme' } .
*
* @ since 5.5 . 0
2022-07-15 12:00:10 -04:00
* @ since 6.0 . 1 The `block-templates` feature was added .
2020-06-25 18:13:10 -04:00
*/
function create_initial_theme_features () {
register_theme_feature (
'align-wide' ,
array (
'description' => __ ( 'Whether theme opts in to wide alignment CSS class.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'automatic-feed-links' ,
array (
'description' => __ ( 'Whether posts and comments RSS feed links are added to head.' ),
'show_in_rest' => true ,
)
);
2022-07-05 10:59:16 -04:00
register_theme_feature (
'block-templates' ,
array (
'description' => __ ( 'Whether a theme uses block-based templates.' ),
'show_in_rest' => true ,
)
);
2022-09-15 08:20:09 -04:00
register_theme_feature (
'block-template-parts' ,
array (
'description' => __ ( 'Whether a theme uses block-based template parts.' ),
'show_in_rest' => true ,
)
);
2020-06-25 18:13:10 -04:00
register_theme_feature (
'custom-background' ,
array (
'description' => __ ( 'Custom background if defined by the theme.' ),
'type' => 'object' ,
'show_in_rest' => array (
'schema' => array (
'properties' => array (
'default-image' => array (
'type' => 'string' ,
'format' => 'uri' ,
),
'default-preset' => array (
'type' => 'string' ,
'enum' => array (
'default' ,
'fill' ,
'fit' ,
'repeat' ,
'custom' ,
),
),
'default-position-x' => array (
'type' => 'string' ,
'enum' => array (
'left' ,
'center' ,
'right' ,
),
),
'default-position-y' => array (
'type' => 'string' ,
'enum' => array (
'left' ,
'center' ,
'right' ,
),
),
'default-size' => array (
'type' => 'string' ,
'enum' => array (
'auto' ,
'contain' ,
'cover' ,
),
),
'default-repeat' => array (
'type' => 'string' ,
'enum' => array (
'repeat-x' ,
'repeat-y' ,
'repeat' ,
'no-repeat' ,
),
),
'default-attachment' => array (
'type' => 'string' ,
'enum' => array (
'scroll' ,
'fixed' ,
),
),
'default-color' => array (
'type' => 'string' ,
),
),
),
),
)
);
register_theme_feature (
'custom-header' ,
array (
'description' => __ ( 'Custom header if defined by the theme.' ),
'type' => 'object' ,
'show_in_rest' => array (
'schema' => array (
'properties' => array (
'default-image' => array (
'type' => 'string' ,
'format' => 'uri' ,
),
'random-default' => array (
'type' => 'boolean' ,
),
'width' => array (
'type' => 'integer' ,
),
'height' => array (
'type' => 'integer' ,
),
'flex-height' => array (
'type' => 'boolean' ,
),
'flex-width' => array (
'type' => 'boolean' ,
),
'default-text-color' => array (
'type' => 'string' ,
),
'header-text' => array (
'type' => 'boolean' ,
),
'uploads' => array (
'type' => 'boolean' ,
),
'video' => array (
'type' => 'boolean' ,
),
),
),
),
)
);
register_theme_feature (
'custom-logo' ,
array (
'type' => 'object' ,
'description' => __ ( 'Custom logo if defined by the theme.' ),
'show_in_rest' => array (
'schema' => array (
'properties' => array (
2020-08-07 15:43:05 -04:00
'width' => array (
2020-06-25 18:13:10 -04:00
'type' => 'integer' ,
),
2020-08-07 15:43:05 -04:00
'height' => array (
2020-06-25 18:13:10 -04:00
'type' => 'integer' ,
),
2020-08-07 15:43:05 -04:00
'flex-width' => array (
2020-06-25 18:13:10 -04:00
'type' => 'boolean' ,
),
2020-08-07 15:43:05 -04:00
'flex-height' => array (
2020-06-25 18:13:10 -04:00
'type' => 'boolean' ,
),
2020-08-07 15:43:05 -04:00
'header-text' => array (
2020-06-25 18:13:10 -04:00
'type' => 'array' ,
'items' => array (
'type' => 'string' ,
),
),
2020-08-07 15:43:05 -04:00
'unlink-homepage-logo' => array (
'type' => 'boolean' ,
),
2020-06-25 18:13:10 -04:00
),
),
),
)
);
register_theme_feature (
'customize-selective-refresh-widgets' ,
array (
'description' => __ ( 'Whether the theme enables Selective Refresh for Widgets being managed with the Customizer.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'dark-editor-style' ,
array (
'description' => __ ( 'Whether theme opts in to the dark editor style UI.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'disable-custom-colors' ,
array (
'description' => __ ( 'Whether the theme disables custom colors.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'disable-custom-font-sizes' ,
array (
'description' => __ ( 'Whether the theme disables custom font sizes.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'disable-custom-gradients' ,
array (
'description' => __ ( 'Whether the theme disables custom gradients.' ),
'show_in_rest' => true ,
)
);
Editor: Backport foundation for Layout block support refactor (part 1).
Backports the following changes from the Gutenberg repository:
* [WordPress/gutenberg/40875 gutenberg/40875] Layout: Use semantic classnames, centralize layout definitions, reduce duplication, and fix blockGap in theme.json
* [WordPress/gutenberg/42544 gutenberg/42544] Layout: Add a disable-layout-styles theme supports flag to opt out of all layout styles gutenberg/42544
* [WordPress/gutenberg/42087 gutenberg/42087] Theme.json: Add block support feature level selectors for blocks gutenberg/42087
* [WordPress/gutenberg/43792 gutenberg/43792] Global Styles: Split root layout rules into a different function gutenberg/43792
* [WordPress/gutenberg/42544 gutenberg/42544] Layout: Add a disable-layout-styles theme supports flag to opt out of all layout styles gutenberg/42544
* [WordPress/gutenberg/42665 gutenberg/42665] Layout: Reduce specificity of fallback blockGap styles gutenberg/42665
* [WordPress/gutenberg/42085 gutenberg/42085] Core CSS support for root padding and alignfull blocks gutenberg/42085
Notes:
* It doesn't entirely port over PR 40875 — the remaining PHP changes for that PR will be explored in a separate PR targeting `layout.php`.
* [54159] was reverted in [54160] due to PHPUnit test failures for tests added by the commit. Later, tests passed when applied on top of `trunk`. There were various outages today of upstream `wp-env` dependencies, which likely were the root cause of the earlier failures. For historical tracking and to make sure, recommitting [54159] but instead on top of current `trunk`. See PR 3205 for more details.
* Giving additional props for those who did a deep dive investigation into the failed tests.
Follow-up to [54160], [54159].
Props andrewserong, aaronrobertshaw, isabel_brison, bernhard-reiter, hellofromTonya.
See #56467.
Built from https://develop.svn.wordpress.org/trunk@54162
git-svn-id: http://core.svn.wordpress.org/trunk@53721 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-14 14:44:09 -04:00
register_theme_feature (
'disable-layout-styles' ,
array (
'description' => __ ( 'Whether the theme disables generated layout styles.' ),
'show_in_rest' => true ,
)
);
2020-06-25 18:13:10 -04:00
register_theme_feature (
'editor-color-palette' ,
array (
'type' => 'array' ,
'description' => __ ( 'Custom color palette if defined by the theme.' ),
'show_in_rest' => array (
'schema' => array (
'items' => array (
'type' => 'object' ,
'properties' => array (
'name' => array (
'type' => 'string' ,
),
'slug' => array (
'type' => 'string' ,
),
'color' => array (
'type' => 'string' ,
),
),
),
),
),
)
);
register_theme_feature (
'editor-font-sizes' ,
array (
'type' => 'array' ,
'description' => __ ( 'Custom font sizes if defined by the theme.' ),
'show_in_rest' => array (
'schema' => array (
'items' => array (
'type' => 'object' ,
'properties' => array (
'name' => array (
'type' => 'string' ,
),
'size' => array (
'type' => 'number' ,
),
'slug' => array (
'type' => 'string' ,
),
),
),
),
),
)
);
register_theme_feature (
'editor-gradient-presets' ,
array (
'type' => 'array' ,
'description' => __ ( 'Custom gradient presets if defined by the theme.' ),
'show_in_rest' => array (
'schema' => array (
'items' => array (
'type' => 'object' ,
'properties' => array (
'name' => array (
'type' => 'string' ,
),
'gradient' => array (
'type' => 'string' ,
),
'slug' => array (
'type' => 'string' ,
),
),
),
),
),
)
);
register_theme_feature (
'editor-styles' ,
array (
'description' => __ ( 'Whether theme opts in to the editor styles CSS wrapper.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'html5' ,
array (
'type' => 'array' ,
'description' => __ ( 'Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.' ),
'show_in_rest' => array (
'schema' => array (
'items' => array (
'type' => 'string' ,
'enum' => array (
'search-form' ,
'comment-form' ,
'comment-list' ,
'gallery' ,
'caption' ,
'script' ,
'style' ,
),
),
),
),
)
);
register_theme_feature (
'post-formats' ,
array (
'type' => 'array' ,
'description' => __ ( 'Post formats supported.' ),
'show_in_rest' => array (
'name' => 'formats' ,
'schema' => array (
'items' => array (
'type' => 'string' ,
'enum' => get_post_format_slugs (),
),
'default' => array ( 'standard' ),
),
'prepare_callback' => static function ( $formats ) {
$formats = is_array ( $formats ) ? array_values ( $formats [ 0 ] ) : array ();
$formats = array_merge ( array ( 'standard' ), $formats );
return $formats ;
},
),
)
);
register_theme_feature (
'post-thumbnails' ,
array (
'type' => 'array' ,
'description' => __ ( 'The post types that support thumbnails or true if all post types are supported.' ),
'show_in_rest' => array (
'type' => array ( 'boolean' , 'array' ),
'schema' => array (
'items' => array (
'type' => 'string' ,
),
),
),
)
);
register_theme_feature (
'responsive-embeds' ,
array (
'description' => __ ( 'Whether the theme supports responsive embedded content.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'title-tag' ,
array (
'description' => __ ( 'Whether the theme can manage the document title tag.' ),
'show_in_rest' => true ,
)
);
register_theme_feature (
'wp-block-styles' ,
array (
'description' => __ ( 'Whether theme opts in to default WordPress block styles for viewing.' ),
'show_in_rest' => true ,
)
);
}
2021-11-08 21:17:17 -05:00
/**
2022-01-20 18:53:05 -05:00
* Returns whether the active theme is a block - based theme or not .
2021-11-08 21:17:17 -05:00
*
* @ since 5.9 . 0
*
2023-08-18 13:29:20 -04:00
* @ return bool Whether the active theme is a block - based theme or not .
2021-11-08 21:17:17 -05:00
*/
2021-12-06 19:02:02 -05:00
function wp_is_block_theme () {
return wp_get_theme () -> is_block_theme ();
2021-11-08 21:17:17 -05:00
}
2021-12-14 04:49:00 -05:00
2022-09-15 06:55:08 -04:00
/**
* Given an element name , returns a class name .
*
* Alias of WP_Theme_JSON :: get_element_class_name .
*
* @ since 6.1 . 0
*
* @ param string $element The name of the element .
*
* @ return string The name of the class .
*/
function wp_theme_get_element_class_name ( $element ) {
return WP_Theme_JSON :: get_element_class_name ( $element );
}
2021-12-14 04:49:00 -05:00
/**
Themes: Fix block theme supports being added too early, leading to Customizer live preview bugs in 6.4.
The Customizer live preview broke because of [56635], however the root cause for the bug was a lower-level problem that had been present since WordPress 5.8: The block theme specific functions `_add_default_theme_supports()` and `wp_enable_block_templates()` were being hooked into the `setup_theme` action, which fires too early to initialize theme features. Because of that, theme functionality would be initialized before the current theme setup being completed. In the case of the Customizer, that includes overriding which theme is the current theme entirely, thus leading to an inconsistent experience.
This changeset fixes the bug by moving those two callbacks to the `after_setup_theme` action, which is the appropriate action to initialize theme features.
Props karl94, hellofromTonya, joemcgill, flixos90.
Fixes #59732.
See #18298, #53397, #54597.
Built from https://develop.svn.wordpress.org/trunk@57009
git-svn-id: http://core.svn.wordpress.org/trunk@56520 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-26 14:44:26 -04:00
* Adds default theme supports for block themes when the 'after_setup_theme' action fires .
2021-12-14 04:49:00 -05:00
*
Themes: Fix block theme supports being added too early, leading to Customizer live preview bugs in 6.4.
The Customizer live preview broke because of [56635], however the root cause for the bug was a lower-level problem that had been present since WordPress 5.8: The block theme specific functions `_add_default_theme_supports()` and `wp_enable_block_templates()` were being hooked into the `setup_theme` action, which fires too early to initialize theme features. Because of that, theme functionality would be initialized before the current theme setup being completed. In the case of the Customizer, that includes overriding which theme is the current theme entirely, thus leading to an inconsistent experience.
This changeset fixes the bug by moving those two callbacks to the `after_setup_theme` action, which is the appropriate action to initialize theme features.
Props karl94, hellofromTonya, joemcgill, flixos90.
Fixes #59732.
See #18298, #53397, #54597.
Built from https://develop.svn.wordpress.org/trunk@57009
git-svn-id: http://core.svn.wordpress.org/trunk@56520 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-10-26 14:44:26 -04:00
* See { @ see 'after_setup_theme' } .
2021-12-16 09:47:04 -05:00
*
2021-12-14 04:49:00 -05:00
* @ since 5.9 . 0
* @ access private
*/
function _add_default_theme_supports () {
2021-12-16 09:47:04 -05:00
if ( ! wp_is_block_theme () ) {
return ;
2021-12-14 04:49:00 -05:00
}
2021-12-16 09:47:04 -05:00
add_theme_support ( 'post-thumbnails' );
add_theme_support ( 'responsive-embeds' );
add_theme_support ( 'editor-styles' );
Themes: Make block themes support HTML5 by default.
For block themes, [52369] added HTML5 support for `'comment-list'`, `'comment-form'`, `'style'`, and `'script'`. However, when sites upgrade to 5.9 with non-block content such as a gallery and caption, the markup was not HTML5.
This commit adds full HTML5 theme feature support for block themes. Non-block content such as a `[gallery]` and `[caption]` shortcodes will natively be in HMTL5 markup without block themes needing to specifically add `add_theme_support( 'html5, .. )` to the theme.
Follow-up to [24417], [27302], [34261], [52369], [52383], [52386].
Props @joyously, costdev, hellofromTonya, audrasjb, Mamaduka, ocean90.
Fixes #54731. See #54597.
Built from https://develop.svn.wordpress.org/trunk@52439
git-svn-id: http://core.svn.wordpress.org/trunk@52031 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-04 13:40:00 -05:00
/*
* Makes block themes support HTML5 by default for the comment block and search form
2022-01-04 13:49:00 -05:00
* ( which use default template functions ) and `[caption]` and `[gallery]` shortcodes .
Themes: Make block themes support HTML5 by default.
For block themes, [52369] added HTML5 support for `'comment-list'`, `'comment-form'`, `'style'`, and `'script'`. However, when sites upgrade to 5.9 with non-block content such as a gallery and caption, the markup was not HTML5.
This commit adds full HTML5 theme feature support for block themes. Non-block content such as a `[gallery]` and `[caption]` shortcodes will natively be in HMTL5 markup without block themes needing to specifically add `add_theme_support( 'html5, .. )` to the theme.
Follow-up to [24417], [27302], [34261], [52369], [52383], [52386].
Props @joyously, costdev, hellofromTonya, audrasjb, Mamaduka, ocean90.
Fixes #54731. See #54597.
Built from https://develop.svn.wordpress.org/trunk@52439
git-svn-id: http://core.svn.wordpress.org/trunk@52031 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-04 13:40:00 -05:00
* Other blocks contain their own HTML5 markup .
*/
add_theme_support ( 'html5' , array ( 'comment-form' , 'comment-list' , 'search-form' , 'gallery' , 'caption' , 'style' , 'script' ) );
2021-12-16 09:47:04 -05:00
add_theme_support ( 'automatic-feed-links' );
add_filter ( 'should_load_separate_core_block_assets' , '__return_true' );
2022-10-07 16:48:12 -04:00
/*
* Remove the Customizer ' s Menus panel when block theme is active .
*/
add_filter (
'customize_panel_active' ,
static function ( $active , WP_Customize_Panel $panel ) {
if (
'nav_menus' === $panel -> id &&
! current_theme_supports ( 'menus' ) &&
! current_theme_supports ( 'widgets' )
) {
$active = false ;
}
return $active ;
},
10 ,
2
);
2021-12-14 04:49:00 -05:00
}