3 * Theme, template, and stylesheet functions.
10 * Returns an array of WP_Theme objects based on the arguments.
12 * Despite advances over get_themes(), this function is quite expensive, and grows
13 * linearly with additional themes. Stick to wp_get_theme() if possible.
17 * @param array $args The search arguments. Optional.
18 * - errors mixed True to return themes with errors, false to return themes without errors, null
19 * to return all themes. Defaults to false.
20 * - allowed mixed (Multisite) True to return only allowed themes for a site. False to return only
21 * disallowed themes for a site. 'site' to return only site-allowed themes. 'network'
22 * to return only network-allowed themes. Null to return all themes. Defaults to null.
23 * - blog_id int (Multisite) The blog ID used to calculate which themes are allowed. Defaults to 0,
24 * synonymous for the current blog.
25 * @return Array of WP_Theme objects.
27 function wp_get_themes( $args = array() ) {
28 global $wp_theme_directories;
30 $defaults = array( 'errors' => false, 'allowed' => null, 'blog_id' => 0 );
31 $args = wp_parse_args( $args, $defaults );
33 $theme_directories = search_theme_directories();
35 if ( count( $wp_theme_directories ) > 1 ) {
36 // Make sure the current theme wins out, in case search_theme_directories() picks the wrong
37 // one in the case of a conflict. (Normally, last registered theme root wins.)
38 $current_theme = get_stylesheet();
39 if ( isset( $theme_directories[ $current_theme ] ) ) {
40 $root_of_current_theme = get_raw_theme_root( $current_theme );
41 if ( ! in_array( $root_of_current_theme, $wp_theme_directories ) )
42 $root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme;
43 $theme_directories[ $current_theme ]['theme_root'] = $root_of_current_theme;
47 if ( empty( $theme_directories ) )
50 if ( is_multisite() && null !== $args['allowed'] ) {
51 $allowed = $args['allowed'];
52 if ( 'network' === $allowed )
53 $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_network() );
54 elseif ( 'site' === $allowed )
55 $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_site( $args['blog_id'] ) );
57 $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
59 $theme_directories = array_diff_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
63 static $_themes = array();
65 foreach ( $theme_directories as $theme => $theme_root ) {
66 if ( isset( $_themes[ $theme_root['theme_root'] . '/' . $theme ] ) )
67 $themes[ $theme ] = $_themes[ $theme_root['theme_root'] . '/' . $theme ];
69 $themes[ $theme ] = $_themes[ $theme_root['theme_root'] . '/' . $theme ] = new WP_Theme( $theme, $theme_root['theme_root'] );
72 if ( null !== $args['errors'] ) {
73 foreach ( $themes as $theme => $wp_theme ) {
74 if ( $wp_theme->errors() != $args['errors'] )
75 unset( $themes[ $theme ] );
83 * Gets a WP_Theme object for a theme.
87 * @param string $stylesheet Directory name for the theme. Optional. Defaults to current theme.
88 * @param string $theme_root Absolute path of the theme root to look in. Optional. If not specified, get_raw_theme_root()
89 * is used to calculate the theme root for the $stylesheet provided (or current theme).
90 * @return WP_Theme Theme object. Be sure to check the object's exists() method if you need to confirm the theme's existence.
92 function wp_get_theme( $stylesheet = null, $theme_root = null ) {
93 global $wp_theme_directories;
95 if ( empty( $stylesheet ) )
96 $stylesheet = get_stylesheet();
98 if ( empty( $theme_root ) ) {
99 $theme_root = get_raw_theme_root( $stylesheet );
100 if ( false === $theme_root )
101 $theme_root = WP_CONTENT_DIR . '/themes';
102 elseif ( ! in_array( $theme_root, (array) $wp_theme_directories ) )
103 $theme_root = WP_CONTENT_DIR . $theme_root;
106 return new WP_Theme( $stylesheet, $theme_root );
110 * Clears the cache held by get_theme_roots() and WP_Theme.
113 * @param bool $clear_update_cache Whether to clear the Theme updates cache
115 function wp_clean_themes_cache( $clear_update_cache = true ) {
116 if ( $clear_update_cache )
117 delete_site_transient( 'update_themes' );
118 search_theme_directories( true );
119 foreach ( wp_get_themes( array( 'errors' => null ) ) as $theme )
120 $theme->cache_delete();
124 * Whether a child theme is in use.
128 * @return bool true if a child theme is in use, false otherwise.
130 function is_child_theme() {
131 return ( TEMPLATEPATH !== STYLESHEETPATH );
135 * Retrieve name of the current stylesheet.
137 * The theme name that the administrator has currently set the front end theme
140 * For all intents and purposes, the template name and the stylesheet name are
141 * going to be the same for most cases.
145 * @return string Stylesheet name.
147 function get_stylesheet() {
149 * Filter the name of current stylesheet.
153 * @param string $stylesheet Name of the current stylesheet.
155 return apply_filters( 'stylesheet', get_option( 'stylesheet' ) );
159 * Retrieve stylesheet directory path for current theme.
163 * @return string Path to current theme directory.
165 function get_stylesheet_directory() {
166 $stylesheet = get_stylesheet();
167 $theme_root = get_theme_root( $stylesheet );
168 $stylesheet_dir = "$theme_root/$stylesheet";
171 * Filter the stylesheet directory path for current theme.
175 * @param string $stylesheet_dir Absolute path to the current them.
176 * @param string $stylesheet Directory name of the current theme.
177 * @param string $theme_root Absolute path to themes directory.
179 return apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root );
183 * Retrieve stylesheet directory URI.
189 function get_stylesheet_directory_uri() {
190 $stylesheet = str_replace( '%2F', '/', rawurlencode( get_stylesheet() ) );
191 $theme_root_uri = get_theme_root_uri( $stylesheet );
192 $stylesheet_dir_uri = "$theme_root_uri/$stylesheet";
195 * Filter the stylesheet directory URI.
199 * @param string $stylesheet_dir_uri Stylesheet directory URI.
200 * @param string $stylesheet Name of the activated theme's directory.
201 * @param string $theme_root_uri Themes root URI.
203 return apply_filters( 'stylesheet_directory_uri', $stylesheet_dir_uri, $stylesheet, $theme_root_uri );
207 * Retrieve URI of current theme stylesheet.
209 * The stylesheet file name is 'style.css' which is appended to {@link
210 * get_stylesheet_directory_uri() stylesheet directory URI} path.
216 function get_stylesheet_uri() {
217 $stylesheet_dir_uri = get_stylesheet_directory_uri();
218 $stylesheet_uri = $stylesheet_dir_uri . '/style.css';
220 * Filter the URI of the current theme stylesheet.
224 * @param string $stylesheet_uri Stylesheet URI for the current theme/child theme.
225 * @param string $stylesheet_dir_uri Stylesheet directory URI for the current theme/child theme.
227 return apply_filters( 'stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
231 * Retrieve localized stylesheet URI.
233 * The stylesheet directory for the localized stylesheet files are located, by
234 * default, in the base theme directory. The name of the locale file will be the
235 * locale followed by '.css'. If that does not exist, then the text direction
236 * stylesheet will be checked for existence, for example 'ltr.css'.
238 * The theme may change the location of the stylesheet directory by either using
239 * the 'stylesheet_directory_uri' filter or the 'locale_stylesheet_uri' filter.
240 * If you want to change the location of the stylesheet files for the entire
241 * WordPress workflow, then change the former. If you just have the locale in a
242 * separate folder, then change the latter.
248 function get_locale_stylesheet_uri() {
250 $stylesheet_dir_uri = get_stylesheet_directory_uri();
251 $dir = get_stylesheet_directory();
252 $locale = get_locale();
253 if ( file_exists("$dir/$locale.css") )
254 $stylesheet_uri = "$stylesheet_dir_uri/$locale.css";
255 elseif ( !empty($wp_locale->text_direction) && file_exists("$dir/{$wp_locale->text_direction}.css") )
256 $stylesheet_uri = "$stylesheet_dir_uri/{$wp_locale->text_direction}.css";
258 $stylesheet_uri = '';
260 * Filter the localized stylesheet URI.
264 * @param string $stylesheet_uri Localized stylesheet URI.
265 * @param string $stylesheet_dir_uri Stylesheet directory URI.
267 return apply_filters( 'locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
271 * Retrieve name of the current theme.
274 * @uses apply_filters() Calls 'template' filter on template option.
276 * @return string Template name.
278 function get_template() {
280 * Filter the name of the current theme.
284 * @param string $template Current theme's directory name.
286 return apply_filters( 'template', get_option( 'template' ) );
290 * Retrieve current theme directory.
294 * @return string Template directory path.
296 function get_template_directory() {
297 $template = get_template();
298 $theme_root = get_theme_root( $template );
299 $template_dir = "$theme_root/$template";
302 * Filter the current theme directory path.
306 * @param string $template_dir The URI of the current theme directory.
307 * @param string $template Directory name of the current theme.
308 * @param string $theme_root Absolute path to the themes directory.
310 return apply_filters( 'template_directory', $template_dir, $template, $theme_root );
314 * Retrieve theme directory URI.
318 * @return string Template directory URI.
320 function get_template_directory_uri() {
321 $template = str_replace( '%2F', '/', rawurlencode( get_template() ) );
322 $theme_root_uri = get_theme_root_uri( $template );
323 $template_dir_uri = "$theme_root_uri/$template";
326 * Filter the current theme directory URI.
330 * @param string $template_dir_uri The URI of the current theme directory.
331 * @param string $template Directory name of the current theme.
332 * @param string $theme_root_uri The themes root URI.
334 return apply_filters( 'template_directory_uri', $template_dir_uri, $template, $theme_root_uri );
338 * Retrieve theme roots.
342 * @return array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root.
344 function get_theme_roots() {
345 global $wp_theme_directories;
347 if ( count($wp_theme_directories) <= 1 )
350 $theme_roots = get_site_transient( 'theme_roots' );
351 if ( false === $theme_roots ) {
352 search_theme_directories( true ); // Regenerate the transient.
353 $theme_roots = get_site_transient( 'theme_roots' );
359 * Register a directory that contains themes.
363 * @param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR
366 function register_theme_directory( $directory ) {
367 global $wp_theme_directories;
369 if ( ! file_exists( $directory ) ) {
370 // Try prepending as the theme directory could be relative to the content directory
371 $directory = WP_CONTENT_DIR . '/' . $directory;
372 // If this directory does not exist, return and do not register
373 if ( ! file_exists( $directory ) ) {
378 if ( ! is_array( $wp_theme_directories ) ) {
379 $wp_theme_directories = array();
382 $untrailed = untrailingslashit( $directory );
383 if ( ! empty( $untrailed ) && ! in_array( $untrailed, $wp_theme_directories ) ) {
384 $wp_theme_directories[] = $untrailed;
391 * Search all registered theme directories for complete and valid themes.
395 * @param bool $force Optional. Whether to force a new directory scan. Defaults to false.
396 * @return array Valid themes found
398 function search_theme_directories( $force = false ) {
399 global $wp_theme_directories;
400 if ( empty( $wp_theme_directories ) )
403 static $found_themes;
404 if ( ! $force && isset( $found_themes ) )
405 return $found_themes;
407 $found_themes = array();
409 $wp_theme_directories = (array) $wp_theme_directories;
411 // Set up maybe-relative, maybe-absolute array of theme directories.
412 // We always want to return absolute, but we need to cache relative
413 // to use in get_theme_root().
414 foreach ( $wp_theme_directories as $theme_root ) {
415 if ( 0 === strpos( $theme_root, WP_CONTENT_DIR ) )
416 $relative_theme_roots[ str_replace( WP_CONTENT_DIR, '', $theme_root ) ] = $theme_root;
418 $relative_theme_roots[ $theme_root ] = $theme_root;
422 * Filter whether to get the cache of the registered theme directories.
426 * @param bool $cache_expiration Whether to get the cache of the theme directories. Default false.
427 * @param string $cache_directory Directory to be searched for the cache.
429 if ( $cache_expiration = apply_filters( 'wp_cache_themes_persistently', false, 'search_theme_directories' ) ) {
430 $cached_roots = get_site_transient( 'theme_roots' );
431 if ( is_array( $cached_roots ) ) {
432 foreach ( $cached_roots as $theme_dir => $theme_root ) {
433 // A cached theme root is no longer around, so skip it.
434 if ( ! isset( $relative_theme_roots[ $theme_root ] ) )
436 $found_themes[ $theme_dir ] = array(
437 'theme_file' => $theme_dir . '/style.css',
438 'theme_root' => $relative_theme_roots[ $theme_root ], // Convert relative to absolute.
441 return $found_themes;
443 if ( ! is_int( $cache_expiration ) )
444 $cache_expiration = 1800; // half hour
446 $cache_expiration = 1800; // half hour
449 /* Loop the registered theme directories and extract all themes */
450 foreach ( $wp_theme_directories as $theme_root ) {
452 // Start with directories in the root of the current theme directory.
453 $dirs = @ scandir( $theme_root );
455 trigger_error( "$theme_root is not readable", E_USER_NOTICE );
458 foreach ( $dirs as $dir ) {
459 if ( ! is_dir( $theme_root . '/' . $dir ) || $dir[0] == '.' || $dir == 'CVS' )
461 if ( file_exists( $theme_root . '/' . $dir . '/style.css' ) ) {
462 // wp-content/themes/a-single-theme
463 // wp-content/themes is $theme_root, a-single-theme is $dir
464 $found_themes[ $dir ] = array(
465 'theme_file' => $dir . '/style.css',
466 'theme_root' => $theme_root,
469 $found_theme = false;
470 // wp-content/themes/a-folder-of-themes/*
471 // wp-content/themes is $theme_root, a-folder-of-themes is $dir, then themes are $sub_dirs
472 $sub_dirs = @ scandir( $theme_root . '/' . $dir );
474 trigger_error( "$theme_root/$dir is not readable", E_USER_NOTICE );
477 foreach ( $sub_dirs as $sub_dir ) {
478 if ( ! is_dir( $theme_root . '/' . $dir . '/' . $sub_dir ) || $dir[0] == '.' || $dir == 'CVS' )
480 if ( ! file_exists( $theme_root . '/' . $dir . '/' . $sub_dir . '/style.css' ) )
482 $found_themes[ $dir . '/' . $sub_dir ] = array(
483 'theme_file' => $dir . '/' . $sub_dir . '/style.css',
484 'theme_root' => $theme_root,
488 // Never mind the above, it's just a theme missing a style.css.
489 // Return it; WP_Theme will catch the error.
490 if ( ! $found_theme )
491 $found_themes[ $dir ] = array(
492 'theme_file' => $dir . '/style.css',
493 'theme_root' => $theme_root,
499 asort( $found_themes );
501 $theme_roots = array();
502 $relative_theme_roots = array_flip( $relative_theme_roots );
504 foreach ( $found_themes as $theme_dir => $theme_data ) {
505 $theme_roots[ $theme_dir ] = $relative_theme_roots[ $theme_data['theme_root'] ]; // Convert absolute to relative.
508 if ( $theme_roots != get_site_transient( 'theme_roots' ) )
509 set_site_transient( 'theme_roots', $theme_roots, $cache_expiration );
511 return $found_themes;
515 * Retrieve path to themes directory.
517 * Does not have trailing slash.
521 * @param string $stylesheet_or_template The stylesheet or template name of the theme
522 * @return string Theme path.
524 function get_theme_root( $stylesheet_or_template = false ) {
525 global $wp_theme_directories;
527 if ( $stylesheet_or_template && $theme_root = get_raw_theme_root( $stylesheet_or_template ) ) {
528 // Always prepend WP_CONTENT_DIR unless the root currently registered as a theme directory.
529 // This gives relative theme roots the benefit of the doubt when things go haywire.
530 if ( ! in_array( $theme_root, (array) $wp_theme_directories ) )
531 $theme_root = WP_CONTENT_DIR . $theme_root;
533 $theme_root = WP_CONTENT_DIR . '/themes';
537 * Filter the absolute path to the themes directory.
541 * @param string $theme_root Absolute path to themes directory.
543 return apply_filters( 'theme_root', $theme_root );
547 * Retrieve URI for themes directory.
549 * Does not have trailing slash.
553 * @param string $stylesheet_or_template Optional. The stylesheet or template name of the theme.
554 * Default is to leverage the main theme root.
555 * @param string $theme_root Optional. The theme root for which calculations will be based, preventing
556 * the need for a get_raw_theme_root() call.
557 * @return string Themes URI.
559 function get_theme_root_uri( $stylesheet_or_template = false, $theme_root = false ) {
560 global $wp_theme_directories;
562 if ( $stylesheet_or_template && ! $theme_root )
563 $theme_root = get_raw_theme_root( $stylesheet_or_template );
565 if ( $stylesheet_or_template && $theme_root ) {
566 if ( in_array( $theme_root, (array) $wp_theme_directories ) ) {
567 // Absolute path. Make an educated guess. YMMV -- but note the filter below.
568 if ( 0 === strpos( $theme_root, WP_CONTENT_DIR ) )
569 $theme_root_uri = content_url( str_replace( WP_CONTENT_DIR, '', $theme_root ) );
570 elseif ( 0 === strpos( $theme_root, ABSPATH ) )
571 $theme_root_uri = site_url( str_replace( ABSPATH, '', $theme_root ) );
572 elseif ( 0 === strpos( $theme_root, WP_PLUGIN_DIR ) || 0 === strpos( $theme_root, WPMU_PLUGIN_DIR ) )
573 $theme_root_uri = plugins_url( basename( $theme_root ), $theme_root );
575 $theme_root_uri = $theme_root;
577 $theme_root_uri = content_url( $theme_root );
580 $theme_root_uri = content_url( 'themes' );
584 * Filter the URI for themes directory.
588 * @param string $theme_root_uri The URI for themes directory.
589 * @param string $siteurl WordPress web address which is set in General Options.
590 * @param string $stylesheet_or_template Stylesheet or template name of the theme.
592 return apply_filters( 'theme_root_uri', $theme_root_uri, get_option( 'siteurl' ), $stylesheet_or_template );
596 * Get the raw theme root relative to the content directory with no filters applied.
600 * @param string $stylesheet_or_template The stylesheet or template name of the theme
601 * @param bool $skip_cache Optional. Whether to skip the cache. Defaults to false, meaning the cache is used.
602 * @return string Theme root
604 function get_raw_theme_root( $stylesheet_or_template, $skip_cache = false ) {
605 global $wp_theme_directories;
607 if ( count($wp_theme_directories) <= 1 )
612 // If requesting the root for the current theme, consult options to avoid calling get_theme_roots()
613 if ( ! $skip_cache ) {
614 if ( get_option('stylesheet') == $stylesheet_or_template )
615 $theme_root = get_option('stylesheet_root');
616 elseif ( get_option('template') == $stylesheet_or_template )
617 $theme_root = get_option('template_root');
620 if ( empty($theme_root) ) {
621 $theme_roots = get_theme_roots();
622 if ( !empty($theme_roots[$stylesheet_or_template]) )
623 $theme_root = $theme_roots[$stylesheet_or_template];
630 * Display localized stylesheet link element.
634 function locale_stylesheet() {
635 $stylesheet = get_locale_stylesheet_uri();
636 if ( empty($stylesheet) )
638 echo '<link rel="stylesheet" href="' . $stylesheet . '" type="text/css" media="screen" />';
642 * Start preview theme output buffer.
644 * Will only perform task if the user has permissions and template and preview
645 * query variables exist.
649 function preview_theme() {
650 if ( ! (isset($_GET['template']) && isset($_GET['preview'])) )
653 if ( !current_user_can( 'switch_themes' ) )
656 // Admin Thickbox requests
657 if ( isset( $_GET['preview_iframe'] ) )
658 show_admin_bar( false );
660 $_GET['template'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['template']);
662 if ( validate_file($_GET['template']) )
665 add_filter( 'template', '_preview_theme_template_filter' );
667 if ( isset($_GET['stylesheet']) ) {
668 $_GET['stylesheet'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['stylesheet']);
669 if ( validate_file($_GET['stylesheet']) )
671 add_filter( 'stylesheet', '_preview_theme_stylesheet_filter' );
674 // Prevent theme mods to current theme being used on theme being previewed
675 add_filter( 'pre_option_theme_mods_' . get_option( 'stylesheet' ), '__return_empty_array' );
677 ob_start( 'preview_theme_ob_filter' );
679 add_action('setup_theme', 'preview_theme');
682 * Private function to modify the current template when previewing a theme
689 function _preview_theme_template_filter() {
690 return isset($_GET['template']) ? $_GET['template'] : '';
694 * Private function to modify the current stylesheet when previewing a theme
701 function _preview_theme_stylesheet_filter() {
702 return isset($_GET['stylesheet']) ? $_GET['stylesheet'] : '';
706 * Callback function for ob_start() to capture all links in the theme.
711 * @param string $content
714 function preview_theme_ob_filter( $content ) {
715 return preg_replace_callback( "|(<a.*?href=([\"']))(.*?)([\"'].*?>)|", 'preview_theme_ob_filter_callback', $content );
719 * Manipulates preview theme links in order to control and maintain location.
721 * Callback function for preg_replace_callback() to accept and filter matches.
726 * @param array $matches
729 function preview_theme_ob_filter_callback( $matches ) {
730 if ( strpos($matches[4], 'onclick') !== false )
731 $matches[4] = preg_replace('#onclick=([\'"]).*?(?<!\\\)\\1#i', '', $matches[4]); //Strip out any onclicks from rest of <a>. (?<!\\\) means to ignore the '" if it's escaped by \ to prevent breaking mid-attribute.
733 ( false !== strpos($matches[3], '/wp-admin/') )
735 ( false !== strpos( $matches[3], '://' ) && 0 !== strpos( $matches[3], home_url() ) )
737 ( false !== strpos($matches[3], '/feed/') )
739 ( false !== strpos($matches[3], '/trackback/') )
741 return $matches[1] . "#$matches[2] onclick=$matches[2]return false;" . $matches[4];
743 $stylesheet = isset( $_GET['stylesheet'] ) ? $_GET['stylesheet'] : '';
744 $template = isset( $_GET['template'] ) ? $_GET['template'] : '';
746 $link = add_query_arg( array( 'preview' => 1, 'template' => $template, 'stylesheet' => $stylesheet, 'preview_iframe' => 1 ), $matches[3] );
747 if ( 0 === strpos($link, 'preview=1') )
749 return $matches[1] . esc_attr( $link ) . $matches[4];
753 * Switches the theme.
755 * Accepts one argument: $stylesheet of the theme. It also accepts an additional function signature
756 * of two arguments: $template then $stylesheet. This is for backwards compatibility.
760 * @param string $stylesheet Stylesheet name
762 function switch_theme( $stylesheet ) {
763 global $wp_theme_directories, $wp_customize, $sidebars_widgets;
765 $_sidebars_widgets = null;
766 if ( 'wp_ajax_customize_save' === current_action() ) {
767 $_sidebars_widgets = $wp_customize->post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) );
768 } elseif ( is_array( $sidebars_widgets ) ) {
769 $_sidebars_widgets = $sidebars_widgets;
772 if ( is_array( $_sidebars_widgets ) ) {
773 set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) );
776 $old_theme = wp_get_theme();
777 $new_theme = wp_get_theme( $stylesheet );
779 if ( func_num_args() > 1 ) {
780 $template = $stylesheet;
781 $stylesheet = func_get_arg( 1 );
783 $template = $new_theme->get_template();
786 update_option( 'template', $template );
787 update_option( 'stylesheet', $stylesheet );
789 if ( count( $wp_theme_directories ) > 1 ) {
790 update_option( 'template_root', get_raw_theme_root( $template, true ) );
791 update_option( 'stylesheet_root', get_raw_theme_root( $stylesheet, true ) );
793 delete_option( 'template_root' );
794 delete_option( 'stylesheet_root' );
797 $new_name = $new_theme->get('Name');
799 update_option( 'current_theme', $new_name );
801 // Migrate from the old mods_{name} option to theme_mods_{slug}.
802 if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
803 $default_theme_mods = (array) get_option( 'mods_' . $new_name );
804 add_option( "theme_mods_$stylesheet", $default_theme_mods );
807 * Since retrieve_widgets() is called when initializing the customizer theme,
808 * we need to to remove the theme mods to avoid overwriting changes made via
809 * the widget customizer when accessing wp-admin/widgets.php.
811 if ( 'wp_ajax_customize_save' === current_action() ) {
812 remove_theme_mod( 'sidebars_widgets' );
816 update_option( 'theme_switched', $old_theme->get_stylesheet() );
818 * Fires after the theme is switched.
822 * @param string $new_name Name of the new theme.
823 * @param WP_Theme $new_theme WP_Theme instance of the new theme.
825 do_action( 'switch_theme', $new_name, $new_theme );
829 * Checks that current theme files 'index.php' and 'style.css' exists.
831 * Does not check the default theme, which is the fallback and should always exist.
832 * Will switch theme to the fallback theme if current theme does not validate.
833 * You can use the 'validate_current_theme' filter to return false to
834 * disable this functionality.
837 * @see WP_DEFAULT_THEME
841 function validate_current_theme() {
843 * Filter whether to validate the current theme.
847 * @param bool true Validation flag to check the current theme.
849 if ( defined('WP_INSTALLING') || ! apply_filters( 'validate_current_theme', true ) )
852 if ( get_template() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/index.php') ) {
853 switch_theme( WP_DEFAULT_THEME );
857 if ( get_stylesheet() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/style.css') ) {
858 switch_theme( WP_DEFAULT_THEME );
862 if ( is_child_theme() && ! file_exists( get_stylesheet_directory() . '/style.css' ) ) {
863 switch_theme( WP_DEFAULT_THEME );
871 * Retrieve all theme modifications.
875 * @return array Theme modifications.
877 function get_theme_mods() {
878 $theme_slug = get_option( 'stylesheet' );
879 if ( false === ( $mods = get_option( "theme_mods_$theme_slug" ) ) ) {
880 $theme_name = get_option( 'current_theme' );
881 if ( false === $theme_name )
882 $theme_name = wp_get_theme()->get('Name');
883 $mods = get_option( "mods_$theme_name" ); // Deprecated location.
884 if ( is_admin() && false !== $mods ) {
885 update_option( "theme_mods_$theme_slug", $mods );
886 delete_option( "mods_$theme_name" );
893 * Retrieve theme modification value for the current theme.
895 * If the modification name does not exist, then the $default will be passed
896 * through {@link http://php.net/sprintf sprintf()} PHP function with the first
897 * string the template directory URI and the second string the stylesheet
902 * @param string $name Theme modification name.
903 * @param bool|string $default
906 function get_theme_mod( $name, $default = false ) {
907 $mods = get_theme_mods();
909 if ( isset( $mods[$name] ) ) {
911 * Filter the theme modification, or 'theme_mod', value.
913 * The dynamic portion of the hook name, $name, refers to
914 * the key name of the modification array. For example,
915 * 'header_textcolor', 'header_image', and so on depending
916 * on the theme options.
920 * @param string $current_mod The value of the current theme modification.
922 return apply_filters( "theme_mod_{$name}", $mods[$name] );
925 if ( is_string( $default ) )
926 $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
928 /** This filter is documented in wp-includes/theme.php */
929 return apply_filters( "theme_mod_{$name}", $default );
933 * Update theme modification value for the current theme.
937 * @param string $name Theme modification name.
938 * @param string $value theme modification value.
940 function set_theme_mod( $name, $value ) {
941 $mods = get_theme_mods();
942 $old_value = isset( $mods[ $name ] ) ? $mods[ $name ] : false;
945 * Filter the theme mod value on save.
947 * The dynamic portion of the hook name, $name, refers to the key name of
948 * the modification array. For example, 'header_textcolor', 'header_image',
949 * and so on depending on the theme options.
953 * @param string $value The new value of the theme mod.
954 * @param string $old_value The current value of the theme mod.
956 $mods[ $name ] = apply_filters( "pre_set_theme_mod_$name", $value, $old_value );
958 $theme = get_option( 'stylesheet' );
959 update_option( "theme_mods_$theme", $mods );
963 * Remove theme modification name from current theme list.
965 * If removing the name also removes all elements, then the entire option will
970 * @param string $name Theme modification name.
973 function remove_theme_mod( $name ) {
974 $mods = get_theme_mods();
976 if ( ! isset( $mods[ $name ] ) )
979 unset( $mods[ $name ] );
981 if ( empty( $mods ) )
982 return remove_theme_mods();
984 $theme = get_option( 'stylesheet' );
985 update_option( "theme_mods_$theme", $mods );
989 * Remove theme modifications option for current theme.
993 function remove_theme_mods() {
994 delete_option( 'theme_mods_' . get_option( 'stylesheet' ) );
997 $theme_name = get_option( 'current_theme' );
998 if ( false === $theme_name )
999 $theme_name = wp_get_theme()->get('Name');
1000 delete_option( 'mods_' . $theme_name );
1004 * Retrieve text color for custom header.
1010 function get_header_textcolor() {
1011 return get_theme_mod('header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
1015 * Display text color for custom header.
1019 function header_textcolor() {
1020 echo get_header_textcolor();
1024 * Whether to display the header text.
1030 function display_header_text() {
1031 if ( ! current_theme_supports( 'custom-header', 'header-text' ) )
1034 $text_color = get_theme_mod( 'header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
1035 return 'blank' != $text_color;
1039 * Retrieve header image for custom header.
1045 function get_header_image() {
1046 $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
1048 if ( 'remove-header' == $url )
1051 if ( is_random_header_image() )
1052 $url = get_random_header_image();
1054 return esc_url_raw( set_url_scheme( $url ) );
1058 * Get random header image data from registered images in theme.
1064 * @return string Path to header image
1067 function _get_random_header_data() {
1068 static $_wp_random_header;
1070 if ( empty( $_wp_random_header ) ) {
1071 global $_wp_default_headers;
1072 $header_image_mod = get_theme_mod( 'header_image', '' );
1075 if ( 'random-uploaded-image' == $header_image_mod )
1076 $headers = get_uploaded_header_images();
1077 elseif ( ! empty( $_wp_default_headers ) ) {
1078 if ( 'random-default-image' == $header_image_mod ) {
1079 $headers = $_wp_default_headers;
1081 if ( current_theme_supports( 'custom-header', 'random-default' ) )
1082 $headers = $_wp_default_headers;
1086 if ( empty( $headers ) )
1087 return new stdClass;
1089 $_wp_random_header = (object) $headers[ array_rand( $headers ) ];
1091 $_wp_random_header->url = sprintf( $_wp_random_header->url, get_template_directory_uri(), get_stylesheet_directory_uri() );
1092 $_wp_random_header->thumbnail_url = sprintf( $_wp_random_header->thumbnail_url, get_template_directory_uri(), get_stylesheet_directory_uri() );
1094 return $_wp_random_header;
1098 * Get random header image url from registered images in theme.
1102 * @return string Path to header image
1105 function get_random_header_image() {
1106 $random_image = _get_random_header_data();
1107 if ( empty( $random_image->url ) )
1109 return $random_image->url;
1113 * Check if random header image is in use.
1115 * Always true if user expressly chooses the option in Appearance > Header.
1116 * Also true if theme has multiple header images registered, no specific header image
1117 * is chosen, and theme turns on random headers with add_theme_support().
1121 * @param string $type The random pool to use. any|default|uploaded
1124 function is_random_header_image( $type = 'any' ) {
1125 $header_image_mod = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
1127 if ( 'any' == $type ) {
1128 if ( 'random-default-image' == $header_image_mod || 'random-uploaded-image' == $header_image_mod || ( '' != get_random_header_image() && empty( $header_image_mod ) ) )
1131 if ( "random-$type-image" == $header_image_mod )
1133 elseif ( 'default' == $type && empty( $header_image_mod ) && '' != get_random_header_image() )
1141 * Display header image URL.
1145 function header_image() {
1146 echo esc_url( get_header_image() );
1150 * Get the header images uploaded for the current theme.
1156 function get_uploaded_header_images() {
1157 $header_images = array();
1160 $headers = get_posts( array( 'post_type' => 'attachment', 'meta_key' => '_wp_attachment_is_custom_header', 'meta_value' => get_option('stylesheet'), 'orderby' => 'none', 'nopaging' => true ) );
1162 if ( empty( $headers ) )
1165 foreach ( (array) $headers as $header ) {
1166 $url = esc_url_raw( wp_get_attachment_url( $header->ID ) );
1167 $header_data = wp_get_attachment_metadata( $header->ID );
1168 $header_index = basename($url);
1169 $header_images[$header_index] = array();
1170 $header_images[$header_index]['attachment_id'] = $header->ID;
1171 $header_images[$header_index]['url'] = $url;
1172 $header_images[$header_index]['thumbnail_url'] = $url;
1173 if ( isset( $header_data['width'] ) )
1174 $header_images[$header_index]['width'] = $header_data['width'];
1175 if ( isset( $header_data['height'] ) )
1176 $header_images[$header_index]['height'] = $header_data['height'];
1179 return $header_images;
1183 * Get the header image data.
1189 function get_custom_header() {
1190 global $_wp_default_headers;
1192 if ( is_random_header_image() ) {
1193 $data = _get_random_header_data();
1195 $data = get_theme_mod( 'header_image_data' );
1196 if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) {
1197 $directory_args = array( get_template_directory_uri(), get_stylesheet_directory_uri() );
1199 $data['url'] = $data['thumbnail_url'] = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args );
1200 if ( ! empty( $_wp_default_headers ) ) {
1201 foreach ( (array) $_wp_default_headers as $default_header ) {
1202 $url = vsprintf( $default_header['url'], $directory_args );
1203 if ( $data['url'] == $url ) {
1204 $data = $default_header;
1205 $data['url'] = $url;
1206 $data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args );
1216 'thumbnail_url' => '',
1217 'width' => get_theme_support( 'custom-header', 'width' ),
1218 'height' => get_theme_support( 'custom-header', 'height' ),
1220 return (object) wp_parse_args( $data, $default );
1224 * Register a selection of default headers to be displayed by the custom header admin UI.
1228 * @param array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys.
1230 function register_default_headers( $headers ) {
1231 global $_wp_default_headers;
1233 $_wp_default_headers = array_merge( (array) $_wp_default_headers, (array) $headers );
1237 * Unregister default headers.
1239 * This function must be called after register_default_headers() has already added the
1240 * header you want to remove.
1242 * @see register_default_headers()
1245 * @param string|array $header The header string id (key of array) to remove, or an array thereof.
1246 * @return bool|void A single header returns true on success, false on failure.
1247 * There is currently no return value for multiple headers.
1249 function unregister_default_headers( $header ) {
1250 global $_wp_default_headers;
1251 if ( is_array( $header ) ) {
1252 array_map( 'unregister_default_headers', $header );
1253 } elseif ( isset( $_wp_default_headers[ $header ] ) ) {
1254 unset( $_wp_default_headers[ $header ] );
1262 * Retrieve background image for custom background.
1268 function get_background_image() {
1269 return get_theme_mod('background_image', get_theme_support( 'custom-background', 'default-image' ) );
1273 * Display background image path.
1277 function background_image() {
1278 echo get_background_image();
1282 * Retrieve value for custom background color.
1288 function get_background_color() {
1289 return get_theme_mod('background_color', get_theme_support( 'custom-background', 'default-color' ) );
1293 * Display background color value.
1297 function background_color() {
1298 echo get_background_color();
1302 * Default custom background callback.
1307 function _custom_background_cb() {
1308 // $background is the saved custom image, or the default image.
1309 $background = set_url_scheme( get_background_image() );
1311 // $color is the saved custom color.
1312 // A default has to be specified in style.css. It will not be printed here.
1313 $color = get_background_color();
1315 if ( $color === get_theme_support( 'custom-background', 'default-color' ) ) {
1319 if ( ! $background && ! $color )
1322 $style = $color ? "background-color: #$color;" : '';
1324 if ( $background ) {
1325 $image = " background-image: url('$background');";
1327 $repeat = get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) );
1328 if ( ! in_array( $repeat, array( 'no-repeat', 'repeat-x', 'repeat-y', 'repeat' ) ) )
1330 $repeat = " background-repeat: $repeat;";
1332 $position = get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
1333 if ( ! in_array( $position, array( 'center', 'right', 'left' ) ) )
1335 $position = " background-position: top $position;";
1337 $attachment = get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) );
1338 if ( ! in_array( $attachment, array( 'fixed', 'scroll' ) ) )
1339 $attachment = 'scroll';
1340 $attachment = " background-attachment: $attachment;";
1342 $style .= $image . $repeat . $position . $attachment;
1345 <style type="text/css" id="custom-background-css">
1346 body.custom-background { <?php echo trim( $style ); ?> }
1352 * Add callback for custom TinyMCE editor stylesheets.
1354 * The parameter $stylesheet is the name of the stylesheet, relative to
1355 * the theme root. It also accepts an array of stylesheets.
1356 * It is optional and defaults to 'editor-style.css'.
1358 * This function automatically adds another stylesheet with -rtl prefix, e.g. editor-style-rtl.css.
1359 * If that file doesn't exist, it is removed before adding the stylesheet(s) to TinyMCE.
1360 * If an array of stylesheets is passed to add_editor_style(),
1361 * RTL is only added for the first stylesheet.
1363 * Since version 3.4 the TinyMCE body has .rtl CSS class.
1364 * It is a better option to use that class and add any RTL styles to the main stylesheet.
1368 * @param mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
1369 * Defaults to 'editor-style.css'
1371 function add_editor_style( $stylesheet = 'editor-style.css' ) {
1373 add_theme_support( 'editor-style' );
1378 global $editor_styles;
1379 $editor_styles = (array) $editor_styles;
1380 $stylesheet = (array) $stylesheet;
1382 $rtl_stylesheet = str_replace('.css', '-rtl.css', $stylesheet[0]);
1383 $stylesheet[] = $rtl_stylesheet;
1386 $editor_styles = array_merge( $editor_styles, $stylesheet );
1390 * Removes all visual editor stylesheets.
1394 * @return bool True on success, false if there were no stylesheets to remove.
1396 function remove_editor_styles() {
1397 if ( ! current_theme_supports( 'editor-style' ) )
1399 _remove_theme_support( 'editor-style' );
1401 $GLOBALS['editor_styles'] = array();
1406 * Retrieve any registered editor stylesheets
1410 * @global $editor_styles Registered editor stylesheets
1412 * @return array If registered, a list of editor stylesheet URLs.
1414 function get_editor_stylesheets() {
1415 $stylesheets = array();
1416 // load editor_style.css if the current theme supports it
1417 if ( ! empty( $GLOBALS['editor_styles'] ) && is_array( $GLOBALS['editor_styles'] ) ) {
1418 $editor_styles = $GLOBALS['editor_styles'];
1420 $editor_styles = array_unique( array_filter( $editor_styles ) );
1421 $style_uri = get_stylesheet_directory_uri();
1422 $style_dir = get_stylesheet_directory();
1424 // Support externally referenced styles (like, say, fonts).
1425 foreach ( $editor_styles as $key => $file ) {
1426 if ( preg_match( '~^(https?:)?//~', $file ) ) {
1427 $stylesheets[] = esc_url_raw( $file );
1428 unset( $editor_styles[ $key ] );
1432 // Look in a parent theme first, that way child theme CSS overrides.
1433 if ( is_child_theme() ) {
1434 $template_uri = get_template_directory_uri();
1435 $template_dir = get_template_directory();
1437 foreach ( $editor_styles as $key => $file ) {
1438 if ( $file && file_exists( "$template_dir/$file" ) ) {
1439 $stylesheets[] = "$template_uri/$file";
1444 foreach ( $editor_styles as $file ) {
1445 if ( $file && file_exists( "$style_dir/$file" ) ) {
1446 $stylesheets[] = "$style_uri/$file";
1450 return $stylesheets;
1454 * Allows a theme to register its support of a certain feature
1456 * Must be called in the theme's functions.php file to work.
1457 * If attached to a hook, it must be after_setup_theme.
1458 * The init hook may be too late for some features.
1462 * @param string $feature The feature being added.
1463 * @return void|bool False on failure, void otherwise.
1465 function add_theme_support( $feature ) {
1466 global $_wp_theme_features;
1468 if ( func_num_args() == 1 )
1471 $args = array_slice( func_get_args(), 1 );
1473 switch ( $feature ) {
1474 case 'post-formats' :
1475 if ( is_array( $args[0] ) )
1476 $args[0] = array_intersect( $args[0], array_keys( get_post_format_slugs() ) );
1480 // You can't just pass 'html5', you need to pass an array of types.
1481 if ( empty( $args[0] ) ) {
1482 // Build an array of types for back-compat.
1483 $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
1484 } elseif ( ! is_array( $args[0] ) ) {
1485 _doing_it_wrong( "add_theme_support( 'html5' )", 'You need to pass an array of types.', '3.6.1' );
1489 // Calling 'html5' again merges, rather than overwrites.
1490 if ( isset( $_wp_theme_features['html5'] ) )
1491 $args[0] = array_merge( $_wp_theme_features['html5'][0], $args[0] );
1494 case 'custom-header-uploads' :
1495 return add_theme_support( 'custom-header', array( 'uploads' => true ) );
1497 case 'custom-header' :
1498 if ( ! is_array( $args ) )
1499 $args = array( 0 => array() );
1502 'default-image' => '',
1503 'random-default' => false,
1506 'flex-height' => false,
1507 'flex-width' => false,
1508 'default-text-color' => '',
1509 'header-text' => true,
1511 'wp-head-callback' => '',
1512 'admin-head-callback' => '',
1513 'admin-preview-callback' => '',
1516 $jit = isset( $args[0]['__jit'] );
1517 unset( $args[0]['__jit'] );
1519 // Merge in data from previous add_theme_support() calls.
1520 // The first value registered wins. (A child theme is set up first.)
1521 if ( isset( $_wp_theme_features['custom-header'] ) )
1522 $args[0] = wp_parse_args( $_wp_theme_features['custom-header'][0], $args[0] );
1524 // Load in the defaults at the end, as we need to insure first one wins.
1525 // This will cause all constants to be defined, as each arg will then be set to the default.
1527 $args[0] = wp_parse_args( $args[0], $defaults );
1529 // If a constant was defined, use that value. Otherwise, define the constant to ensure
1530 // the constant is always accurate (and is not defined later, overriding our value).
1531 // As stated above, the first value wins.
1532 // Once we get to wp_loaded (just-in-time), define any constants we haven't already.
1533 // Constants are lame. Don't reference them. This is just for backwards compatibility.
1535 if ( defined( 'NO_HEADER_TEXT' ) )
1536 $args[0]['header-text'] = ! NO_HEADER_TEXT;
1537 elseif ( isset( $args[0]['header-text'] ) )
1538 define( 'NO_HEADER_TEXT', empty( $args[0]['header-text'] ) );
1540 if ( defined( 'HEADER_IMAGE_WIDTH' ) )
1541 $args[0]['width'] = (int) HEADER_IMAGE_WIDTH;
1542 elseif ( isset( $args[0]['width'] ) )
1543 define( 'HEADER_IMAGE_WIDTH', (int) $args[0]['width'] );
1545 if ( defined( 'HEADER_IMAGE_HEIGHT' ) )
1546 $args[0]['height'] = (int) HEADER_IMAGE_HEIGHT;
1547 elseif ( isset( $args[0]['height'] ) )
1548 define( 'HEADER_IMAGE_HEIGHT', (int) $args[0]['height'] );
1550 if ( defined( 'HEADER_TEXTCOLOR' ) )
1551 $args[0]['default-text-color'] = HEADER_TEXTCOLOR;
1552 elseif ( isset( $args[0]['default-text-color'] ) )
1553 define( 'HEADER_TEXTCOLOR', $args[0]['default-text-color'] );
1555 if ( defined( 'HEADER_IMAGE' ) )
1556 $args[0]['default-image'] = HEADER_IMAGE;
1557 elseif ( isset( $args[0]['default-image'] ) )
1558 define( 'HEADER_IMAGE', $args[0]['default-image'] );
1560 if ( $jit && ! empty( $args[0]['default-image'] ) )
1561 $args[0]['random-default'] = false;
1563 // If headers are supported, and we still don't have a defined width or height,
1564 // we have implicit flex sizes.
1566 if ( empty( $args[0]['width'] ) && empty( $args[0]['flex-width'] ) )
1567 $args[0]['flex-width'] = true;
1568 if ( empty( $args[0]['height'] ) && empty( $args[0]['flex-height'] ) )
1569 $args[0]['flex-height'] = true;
1574 case 'custom-background' :
1575 if ( ! is_array( $args ) )
1576 $args = array( 0 => array() );
1579 'default-image' => '',
1580 'default-repeat' => 'repeat',
1581 'default-position-x' => 'left',
1582 'default-attachment' => 'scroll',
1583 'default-color' => '',
1584 'wp-head-callback' => '_custom_background_cb',
1585 'admin-head-callback' => '',
1586 'admin-preview-callback' => '',
1589 $jit = isset( $args[0]['__jit'] );
1590 unset( $args[0]['__jit'] );
1592 // Merge in data from previous add_theme_support() calls. The first value registered wins.
1593 if ( isset( $_wp_theme_features['custom-background'] ) )
1594 $args[0] = wp_parse_args( $_wp_theme_features['custom-background'][0], $args[0] );
1597 $args[0] = wp_parse_args( $args[0], $defaults );
1599 if ( defined( 'BACKGROUND_COLOR' ) )
1600 $args[0]['default-color'] = BACKGROUND_COLOR;
1601 elseif ( isset( $args[0]['default-color'] ) || $jit )
1602 define( 'BACKGROUND_COLOR', $args[0]['default-color'] );
1604 if ( defined( 'BACKGROUND_IMAGE' ) )
1605 $args[0]['default-image'] = BACKGROUND_IMAGE;
1606 elseif ( isset( $args[0]['default-image'] ) || $jit )
1607 define( 'BACKGROUND_IMAGE', $args[0]['default-image'] );
1612 $_wp_theme_features[ $feature ] = $args;
1616 * Registers the internal custom header and background routines.
1621 function _custom_header_background_just_in_time() {
1622 global $custom_image_header, $custom_background;
1624 if ( current_theme_supports( 'custom-header' ) ) {
1625 // In case any constants were defined after an add_custom_image_header() call, re-run.
1626 add_theme_support( 'custom-header', array( '__jit' => true ) );
1628 $args = get_theme_support( 'custom-header' );
1629 if ( $args[0]['wp-head-callback'] )
1630 add_action( 'wp_head', $args[0]['wp-head-callback'] );
1633 require_once( ABSPATH . 'wp-admin/custom-header.php' );
1634 $custom_image_header = new Custom_Image_Header( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
1638 if ( current_theme_supports( 'custom-background' ) ) {
1639 // In case any constants were defined after an add_custom_background() call, re-run.
1640 add_theme_support( 'custom-background', array( '__jit' => true ) );
1642 $args = get_theme_support( 'custom-background' );
1643 add_action( 'wp_head', $args[0]['wp-head-callback'] );
1646 require_once( ABSPATH . 'wp-admin/custom-background.php' );
1647 $custom_background = new Custom_Background( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
1651 add_action( 'wp_loaded', '_custom_header_background_just_in_time' );
1654 * Gets the theme support arguments passed when registering that support
1658 * @param string $feature the feature to check
1659 * @return array The array of extra arguments
1661 function get_theme_support( $feature ) {
1662 global $_wp_theme_features;
1663 if ( ! isset( $_wp_theme_features[ $feature ] ) )
1666 if ( func_num_args() <= 1 )
1667 return $_wp_theme_features[ $feature ];
1669 $args = array_slice( func_get_args(), 1 );
1670 switch ( $feature ) {
1671 case 'custom-header' :
1672 case 'custom-background' :
1673 if ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) )
1674 return $_wp_theme_features[ $feature ][0][ $args[0] ];
1678 return $_wp_theme_features[ $feature ];
1683 * Allows a theme to de-register its support of a certain feature
1685 * Should be called in the theme's functions.php file. Generally would
1686 * be used for child themes to override support from the parent theme.
1689 * @see add_theme_support()
1690 * @param string $feature the feature being added
1691 * @return bool Whether feature was removed.
1693 function remove_theme_support( $feature ) {
1694 // Blacklist: for internal registrations not used directly by themes.
1695 if ( in_array( $feature, array( 'editor-style', 'widgets', 'menus' ) ) )
1698 return _remove_theme_support( $feature );
1702 * Do not use. Removes theme support internally, ignorant of the blacklist.
1707 function _remove_theme_support( $feature ) {
1708 global $_wp_theme_features;
1710 switch ( $feature ) {
1711 case 'custom-header-uploads' :
1712 if ( ! isset( $_wp_theme_features['custom-header'] ) )
1714 add_theme_support( 'custom-header', array( 'uploads' => false ) );
1715 return; // Do not continue - custom-header-uploads no longer exists.
1718 if ( ! isset( $_wp_theme_features[ $feature ] ) )
1721 switch ( $feature ) {
1722 case 'custom-header' :
1723 if ( ! did_action( 'wp_loaded' ) )
1725 $support = get_theme_support( 'custom-header' );
1726 if ( $support[0]['wp-head-callback'] )
1727 remove_action( 'wp_head', $support[0]['wp-head-callback'] );
1728 remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
1729 unset( $GLOBALS['custom_image_header'] );
1732 case 'custom-background' :
1733 if ( ! did_action( 'wp_loaded' ) )
1735 $support = get_theme_support( 'custom-background' );
1736 remove_action( 'wp_head', $support[0]['wp-head-callback'] );
1737 remove_action( 'admin_menu', array( $GLOBALS['custom_background'], 'init' ) );
1738 unset( $GLOBALS['custom_background'] );
1742 unset( $_wp_theme_features[ $feature ] );
1747 * Checks a theme's support for a given feature
1750 * @param string $feature the feature being checked
1753 function current_theme_supports( $feature ) {
1754 global $_wp_theme_features;
1756 if ( 'custom-header-uploads' == $feature )
1757 return current_theme_supports( 'custom-header', 'uploads' );
1759 if ( !isset( $_wp_theme_features[$feature] ) )
1762 // If no args passed then no extra checks need be performed
1763 if ( func_num_args() <= 1 )
1766 $args = array_slice( func_get_args(), 1 );
1768 switch ( $feature ) {
1769 case 'post-thumbnails':
1770 // post-thumbnails can be registered for only certain content/post types by passing
1771 // an array of types to add_theme_support(). If no array was passed, then
1772 // any type is accepted
1773 if ( true === $_wp_theme_features[$feature] ) // Registered for all types
1775 $content_type = $args[0];
1776 return in_array( $content_type, $_wp_theme_features[$feature][0] );
1779 case 'post-formats':
1780 // specific post formats can be registered by passing an array of types to
1781 // add_theme_support()
1783 // Specific areas of HTML5 support *must* be passed via an array to add_theme_support()
1786 return in_array( $type, $_wp_theme_features[$feature][0] );
1788 case 'custom-header':
1789 case 'custom-background' :
1790 // specific custom header and background capabilities can be registered by passing
1791 // an array to add_theme_support()
1792 $header_support = $args[0];
1793 return ( isset( $_wp_theme_features[$feature][0][$header_support] ) && $_wp_theme_features[$feature][0][$header_support] );
1797 * Filter whether the current theme supports a specific feature.
1799 * The dynamic portion of the hook name, $feature, refers to
1800 * the specific theme feature. Possible values include 'post-formats',
1801 * 'post-thumbnails', 'custom-background', 'custom-header', 'menus',
1802 * 'automatic-feed-links', and 'html5'.
1806 * @param bool true Whether the current theme supports the given feature. Default true.
1807 * @param array $args Array of arguments for the feature.
1808 * @param string $feature The theme feature.
1810 return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[$feature] );
1814 * Checks a theme's support for a given feature before loading the functions which implement it.
1818 * @param string $feature The feature being checked.
1819 * @param string $include Path to the file.
1820 * @return bool True if the current theme supports the supplied feature, false otherwise.
1822 function require_if_theme_supports( $feature, $include ) {
1823 if ( current_theme_supports( $feature ) ) {
1824 require ( $include );
1831 * Checks an attachment being deleted to see if it's a header or background image.
1833 * If true it removes the theme modification which would be pointing at the deleted
1838 * @param int $id the attachment id
1840 function _delete_attachment_theme_mod( $id ) {
1841 $attachment_image = wp_get_attachment_url( $id );
1842 $header_image = get_header_image();
1843 $background_image = get_background_image();
1845 if ( $header_image && $header_image == $attachment_image )
1846 remove_theme_mod( 'header_image' );
1848 if ( $background_image && $background_image == $attachment_image )
1849 remove_theme_mod( 'background_image' );
1852 add_action( 'delete_attachment', '_delete_attachment_theme_mod' );
1855 * Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load
1859 function check_theme_switched() {
1860 if ( $stylesheet = get_option( 'theme_switched' ) ) {
1861 $old_theme = wp_get_theme( $stylesheet );
1863 // Prevent retrieve_widgets() from running since Customizer already called it up front
1864 if ( get_option( 'theme_switched_via_customizer' ) ) {
1865 remove_action( 'after_switch_theme', '_wp_sidebars_changed' );
1866 update_option( 'theme_switched_via_customizer', false );
1869 if ( $old_theme->exists() ) {
1871 * Fires on the first WP load after a theme switch if the old theme still exists.
1873 * This action fires multiple times and the parameters differs
1874 * according to the context, if the old theme exists or not.
1875 * If the old theme is missing, the parameter will be the slug
1880 * @param string $old_name Old theme name.
1881 * @param WP_Theme $old_theme WP_Theme instance of the old theme.
1883 do_action( 'after_switch_theme', $old_theme->get( 'Name' ), $old_theme );
1885 /** This action is documented in wp-includes/theme.php */
1886 do_action( 'after_switch_theme', $stylesheet );
1889 update_option( 'theme_switched', false );
1894 * Includes and instantiates the WP_Customize_Manager class.
1896 * Fires when ?wp_customize=on or on wp-admin/customize.php.
1900 function _wp_customize_include() {
1901 if ( ! ( ( isset( $_REQUEST['wp_customize'] ) && 'on' == $_REQUEST['wp_customize'] )
1902 || ( is_admin() && 'customize.php' == basename( $_SERVER['PHP_SELF'] ) )
1906 require( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
1907 // Init Customize class
1908 $GLOBALS['wp_customize'] = new WP_Customize_Manager;
1910 add_action( 'plugins_loaded', '_wp_customize_include' );
1913 * Adds settings for the customize-loader script.
1917 function _wp_customize_loader_settings() {
1920 $admin_origin = parse_url( admin_url() );
1921 $home_origin = parse_url( home_url() );
1922 $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
1925 'mobile' => wp_is_mobile(),
1926 'ios' => wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] ),
1930 'url' => esc_url( admin_url( 'customize.php' ) ),
1931 'isCrossDomain' => $cross_domain,
1932 'browser' => $browser,
1934 'saveAlert' => __( 'The changes you made will be lost if you navigate away from this page.' ),
1938 $script = 'var _wpCustomizeLoaderSettings = ' . json_encode( $settings ) . ';';
1940 $data = $wp_scripts->get_data( 'customize-loader', 'data' );
1942 $script = "$data\n$script";
1944 $wp_scripts->add_data( 'customize-loader', 'data', $script );
1946 add_action( 'admin_enqueue_scripts', '_wp_customize_loader_settings' );
1949 * Returns a URL to load the theme customizer.
1953 * @param string $stylesheet Optional. Theme to customize. Defaults to current theme.
1954 * The theme's stylesheet will be urlencoded if necessary.
1956 function wp_customize_url( $stylesheet = null ) {
1957 $url = admin_url( 'customize.php' );
1959 $url .= '?theme=' . urlencode( $stylesheet );
1960 return esc_url( $url );
1964 * Prints a script to check whether or not the customizer is supported,
1965 * and apply either the no-customize-support or customize-support class
1968 * This function MUST be called inside the body tag.
1970 * Ideally, call this function immediately after the body tag is opened.
1971 * This prevents a flash of unstyled content.
1973 * It is also recommended that you add the "no-customize-support" class
1974 * to the body tag by default.
1978 function wp_customize_support_script() {
1979 $admin_origin = parse_url( admin_url() );
1980 $home_origin = parse_url( home_url() );
1981 $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
1984 <script type="text/javascript">
1986 var request, b = document.body, c = 'className', cs = 'customize-support', rcs = new RegExp('(^|\\s+)(no-)?'+cs+'(\\s+|$)');
1988 <?php if ( $cross_domain ): ?>
1989 request = (function(){ var xhr = new XMLHttpRequest(); return ('withCredentials' in xhr); })();
1994 b[c] = b[c].replace( rcs, ' ' );
1995 b[c] += ( window.postMessage && request ? ' ' : ' no-' ) + cs;
2002 * Whether the site is being previewed in the Customizer.
2006 * @global WP_Customize_Manager $wp_customize Customizer instance.
2008 * @return bool True if the site is being previewed in the Customizer, false otherwise.
2010 function is_customize_preview() {
2011 global $wp_customize;
2013 return is_a( $wp_customize, 'WP_Customize_Manager' ) && $wp_customize->is_preview();