wp-includes/theme.php

   1 <?php
   2 /**
   3  * Theme, template, and stylesheet functions.
   4  *
   5  * @package WordPress
   6  * @subpackage Theme
   7  */
   8
   9 /**
  10  * Returns an array of WP_Theme objects based on the arguments.
  11  *
  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.
  14  *
  15  * @since 3.4.0
  16  *
  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.
  26  */
  27 function wp_get_themes( $args = array() ) {
  28         global $wp_theme_directories;
  29
  30         $defaults = array( 'errors' => false, 'allowed' => null, 'blog_id' => 0 );
  31         $args = wp_parse_args( $args, $defaults );
  32
  33         $theme_directories = search_theme_directories();
  34
  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;
  44                 }
  45         }
  46
  47         if ( empty( $theme_directories ) )
  48                 return array();
  49
  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'] ) );
  56                 elseif ( $allowed )
  57                         $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
  58                 else
  59                         $theme_directories = array_diff_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
  60         }
  61
  62         $themes = array();
  63         static $_themes = array();
  64
  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 ];
  68                 else
  69                         $themes[ $theme ] = $_themes[ $theme_root['theme_root'] . '/' . $theme ] = new WP_Theme( $theme, $theme_root['theme_root'] );
  70         }
  71
  72         if ( null !== $args['errors'] ) {
  73                 foreach ( $themes as $theme => $wp_theme ) {
  74                         if ( $wp_theme->errors() != $args['errors'] )
  75                                 unset( $themes[ $theme ] );
  76                 }
  77         }
  78
  79         return $themes;
  80 }
  81
  82 /**
  83  * Gets a WP_Theme object for a theme.
  84  *
  85  * @since 3.4.0
  86  *
  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.
  91  */
  92 function wp_get_theme( $stylesheet = null, $theme_root = null ) {
  93         global $wp_theme_directories;
  94
  95         if ( empty( $stylesheet ) )
  96                 $stylesheet = get_stylesheet();
  97
  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;
 104         }
 105
 106         return new WP_Theme( $stylesheet, $theme_root );
 107 }
 108
 109 /**
 110  * Clears the cache held by get_theme_roots() and WP_Theme.
 111  *
 112  * @since 3.5.0
 113  * @param bool $clear_update_cache Whether to clear the Theme updates cache
 114  */
 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();
 121 }
 122
 123 /**
 124  * Whether a child theme is in use.
 125  *
 126  * @since 3.0.0
 127  *
 128  * @return bool true if a child theme is in use, false otherwise.
 129  **/
 130 function is_child_theme() {
 131         return ( TEMPLATEPATH !== STYLESHEETPATH );
 132 }
 133
 134 /**
 135  * Retrieve name of the current stylesheet.
 136  *
 137  * The theme name that the administrator has currently set the front end theme
 138  * as.
 139  *
 140  * For all intents and purposes, the template name and the stylesheet name are
 141  * going to be the same for most cases.
 142  *
 143  * @since 1.5.0
 144  *
 145  * @return string Stylesheet name.
 146  */
 147 function get_stylesheet() {
 148         /**
 149          * Filter the name of current stylesheet.
 150          *
 151          * @since 1.5.0
 152          *
 153          * @param string $stylesheet Name of the current stylesheet.
 154          */
 155         return apply_filters( 'stylesheet', get_option( 'stylesheet' ) );
 156 }
 157
 158 /**
 159  * Retrieve stylesheet directory path for current theme.
 160  *
 161  * @since 1.5.0
 162  *
 163  * @return string Path to current theme directory.
 164  */
 165 function get_stylesheet_directory() {
 166         $stylesheet = get_stylesheet();
 167         $theme_root = get_theme_root( $stylesheet );
 168         $stylesheet_dir = "$theme_root/$stylesheet";
 169
 170         /**
 171          * Filter the stylesheet directory path for current theme.
 172          *
 173          * @since 1.5.0
 174          *
 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.
 178          */
 179         return apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root );
 180 }
 181
 182 /**
 183  * Retrieve stylesheet directory URI.
 184  *
 185  * @since 1.5.0
 186  *
 187  * @return string
 188  */
 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";
 193
 194         /**
 195          * Filter the stylesheet directory URI.
 196          *
 197          * @since 1.5.0
 198          *
 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.
 202          */
 203         return apply_filters( 'stylesheet_directory_uri', $stylesheet_dir_uri, $stylesheet, $theme_root_uri );
 204 }
 205
 206 /**
 207  * Retrieve URI of current theme stylesheet.
 208  *
 209  * The stylesheet file name is 'style.css' which is appended to {@link
 210  * get_stylesheet_directory_uri() stylesheet directory URI} path.
 211  *
 212  * @since 1.5.0
 213  *
 214  * @return string
 215  */
 216 function get_stylesheet_uri() {
 217         $stylesheet_dir_uri = get_stylesheet_directory_uri();
 218         $stylesheet_uri = $stylesheet_dir_uri . '/style.css';
 219         /**
 220          * Filter the URI of the current theme stylesheet.
 221          *
 222          * @since 1.5.0
 223          *
 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.
 226          */
 227         return apply_filters( 'stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
 228 }
 229
 230 /**
 231  * Retrieve localized stylesheet URI.
 232  *
 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'.
 237  *
 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.
 243  *
 244  * @since 2.1.0
 245  *
 246  * @return string
 247  */
 248 function get_locale_stylesheet_uri() {
 249         global $wp_locale;
 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";
 257         else
 258                 $stylesheet_uri = '';
 259         /**
 260          * Filter the localized stylesheet URI.
 261          *
 262          * @since 2.1.0
 263          *
 264          * @param string $stylesheet_uri     Localized stylesheet URI.
 265          * @param string $stylesheet_dir_uri Stylesheet directory URI.
 266          */
 267         return apply_filters( 'locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
 268 }
 269
 270 /**
 271  * Retrieve name of the current theme.
 272  *
 273  * @since 1.5.0
 274  *
 275  * @return string Template name.
 276  */
 277 function get_template() {
 278         /**
 279          * Filter the name of the current theme.
 280          *
 281          * @since 1.5.0
 282          *
 283          * @param string $template Current theme's directory name.
 284          */
 285         return apply_filters( 'template', get_option( 'template' ) );
 286 }
 287
 288 /**
 289  * Retrieve current theme directory.
 290  *
 291  * @since 1.5.0
 292  *
 293  * @return string Template directory path.
 294  */
 295 function get_template_directory() {
 296         $template = get_template();
 297         $theme_root = get_theme_root( $template );
 298         $template_dir = "$theme_root/$template";
 299
 300         /**
 301          * Filter the current theme directory path.
 302          *
 303          * @since 1.5.0
 304          *
 305          * @param string $template_dir The URI of the current theme directory.
 306          * @param string $template     Directory name of the current theme.
 307          * @param string $theme_root   Absolute path to the themes directory.
 308          */
 309         return apply_filters( 'template_directory', $template_dir, $template, $theme_root );
 310 }
 311
 312 /**
 313  * Retrieve theme directory URI.
 314  *
 315  * @since 1.5.0
 316  *
 317  * @return string Template directory URI.
 318  */
 319 function get_template_directory_uri() {
 320         $template = str_replace( '%2F', '/', rawurlencode( get_template() ) );
 321         $theme_root_uri = get_theme_root_uri( $template );
 322         $template_dir_uri = "$theme_root_uri/$template";
 323
 324         /**
 325          * Filter the current theme directory URI.
 326          *
 327          * @since 1.5.0
 328          *
 329          * @param string $template_dir_uri The URI of the current theme directory.
 330          * @param string $template         Directory name of the current theme.
 331          * @param string $theme_root_uri   The themes root URI.
 332          */
 333         return apply_filters( 'template_directory_uri', $template_dir_uri, $template, $theme_root_uri );
 334 }
 335
 336 /**
 337  * Retrieve theme roots.
 338  *
 339  * @since 2.9.0
 340  *
 341  * @return array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root.
 342  */
 343 function get_theme_roots() {
 344         global $wp_theme_directories;
 345
 346         if ( count($wp_theme_directories) <= 1 )
 347                 return '/themes';
 348
 349         $theme_roots = get_site_transient( 'theme_roots' );
 350         if ( false === $theme_roots ) {
 351                 search_theme_directories( true ); // Regenerate the transient.
 352                 $theme_roots = get_site_transient( 'theme_roots' );
 353         }
 354         return $theme_roots;
 355 }
 356
 357 /**
 358  * Register a directory that contains themes.
 359  *
 360  * @since 2.9.0
 361  *
 362  * @param string $directory Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR
 363  * @return bool
 364  */
 365 function register_theme_directory( $directory ) {
 366         global $wp_theme_directories;
 367
 368         if ( ! file_exists( $directory ) ) {
 369                 // Try prepending as the theme directory could be relative to the content directory
 370                 $directory = WP_CONTENT_DIR . '/' . $directory;
 371                 // If this directory does not exist, return and do not register
 372                 if ( ! file_exists( $directory ) ) {
 373                         return false;
 374                 }
 375         }
 376
 377         if ( ! is_array( $wp_theme_directories ) ) {
 378                 $wp_theme_directories = array();
 379         }
 380
 381         $untrailed = untrailingslashit( $directory );
 382         if ( ! empty( $untrailed ) && ! in_array( $untrailed, $wp_theme_directories ) ) {
 383                 $wp_theme_directories[] = $untrailed;
 384         }
 385
 386         return true;
 387 }
 388
 389 /**
 390  * Search all registered theme directories for complete and valid themes.
 391  *
 392  * @since 2.9.0
 393  *
 394  * @param bool $force Optional. Whether to force a new directory scan. Defaults to false.
 395  * @return array Valid themes found
 396  */
 397 function search_theme_directories( $force = false ) {
 398         global $wp_theme_directories;
 399         if ( empty( $wp_theme_directories ) )
 400                 return false;
 401
 402         static $found_themes;
 403         if ( ! $force && isset( $found_themes ) )
 404                 return $found_themes;
 405
 406         $found_themes = array();
 407
 408         $wp_theme_directories = (array) $wp_theme_directories;
 409         $relative_theme_roots = array();
 410
 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;
 417                 else
 418                         $relative_theme_roots[ $theme_root ] = $theme_root;
 419         }
 420
 421         /**
 422          * Filter whether to get the cache of the registered theme directories.
 423          *
 424          * @since 3.4.0
 425          *
 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.
 428          */
 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 ] ) )
 435                                         continue;
 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.
 439                                 );
 440                         }
 441                         return $found_themes;
 442                 }
 443                 if ( ! is_int( $cache_expiration ) )
 444                         $cache_expiration = 1800; // half hour
 445         } else {
 446                 $cache_expiration = 1800; // half hour
 447         }
 448
 449         /* Loop the registered theme directories and extract all themes */
 450         foreach ( $wp_theme_directories as $theme_root ) {
 451
 452                 // Start with directories in the root of the current theme directory.
 453                 $dirs = @ scandir( $theme_root );
 454                 if ( ! $dirs ) {
 455                         trigger_error( "$theme_root is not readable", E_USER_NOTICE );
 456                         continue;
 457                 }
 458                 foreach ( $dirs as $dir ) {
 459                         if ( ! is_dir( $theme_root . '/' . $dir ) || $dir[0] == '.' || $dir == 'CVS' )
 460                                 continue;
 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,
 467                                 );
 468                         } else {
 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 );
 473                                 if ( ! $sub_dirs ) {
 474                                         trigger_error( "$theme_root/$dir is not readable", E_USER_NOTICE );
 475                                         continue;
 476                                 }
 477                                 foreach ( $sub_dirs as $sub_dir ) {
 478                                         if ( ! is_dir( $theme_root . '/' . $dir . '/' . $sub_dir ) || $dir[0] == '.' || $dir == 'CVS' )
 479                                                 continue;
 480                                         if ( ! file_exists( $theme_root . '/' . $dir . '/' . $sub_dir . '/style.css' ) )
 481                                                 continue;
 482                                         $found_themes[ $dir . '/' . $sub_dir ] = array(
 483                                                 'theme_file' => $dir . '/' . $sub_dir . '/style.css',
 484                                                 'theme_root' => $theme_root,
 485                                         );
 486                                         $found_theme = true;
 487                                 }
 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,
 494                                         );
 495                         }
 496                 }
 497         }
 498
 499         asort( $found_themes );
 500
 501         $theme_roots = array();
 502         $relative_theme_roots = array_flip( $relative_theme_roots );
 503
 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.
 506         }
 507
 508         if ( $theme_roots != get_site_transient( 'theme_roots' ) )
 509                 set_site_transient( 'theme_roots', $theme_roots, $cache_expiration );
 510
 511         return $found_themes;
 512 }
 513
 514 /**
 515  * Retrieve path to themes directory.
 516  *
 517  * Does not have trailing slash.
 518  *
 519  * @since 1.5.0
 520  *
 521  * @param string $stylesheet_or_template The stylesheet or template name of the theme
 522  * @return string Theme path.
 523  */
 524 function get_theme_root( $stylesheet_or_template = false ) {
 525         global $wp_theme_directories;
 526
 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;
 532         } else {
 533                 $theme_root = WP_CONTENT_DIR . '/themes';
 534         }
 535
 536         /**
 537          * Filter the absolute path to the themes directory.
 538          *
 539          * @since 1.5.0
 540          *
 541          * @param string $theme_root Absolute path to themes directory.
 542          */
 543         return apply_filters( 'theme_root', $theme_root );
 544 }
 545
 546 /**
 547  * Retrieve URI for themes directory.
 548  *
 549  * Does not have trailing slash.
 550  *
 551  * @since 1.5.0
 552  *
 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.
 558  */
 559 function get_theme_root_uri( $stylesheet_or_template = false, $theme_root = false ) {
 560         global $wp_theme_directories;
 561
 562         if ( $stylesheet_or_template && ! $theme_root )
 563                 $theme_root = get_raw_theme_root( $stylesheet_or_template );
 564
 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 );
 574                         else
 575                                 $theme_root_uri = $theme_root;
 576                 } else {
 577                         $theme_root_uri = content_url( $theme_root );
 578                 }
 579         } else {
 580                 $theme_root_uri = content_url( 'themes' );
 581         }
 582
 583         /**
 584          * Filter the URI for themes directory.
 585          *
 586          * @since 1.5.0
 587          *
 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.
 591          */
 592         return apply_filters( 'theme_root_uri', $theme_root_uri, get_option( 'siteurl' ), $stylesheet_or_template );
 593 }
 594
 595 /**
 596  * Get the raw theme root relative to the content directory with no filters applied.
 597  *
 598  * @since 3.1.0
 599  *
 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
 603  */
 604 function get_raw_theme_root( $stylesheet_or_template, $skip_cache = false ) {
 605         global $wp_theme_directories;
 606
 607         if ( count($wp_theme_directories) <= 1 )
 608                 return '/themes';
 609
 610         $theme_root = false;
 611
 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');
 618         }
 619
 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];
 624         }
 625
 626         return $theme_root;
 627 }
 628
 629 /**
 630  * Display localized stylesheet link element.
 631  *
 632  * @since 2.1.0
 633  */
 634 function locale_stylesheet() {
 635         $stylesheet = get_locale_stylesheet_uri();
 636         if ( empty($stylesheet) )
 637                 return;
 638         echo '<link rel="stylesheet" href="' . $stylesheet . '" type="text/css" media="screen" />';
 639 }
 640
 641 /**
 642  * Start preview theme output buffer.
 643  *
 644  * Will only perform task if the user has permissions and template and preview
 645  * query variables exist.
 646  *
 647  * @since 2.6.0
 648  */
 649 function preview_theme() {
 650         if ( ! (isset($_GET['template']) && isset($_GET['preview'])) )
 651                 return;
 652
 653         if ( !current_user_can( 'switch_themes' ) )
 654                 return;
 655
 656         // Admin Thickbox requests
 657         if ( isset( $_GET['preview_iframe'] ) )
 658                 show_admin_bar( false );
 659
 660         $_GET['template'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['template']);
 661
 662         if ( validate_file($_GET['template']) )
 663                 return;
 664
 665         add_filter( 'template', '_preview_theme_template_filter' );
 666
 667         if ( isset($_GET['stylesheet']) ) {
 668                 $_GET['stylesheet'] = preg_replace('|[^a-z0-9_./-]|i', '', $_GET['stylesheet']);
 669                 if ( validate_file($_GET['stylesheet']) )
 670                         return;
 671                 add_filter( 'stylesheet', '_preview_theme_stylesheet_filter' );
 672         }
 673
 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' );
 676
 677         ob_start( 'preview_theme_ob_filter' );
 678 }
 679
 680 /**
 681  * Private function to modify the current template when previewing a theme
 682  *
 683  * @since 2.9.0
 684  * @access private
 685  *
 686  * @return string
 687  */
 688 function _preview_theme_template_filter() {
 689         return isset($_GET['template']) ? $_GET['template'] : '';
 690 }
 691
 692 /**
 693  * Private function to modify the current stylesheet when previewing a theme
 694  *
 695  * @since 2.9.0
 696  * @access private
 697  *
 698  * @return string
 699  */
 700 function _preview_theme_stylesheet_filter() {
 701         return isset($_GET['stylesheet']) ? $_GET['stylesheet'] : '';
 702 }
 703
 704 /**
 705  * Callback function for ob_start() to capture all links in the theme.
 706  *
 707  * @since 2.6.0
 708  * @access private
 709  *
 710  * @param string $content
 711  * @return string
 712  */
 713 function preview_theme_ob_filter( $content ) {
 714         return preg_replace_callback( "|(<a.*?href=([\"']))(.*?)([\"'].*?>)|", 'preview_theme_ob_filter_callback', $content );
 715 }
 716
 717 /**
 718  * Manipulates preview theme links in order to control and maintain location.
 719  *
 720  * Callback function for preg_replace_callback() to accept and filter matches.
 721  *
 722  * @since 2.6.0
 723  * @access private
 724  *
 725  * @param array $matches
 726  * @return string
 727  */
 728 function preview_theme_ob_filter_callback( $matches ) {
 729         if ( strpos($matches[4], 'onclick') !== false )
 730                 $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.
 731         if (
 732                 ( false !== strpos($matches[3], '/wp-admin/') )
 733         ||
 734                 ( false !== strpos( $matches[3], '://' ) && 0 !== strpos( $matches[3], home_url() ) )
 735         ||
 736                 ( false !== strpos($matches[3], '/feed/') )
 737         ||
 738                 ( false !== strpos($matches[3], '/trackback/') )
 739         )
 740                 return $matches[1] . "#$matches[2] onclick=$matches[2]return false;" . $matches[4];
 741
 742         $stylesheet = isset( $_GET['stylesheet'] ) ? $_GET['stylesheet'] : '';
 743         $template   = isset( $_GET['template'] )   ? $_GET['template']   : '';
 744
 745         $link = add_query_arg( array( 'preview' => 1, 'template' => $template, 'stylesheet' => $stylesheet, 'preview_iframe' => 1 ), $matches[3] );
 746         if ( 0 === strpos($link, 'preview=1') )
 747                 $link = "?$link";
 748         return $matches[1] . esc_attr( $link ) . $matches[4];
 749 }
 750
 751 /**
 752  * Switches the theme.
 753  *
 754  * Accepts one argument: $stylesheet of the theme. It also accepts an additional function signature
 755  * of two arguments: $template then $stylesheet. This is for backwards compatibility.
 756  *
 757  * @since 2.5.0
 758  *
 759  * @param string $stylesheet Stylesheet name
 760  */
 761 function switch_theme( $stylesheet ) {
 762         global $wp_theme_directories, $wp_customize, $sidebars_widgets;
 763
 764         $_sidebars_widgets = null;
 765         if ( 'wp_ajax_customize_save' === current_action() ) {
 766                 $_sidebars_widgets = $wp_customize->post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) );
 767         } elseif ( is_array( $sidebars_widgets ) ) {
 768                 $_sidebars_widgets = $sidebars_widgets;
 769         }
 770
 771         if ( is_array( $_sidebars_widgets ) ) {
 772                 set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) );
 773         }
 774
 775         $old_theme  = wp_get_theme();
 776         $new_theme = wp_get_theme( $stylesheet );
 777
 778         if ( func_num_args() > 1 ) {
 779                 $template = $stylesheet;
 780                 $stylesheet = func_get_arg( 1 );
 781         } else {
 782                 $template = $new_theme->get_template();
 783         }
 784
 785         update_option( 'template', $template );
 786         update_option( 'stylesheet', $stylesheet );
 787
 788         if ( count( $wp_theme_directories ) > 1 ) {
 789                 update_option( 'template_root', get_raw_theme_root( $template, true ) );
 790                 update_option( 'stylesheet_root', get_raw_theme_root( $stylesheet, true ) );
 791         } else {
 792                 delete_option( 'template_root' );
 793                 delete_option( 'stylesheet_root' );
 794         }
 795
 796         $new_name  = $new_theme->get('Name');
 797
 798         update_option( 'current_theme', $new_name );
 799
 800         // Migrate from the old mods_{name} option to theme_mods_{slug}.
 801         if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
 802                 $default_theme_mods = (array) get_option( 'mods_' . $new_name );
 803                 add_option( "theme_mods_$stylesheet", $default_theme_mods );
 804         } else {
 805                 /*
 806                  * Since retrieve_widgets() is called when initializing a theme in the Customizer,
 807                  * we need to to remove the theme mods to avoid overwriting changes made via
 808                  * the Customizer when accessing wp-admin/widgets.php.
 809                  */
 810                 if ( 'wp_ajax_customize_save' === current_action() ) {
 811                         remove_theme_mod( 'sidebars_widgets' );
 812                 }
 813         }
 814
 815         update_option( 'theme_switched', $old_theme->get_stylesheet() );
 816         /**
 817          * Fires after the theme is switched.
 818          *
 819          * @since 1.5.0
 820          *
 821          * @param string   $new_name  Name of the new theme.
 822          * @param WP_Theme $new_theme WP_Theme instance of the new theme.
 823          */
 824         do_action( 'switch_theme', $new_name, $new_theme );
 825 }
 826
 827 /**
 828  * Checks that current theme files 'index.php' and 'style.css' exists.
 829  *
 830  * Does not check the default theme, which is the fallback and should always exist.
 831  * Will switch theme to the fallback theme if current theme does not validate.
 832  * You can use the 'validate_current_theme' filter to return false to
 833  * disable this functionality.
 834  *
 835  * @since 1.5.0
 836  * @see WP_DEFAULT_THEME
 837  *
 838  * @return bool
 839  */
 840 function validate_current_theme() {
 841         /**
 842          * Filter whether to validate the current theme.
 843          *
 844          * @since 2.7.0
 845          *
 846          * @param bool true Validation flag to check the current theme.
 847          */
 848         if ( defined('WP_INSTALLING') || ! apply_filters( 'validate_current_theme', true ) )
 849                 return true;
 850
 851         if ( get_template() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/index.php') ) {
 852                 switch_theme( WP_DEFAULT_THEME );
 853                 return false;
 854         }
 855
 856         if ( get_stylesheet() != WP_DEFAULT_THEME && !file_exists(get_template_directory() . '/style.css') ) {
 857                 switch_theme( WP_DEFAULT_THEME );
 858                 return false;
 859         }
 860
 861         if ( is_child_theme() && ! file_exists( get_stylesheet_directory() . '/style.css' ) ) {
 862                 switch_theme( WP_DEFAULT_THEME );
 863                 return false;
 864         }
 865
 866         return true;
 867 }
 868
 869 /**
 870  * Retrieve all theme modifications.
 871  *
 872  * @since 3.1.0
 873  *
 874  * @return array|null Theme modifications.
 875  */
 876 function get_theme_mods() {
 877         $theme_slug = get_option( 'stylesheet' );
 878         if ( false === ( $mods = get_option( "theme_mods_$theme_slug" ) ) ) {
 879                 $theme_name = get_option( 'current_theme' );
 880                 if ( false === $theme_name )
 881                         $theme_name = wp_get_theme()->get('Name');
 882                 $mods = get_option( "mods_$theme_name" ); // Deprecated location.
 883                 if ( is_admin() && false !== $mods ) {
 884                         update_option( "theme_mods_$theme_slug", $mods );
 885                         delete_option( "mods_$theme_name" );
 886                 }
 887         }
 888         return $mods;
 889 }
 890
 891 /**
 892  * Retrieve theme modification value for the current theme.
 893  *
 894  * If the modification name does not exist, then the $default will be passed
 895  * through {@link http://php.net/sprintf sprintf()} PHP function with the first
 896  * string the template directory URI and the second string the stylesheet
 897  * directory URI.
 898  *
 899  * @since 2.1.0
 900  *
 901  * @param string $name Theme modification name.
 902  * @param bool|string $default
 903  * @return string
 904  */
 905 function get_theme_mod( $name, $default = false ) {
 906         $mods = get_theme_mods();
 907
 908         if ( isset( $mods[$name] ) ) {
 909                 /**
 910                  * Filter the theme modification, or 'theme_mod', value.
 911                  *
 912                  * The dynamic portion of the hook name, `$name`, refers to
 913                  * the key name of the modification array. For example,
 914                  * 'header_textcolor', 'header_image', and so on depending
 915                  * on the theme options.
 916                  *
 917                  * @since 2.2.0
 918                  *
 919                  * @param string $current_mod The value of the current theme modification.
 920                  */
 921                 return apply_filters( "theme_mod_{$name}", $mods[$name] );
 922         }
 923
 924         if ( is_string( $default ) )
 925                 $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
 926
 927         /** This filter is documented in wp-includes/theme.php */
 928         return apply_filters( "theme_mod_{$name}", $default );
 929 }
 930
 931 /**
 932  * Update theme modification value for the current theme.
 933  *
 934  * @since 2.1.0
 935  *
 936  * @param string $name Theme modification name.
 937  * @param mixed  $value theme modification value.
 938  */
 939 function set_theme_mod( $name, $value ) {
 940         $mods = get_theme_mods();
 941         $old_value = isset( $mods[ $name ] ) ? $mods[ $name ] : false;
 942
 943         /**
 944          * Filter the theme mod value on save.
 945          *
 946          * The dynamic portion of the hook name, `$name`, refers to the key name of
 947          * the modification array. For example, 'header_textcolor', 'header_image',
 948          * and so on depending on the theme options.
 949          *
 950          * @since 3.9.0
 951          *
 952          * @param string $value     The new value of the theme mod.
 953          * @param string $old_value The current value of the theme mod.
 954          */
 955         $mods[ $name ] = apply_filters( "pre_set_theme_mod_$name", $value, $old_value );
 956
 957         $theme = get_option( 'stylesheet' );
 958         update_option( "theme_mods_$theme", $mods );
 959 }
 960
 961 /**
 962  * Remove theme modification name from current theme list.
 963  *
 964  * If removing the name also removes all elements, then the entire option will
 965  * be removed.
 966  *
 967  * @since 2.1.0
 968  *
 969  * @param string $name Theme modification name.
 970  * @return null
 971  */
 972 function remove_theme_mod( $name ) {
 973         $mods = get_theme_mods();
 974
 975         if ( ! isset( $mods[ $name ] ) )
 976                 return;
 977
 978         unset( $mods[ $name ] );
 979
 980         if ( empty( $mods ) )
 981                 return remove_theme_mods();
 982
 983         $theme = get_option( 'stylesheet' );
 984         update_option( "theme_mods_$theme", $mods );
 985 }
 986
 987 /**
 988  * Remove theme modifications option for current theme.
 989  *
 990  * @since 2.1.0
 991  */
 992 function remove_theme_mods() {
 993         delete_option( 'theme_mods_' . get_option( 'stylesheet' ) );
 994
 995         // Old style.
 996         $theme_name = get_option( 'current_theme' );
 997         if ( false === $theme_name )
 998                 $theme_name = wp_get_theme()->get('Name');
 999         delete_option( 'mods_' . $theme_name );
1000 }
1001
1002 /**
1003  * Retrieve text color for custom header.
1004  *
1005  * @since 2.1.0
1006  *
1007  * @return string
1008  */
1009 function get_header_textcolor() {
1010         return get_theme_mod('header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
1011 }
1012
1013 /**
1014  * Display text color for custom header.
1015  *
1016  * @since 2.1.0
1017  */
1018 function header_textcolor() {
1019         echo get_header_textcolor();
1020 }
1021
1022 /**
1023  * Whether to display the header text.
1024  *
1025  * @since 3.4.0
1026  *
1027  * @return bool
1028  */
1029 function display_header_text() {
1030         if ( ! current_theme_supports( 'custom-header', 'header-text' ) )
1031                 return false;
1032
1033         $text_color = get_theme_mod( 'header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
1034         return 'blank' != $text_color;
1035 }
1036
1037 /**
1038  * Check whether a header image is set or not.
1039  *
1040  * @since 4.2.0
1041  *
1042  * @see get_header_image()
1043  *
1044  * @return bool Whether a header image is set or not.
1045  */
1046 function has_header_image() {
1047         return (bool) get_header_image();
1048 }
1049
1050 /**
1051  * Retrieve header image for custom header.
1052  *
1053  * @since 2.1.0
1054  *
1055  * @return string|false
1056  */
1057 function get_header_image() {
1058         $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
1059
1060         if ( 'remove-header' == $url )
1061                 return false;
1062
1063         if ( is_random_header_image() )
1064                 $url = get_random_header_image();
1065
1066         return esc_url_raw( set_url_scheme( $url ) );
1067 }
1068
1069 /**
1070  * Get random header image data from registered images in theme.
1071  *
1072  * @since 3.4.0
1073  *
1074  * @access private
1075  *
1076  * @return string Path to header image
1077  */
1078
1079 function _get_random_header_data() {
1080         static $_wp_random_header;
1081
1082         if ( empty( $_wp_random_header ) ) {
1083                 global $_wp_default_headers;
1084                 $header_image_mod = get_theme_mod( 'header_image', '' );
1085                 $headers = array();
1086
1087                 if ( 'random-uploaded-image' == $header_image_mod )
1088                         $headers = get_uploaded_header_images();
1089                 elseif ( ! empty( $_wp_default_headers ) ) {
1090                         if ( 'random-default-image' == $header_image_mod ) {
1091                                 $headers = $_wp_default_headers;
1092                         } else {
1093                                 if ( current_theme_supports( 'custom-header', 'random-default' ) )
1094                                         $headers = $_wp_default_headers;
1095                         }
1096                 }
1097
1098                 if ( empty( $headers ) )
1099                         return new stdClass;
1100
1101                 $_wp_random_header = (object) $headers[ array_rand( $headers ) ];
1102
1103                 $_wp_random_header->url =  sprintf( $_wp_random_header->url, get_template_directory_uri(), get_stylesheet_directory_uri() );
1104                 $_wp_random_header->thumbnail_url =  sprintf( $_wp_random_header->thumbnail_url, get_template_directory_uri(), get_stylesheet_directory_uri() );
1105         }
1106         return $_wp_random_header;
1107 }
1108
1109 /**
1110  * Get random header image url from registered images in theme.
1111  *
1112  * @since 3.2.0
1113  *
1114  * @return string Path to header image
1115  */
1116
1117 function get_random_header_image() {
1118         $random_image = _get_random_header_data();
1119         if ( empty( $random_image->url ) )
1120                 return '';
1121         return $random_image->url;
1122 }
1123
1124 /**
1125  * Check if random header image is in use.
1126  *
1127  * Always true if user expressly chooses the option in Appearance > Header.
1128  * Also true if theme has multiple header images registered, no specific header image
1129  * is chosen, and theme turns on random headers with add_theme_support().
1130  *
1131  * @since 3.2.0
1132  *
1133  * @param string $type The random pool to use. any|default|uploaded
1134  * @return boolean
1135  */
1136 function is_random_header_image( $type = 'any' ) {
1137         $header_image_mod = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
1138
1139         if ( 'any' == $type ) {
1140                 if ( 'random-default-image' == $header_image_mod || 'random-uploaded-image' == $header_image_mod || ( '' != get_random_header_image() && empty( $header_image_mod ) ) )
1141                         return true;
1142         } else {
1143                 if ( "random-$type-image" == $header_image_mod )
1144                         return true;
1145                 elseif ( 'default' == $type && empty( $header_image_mod ) && '' != get_random_header_image() )
1146                         return true;
1147         }
1148
1149         return false;
1150 }
1151
1152 /**
1153  * Display header image URL.
1154  *
1155  * @since 2.1.0
1156  */
1157 function header_image() {
1158         $image = get_header_image();
1159         if ( $image ) {
1160                 echo esc_url( $image );
1161         }
1162 }
1163
1164 /**
1165  * Get the header images uploaded for the current theme.
1166  *
1167  * @since 3.2.0
1168  *
1169  * @return array
1170  */
1171 function get_uploaded_header_images() {
1172         $header_images = array();
1173
1174         // @todo caching
1175         $headers = get_posts( array( 'post_type' => 'attachment', 'meta_key' => '_wp_attachment_is_custom_header', 'meta_value' => get_option('stylesheet'), 'orderby' => 'none', 'nopaging' => true ) );
1176
1177         if ( empty( $headers ) )
1178                 return array();
1179
1180         foreach ( (array) $headers as $header ) {
1181                 $url = esc_url_raw( wp_get_attachment_url( $header->ID ) );
1182                 $header_data = wp_get_attachment_metadata( $header->ID );
1183                 $header_index = basename($url);
1184                 $header_images[$header_index] = array();
1185                 $header_images[$header_index]['attachment_id'] =  $header->ID;
1186                 $header_images[$header_index]['url'] =  $url;
1187                 $header_images[$header_index]['thumbnail_url'] =  $url;
1188                 if ( isset( $header_data['width'] ) )
1189                         $header_images[$header_index]['width'] = $header_data['width'];
1190                 if ( isset( $header_data['height'] ) )
1191                         $header_images[$header_index]['height'] = $header_data['height'];
1192         }
1193
1194         return $header_images;
1195 }
1196
1197 /**
1198  * Get the header image data.
1199  *
1200  * @since 3.4.0
1201  *
1202  * @return object
1203  */
1204 function get_custom_header() {
1205         global $_wp_default_headers;
1206
1207         if ( is_random_header_image() ) {
1208                 $data = _get_random_header_data();
1209         } else {
1210                 $data = get_theme_mod( 'header_image_data' );
1211                 if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) {
1212                         $directory_args = array( get_template_directory_uri(), get_stylesheet_directory_uri() );
1213                         $data = array();
1214                         $data['url'] = $data['thumbnail_url'] = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args );
1215                         if ( ! empty( $_wp_default_headers ) ) {
1216                                 foreach ( (array) $_wp_default_headers as $default_header ) {
1217                                         $url = vsprintf( $default_header['url'], $directory_args );
1218                                         if ( $data['url'] == $url ) {
1219                                                 $data = $default_header;
1220                                                 $data['url'] = $url;
1221                                                 $data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args );
1222                                                 break;
1223                                         }
1224                                 }
1225                         }
1226                 }
1227         }
1228
1229         $default = array(
1230                 'url'           => '',
1231                 'thumbnail_url' => '',
1232                 'width'         => get_theme_support( 'custom-header', 'width' ),
1233                 'height'        => get_theme_support( 'custom-header', 'height' ),
1234         );
1235         return (object) wp_parse_args( $data, $default );
1236 }
1237
1238 /**
1239  * Register a selection of default headers to be displayed by the custom header admin UI.
1240  *
1241  * @since 3.0.0
1242  *
1243  * @param array $headers Array of headers keyed by a string id. The ids point to arrays containing 'url', 'thumbnail_url', and 'description' keys.
1244  */
1245 function register_default_headers( $headers ) {
1246         global $_wp_default_headers;
1247
1248         $_wp_default_headers = array_merge( (array) $_wp_default_headers, (array) $headers );
1249 }
1250
1251 /**
1252  * Unregister default headers.
1253  *
1254  * This function must be called after register_default_headers() has already added the
1255  * header you want to remove.
1256  *
1257  * @see register_default_headers()
1258  * @since 3.0.0
1259  *
1260  * @param string|array $header The header string id (key of array) to remove, or an array thereof.
1261  * @return bool|void A single header returns true on success, false on failure.
1262  *                   There is currently no return value for multiple headers.
1263  */
1264 function unregister_default_headers( $header ) {
1265         global $_wp_default_headers;
1266         if ( is_array( $header ) ) {
1267                 array_map( 'unregister_default_headers', $header );
1268         } elseif ( isset( $_wp_default_headers[ $header ] ) ) {
1269                 unset( $_wp_default_headers[ $header ] );
1270                 return true;
1271         } else {
1272                 return false;
1273         }
1274 }
1275
1276 /**
1277  * Retrieve background image for custom background.
1278  *
1279  * @since 3.0.0
1280  *
1281  * @return string
1282  */
1283 function get_background_image() {
1284         return get_theme_mod('background_image', get_theme_support( 'custom-background', 'default-image' ) );
1285 }
1286
1287 /**
1288  * Display background image path.
1289  *
1290  * @since 3.0.0
1291  */
1292 function background_image() {
1293         echo get_background_image();
1294 }
1295
1296 /**
1297  * Retrieve value for custom background color.
1298  *
1299  * @since 3.0.0
1300  *
1301  * @return string
1302  */
1303 function get_background_color() {
1304         return get_theme_mod('background_color', get_theme_support( 'custom-background', 'default-color' ) );
1305 }
1306
1307 /**
1308  * Display background color value.
1309  *
1310  * @since 3.0.0
1311  */
1312 function background_color() {
1313         echo get_background_color();
1314 }
1315
1316 /**
1317  * Default custom background callback.
1318  *
1319  * @since 3.0.0
1320  * @access protected
1321  */
1322 function _custom_background_cb() {
1323         // $background is the saved custom image, or the default image.
1324         $background = set_url_scheme( get_background_image() );
1325
1326         // $color is the saved custom color.
1327         // A default has to be specified in style.css. It will not be printed here.
1328         $color = get_background_color();
1329
1330         if ( $color === get_theme_support( 'custom-background', 'default-color' ) ) {
1331                 $color = false;
1332         }
1333
1334         if ( ! $background && ! $color )
1335                 return;
1336
1337         $style = $color ? "background-color: #$color;" : '';
1338
1339         if ( $background ) {
1340                 $image = " background-image: url('$background');";
1341
1342                 $repeat = get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) );
1343                 if ( ! in_array( $repeat, array( 'no-repeat', 'repeat-x', 'repeat-y', 'repeat' ) ) )
1344                         $repeat = 'repeat';
1345                 $repeat = " background-repeat: $repeat;";
1346
1347                 $position = get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
1348                 if ( ! in_array( $position, array( 'center', 'right', 'left' ) ) )
1349                         $position = 'left';
1350                 $position = " background-position: top $position;";
1351
1352                 $attachment = get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) );
1353                 if ( ! in_array( $attachment, array( 'fixed', 'scroll' ) ) )
1354                         $attachment = 'scroll';
1355                 $attachment = " background-attachment: $attachment;";
1356
1357                 $style .= $image . $repeat . $position . $attachment;
1358         }
1359 ?>
1360 <style type="text/css" id="custom-background-css">
1361 body.custom-background { <?php echo trim( $style ); ?> }
1362 </style>
1363 <?php
1364 }
1365
1366 /**
1367  * Add callback for custom TinyMCE editor stylesheets.
1368  *
1369  * The parameter $stylesheet is the name of the stylesheet, relative to
1370  * the theme root. It also accepts an array of stylesheets.
1371  * It is optional and defaults to 'editor-style.css'.
1372  *
1373  * This function automatically adds another stylesheet with -rtl prefix, e.g. editor-style-rtl.css.
1374  * If that file doesn't exist, it is removed before adding the stylesheet(s) to TinyMCE.
1375  * If an array of stylesheets is passed to add_editor_style(),
1376  * RTL is only added for the first stylesheet.
1377  *
1378  * Since version 3.4 the TinyMCE body has .rtl CSS class.
1379  * It is a better option to use that class and add any RTL styles to the main stylesheet.
1380  *
1381  * @since 3.0.0
1382  *
1383  * @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
1384  *      Defaults to 'editor-style.css'
1385  */
1386 function add_editor_style( $stylesheet = 'editor-style.css' ) {
1387
1388         add_theme_support( 'editor-style' );
1389
1390         if ( ! is_admin() )
1391                 return;
1392
1393         global $editor_styles;
1394         $editor_styles = (array) $editor_styles;
1395         $stylesheet    = (array) $stylesheet;
1396         if ( is_rtl() ) {
1397                 $rtl_stylesheet = str_replace('.css', '-rtl.css', $stylesheet[0]);
1398                 $stylesheet[] = $rtl_stylesheet;
1399         }
1400
1401         $editor_styles = array_merge( $editor_styles, $stylesheet );
1402 }
1403
1404 /**
1405  * Removes all visual editor stylesheets.
1406  *
1407  * @since 3.1.0
1408  *
1409  * @return bool True on success, false if there were no stylesheets to remove.
1410  */
1411 function remove_editor_styles() {
1412         if ( ! current_theme_supports( 'editor-style' ) )
1413                 return false;
1414         _remove_theme_support( 'editor-style' );
1415         if ( is_admin() )
1416                 $GLOBALS['editor_styles'] = array();
1417         return true;
1418 }
1419
1420 /**
1421  * Retrieve any registered editor stylesheets
1422  *
1423  * @since 4.0.0
1424  *
1425  * @global $editor_styles Registered editor stylesheets
1426  *
1427  * @return array If registered, a list of editor stylesheet URLs.
1428  */
1429 function get_editor_stylesheets() {
1430         $stylesheets = array();
1431         // load editor_style.css if the current theme supports it
1432         if ( ! empty( $GLOBALS['editor_styles'] ) && is_array( $GLOBALS['editor_styles'] ) ) {
1433                 $editor_styles = $GLOBALS['editor_styles'];
1434
1435                 $editor_styles = array_unique( array_filter( $editor_styles ) );
1436                 $style_uri = get_stylesheet_directory_uri();
1437                 $style_dir = get_stylesheet_directory();
1438
1439                 // Support externally referenced styles (like, say, fonts).
1440                 foreach ( $editor_styles as $key => $file ) {
1441                         if ( preg_match( '~^(https?:)?//~', $file ) ) {
1442                                 $stylesheets[] = esc_url_raw( $file );
1443                                 unset( $editor_styles[ $key ] );
1444                         }
1445                 }
1446
1447                 // Look in a parent theme first, that way child theme CSS overrides.
1448                 if ( is_child_theme() ) {
1449                         $template_uri = get_template_directory_uri();
1450                         $template_dir = get_template_directory();
1451
1452                         foreach ( $editor_styles as $key => $file ) {
1453                                 if ( $file && file_exists( "$template_dir/$file" ) ) {
1454                                         $stylesheets[] = "$template_uri/$file";
1455                                 }
1456                         }
1457                 }
1458
1459                 foreach ( $editor_styles as $file ) {
1460                         if ( $file && file_exists( "$style_dir/$file" ) ) {
1461                                 $stylesheets[] = "$style_uri/$file";
1462                         }
1463                 }
1464         }
1465         return $stylesheets;
1466 }
1467
1468 /**
1469  * Allows a theme to register its support of a certain feature
1470  *
1471  * Must be called in the theme's functions.php file to work.
1472  * If attached to a hook, it must be after_setup_theme.
1473  * The init hook may be too late for some features.
1474  *
1475  * @since 2.9.0
1476  *
1477  * @param string $feature The feature being added.
1478  * @return void|bool False on failure, void otherwise.
1479  */
1480 function add_theme_support( $feature ) {
1481         global $_wp_theme_features;
1482
1483         if ( func_num_args() == 1 )
1484                 $args = true;
1485         else
1486                 $args = array_slice( func_get_args(), 1 );
1487
1488         switch ( $feature ) {
1489                 case 'post-formats' :
1490                         if ( is_array( $args[0] ) ) {
1491                                 $post_formats = get_post_format_slugs();
1492                                 unset( $post_formats['standard'] );
1493
1494                                 $args[0] = array_intersect( $args[0], array_keys( $post_formats ) );
1495                         }
1496                         break;
1497
1498                 case 'html5' :
1499                         // You can't just pass 'html5', you need to pass an array of types.
1500                         if ( empty( $args[0] ) ) {
1501                                 // Build an array of types for back-compat.
1502                                 $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
1503                         } elseif ( ! is_array( $args[0] ) ) {
1504                                 _doing_it_wrong( "add_theme_support( 'html5' )", __( 'You need to pass an array of types.' ), '3.6.1' );
1505                                 return false;
1506                         }
1507
1508                         // Calling 'html5' again merges, rather than overwrites.
1509                         if ( isset( $_wp_theme_features['html5'] ) )
1510                                 $args[0] = array_merge( $_wp_theme_features['html5'][0], $args[0] );
1511                         break;
1512
1513                 case 'custom-header-uploads' :
1514                         return add_theme_support( 'custom-header', array( 'uploads' => true ) );
1515
1516                 case 'custom-header' :
1517                         if ( ! is_array( $args ) )
1518                                 $args = array( 0 => array() );
1519
1520                         $defaults = array(
1521                                 'default-image' => '',
1522                                 'random-default' => false,
1523                                 'width' => 0,
1524                                 'height' => 0,
1525                                 'flex-height' => false,
1526                                 'flex-width' => false,
1527                                 'default-text-color' => '',
1528                                 'header-text' => true,
1529                                 'uploads' => true,
1530                                 'wp-head-callback' => '',
1531                                 'admin-head-callback' => '',
1532                                 'admin-preview-callback' => '',
1533                         );
1534
1535                         $jit = isset( $args[0]['__jit'] );
1536                         unset( $args[0]['__jit'] );
1537
1538                         // Merge in data from previous add_theme_support() calls.
1539                         // The first value registered wins. (A child theme is set up first.)
1540                         if ( isset( $_wp_theme_features['custom-header'] ) )
1541                                 $args[0] = wp_parse_args( $_wp_theme_features['custom-header'][0], $args[0] );
1542
1543                         // Load in the defaults at the end, as we need to insure first one wins.
1544                         // This will cause all constants to be defined, as each arg will then be set to the default.
1545                         if ( $jit )
1546                                 $args[0] = wp_parse_args( $args[0], $defaults );
1547
1548                         // If a constant was defined, use that value. Otherwise, define the constant to ensure
1549                         // the constant is always accurate (and is not defined later,  overriding our value).
1550                         // As stated above, the first value wins.
1551                         // Once we get to wp_loaded (just-in-time), define any constants we haven't already.
1552                         // Constants are lame. Don't reference them. This is just for backwards compatibility.
1553
1554                         if ( defined( 'NO_HEADER_TEXT' ) )
1555                                 $args[0]['header-text'] = ! NO_HEADER_TEXT;
1556                         elseif ( isset( $args[0]['header-text'] ) )
1557                                 define( 'NO_HEADER_TEXT', empty( $args[0]['header-text'] ) );
1558
1559                         if ( defined( 'HEADER_IMAGE_WIDTH' ) )
1560                                 $args[0]['width'] = (int) HEADER_IMAGE_WIDTH;
1561                         elseif ( isset( $args[0]['width'] ) )
1562                                 define( 'HEADER_IMAGE_WIDTH', (int) $args[0]['width'] );
1563
1564                         if ( defined( 'HEADER_IMAGE_HEIGHT' ) )
1565                                 $args[0]['height'] = (int) HEADER_IMAGE_HEIGHT;
1566                         elseif ( isset( $args[0]['height'] ) )
1567                                 define( 'HEADER_IMAGE_HEIGHT', (int) $args[0]['height'] );
1568
1569                         if ( defined( 'HEADER_TEXTCOLOR' ) )
1570                                 $args[0]['default-text-color'] = HEADER_TEXTCOLOR;
1571                         elseif ( isset( $args[0]['default-text-color'] ) )
1572                                 define( 'HEADER_TEXTCOLOR', $args[0]['default-text-color'] );
1573
1574                         if ( defined( 'HEADER_IMAGE' ) )
1575                                 $args[0]['default-image'] = HEADER_IMAGE;
1576                         elseif ( isset( $args[0]['default-image'] ) )
1577                                 define( 'HEADER_IMAGE', $args[0]['default-image'] );
1578
1579                         if ( $jit && ! empty( $args[0]['default-image'] ) )
1580                                 $args[0]['random-default'] = false;
1581
1582                         // If headers are supported, and we still don't have a defined width or height,
1583                         // we have implicit flex sizes.
1584                         if ( $jit ) {
1585                                 if ( empty( $args[0]['width'] ) && empty( $args[0]['flex-width'] ) )
1586                                         $args[0]['flex-width'] = true;
1587                                 if ( empty( $args[0]['height'] ) && empty( $args[0]['flex-height'] ) )
1588                                         $args[0]['flex-height'] = true;
1589                         }
1590
1591                         break;
1592
1593                 case 'custom-background' :
1594                         if ( ! is_array( $args ) )
1595                                 $args = array( 0 => array() );
1596
1597                         $defaults = array(
1598                                 'default-image'          => '',
1599                                 'default-repeat'         => 'repeat',
1600                                 'default-position-x'     => 'left',
1601                                 'default-attachment'     => 'scroll',
1602                                 'default-color'          => '',
1603                                 'wp-head-callback'       => '_custom_background_cb',
1604                                 'admin-head-callback'    => '',
1605                                 'admin-preview-callback' => '',
1606                         );
1607
1608                         $jit = isset( $args[0]['__jit'] );
1609                         unset( $args[0]['__jit'] );
1610
1611                         // Merge in data from previous add_theme_support() calls. The first value registered wins.
1612                         if ( isset( $_wp_theme_features['custom-background'] ) )
1613                                 $args[0] = wp_parse_args( $_wp_theme_features['custom-background'][0], $args[0] );
1614
1615                         if ( $jit )
1616                                 $args[0] = wp_parse_args( $args[0], $defaults );
1617
1618                         if ( defined( 'BACKGROUND_COLOR' ) )
1619                                 $args[0]['default-color'] = BACKGROUND_COLOR;
1620                         elseif ( isset( $args[0]['default-color'] ) || $jit )
1621                                 define( 'BACKGROUND_COLOR', $args[0]['default-color'] );
1622
1623                         if ( defined( 'BACKGROUND_IMAGE' ) )
1624                                 $args[0]['default-image'] = BACKGROUND_IMAGE;
1625                         elseif ( isset( $args[0]['default-image'] ) || $jit )
1626                                 define( 'BACKGROUND_IMAGE', $args[0]['default-image'] );
1627
1628                         break;
1629
1630                 // Ensure that 'title-tag' is accessible in the admin.
1631                 case 'title-tag' :
1632                         // Can be called in functions.php but must happen before wp_loaded, i.e. not in header.php.
1633                         if ( did_action( 'wp_loaded' ) ) {
1634                                 /* translators: 1: Theme support 2: hook name */
1635                                 _doing_it_wrong( "add_theme_support( 'title-tag' )", sprintf( __( 'Theme support for %1$s should be registered before the %2$s hook.' ),
1636                                         '<code>title-tag</code>', '<code>wp_loaded</code>' ), '4.1' );
1637
1638                                 return false;
1639                         }
1640         }
1641
1642         $_wp_theme_features[ $feature ] = $args;
1643 }
1644
1645 /**
1646  * Registers the internal custom header and background routines.
1647  *
1648  * @since 3.4.0
1649  * @access private
1650  */
1651 function _custom_header_background_just_in_time() {
1652         global $custom_image_header, $custom_background;
1653
1654         if ( current_theme_supports( 'custom-header' ) ) {
1655                 // In case any constants were defined after an add_custom_image_header() call, re-run.
1656                 add_theme_support( 'custom-header', array( '__jit' => true ) );
1657
1658                 $args = get_theme_support( 'custom-header' );
1659                 if ( $args[0]['wp-head-callback'] )
1660                         add_action( 'wp_head', $args[0]['wp-head-callback'] );
1661
1662                 if ( is_admin() ) {
1663                         require_once( ABSPATH . 'wp-admin/custom-header.php' );
1664                         $custom_image_header = new Custom_Image_Header( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
1665                 }
1666         }
1667
1668         if ( current_theme_supports( 'custom-background' ) ) {
1669                 // In case any constants were defined after an add_custom_background() call, re-run.
1670                 add_theme_support( 'custom-background', array( '__jit' => true ) );
1671
1672                 $args = get_theme_support( 'custom-background' );
1673                 add_action( 'wp_head', $args[0]['wp-head-callback'] );
1674
1675                 if ( is_admin() ) {
1676                         require_once( ABSPATH . 'wp-admin/custom-background.php' );
1677                         $custom_background = new Custom_Background( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
1678                 }
1679         }
1680 }
1681
1682 /**
1683  * Gets the theme support arguments passed when registering that support
1684  *
1685  * @since 3.1.0
1686  *
1687  * @param string $feature the feature to check
1688  * @return mixed The array of extra arguments or the value for the registered feature.
1689  */
1690 function get_theme_support( $feature ) {
1691         global $_wp_theme_features;
1692         if ( ! isset( $_wp_theme_features[ $feature ] ) )
1693                 return false;
1694
1695         if ( func_num_args() <= 1 )
1696                 return $_wp_theme_features[ $feature ];
1697
1698         $args = array_slice( func_get_args(), 1 );
1699         switch ( $feature ) {
1700                 case 'custom-header' :
1701                 case 'custom-background' :
1702                         if ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) )
1703                                 return $_wp_theme_features[ $feature ][0][ $args[0] ];
1704                         return false;
1705
1706                 default :
1707                         return $_wp_theme_features[ $feature ];
1708         }
1709 }
1710
1711 /**
1712  * Allows a theme to de-register its support of a certain feature
1713  *
1714  * Should be called in the theme's functions.php file. Generally would
1715  * be used for child themes to override support from the parent theme.
1716  *
1717  * @since 3.0.0
1718  * @see add_theme_support()
1719  * @param string $feature the feature being added
1720  * @return null|bool Whether feature was removed.
1721  */
1722 function remove_theme_support( $feature ) {
1723         // Blacklist: for internal registrations not used directly by themes.
1724         if ( in_array( $feature, array( 'editor-style', 'widgets', 'menus' ) ) )
1725                 return false;
1726
1727         return _remove_theme_support( $feature );
1728 }
1729
1730 /**
1731  * Do not use. Removes theme support internally, ignorant of the blacklist.
1732  *
1733  * @access private
1734  * @since 3.1.0
1735  * @param string $feature
1736  */
1737 function _remove_theme_support( $feature ) {
1738         global $_wp_theme_features;
1739
1740         switch ( $feature ) {
1741                 case 'custom-header-uploads' :
1742                         if ( ! isset( $_wp_theme_features['custom-header'] ) )
1743                                 return false;
1744                         add_theme_support( 'custom-header', array( 'uploads' => false ) );
1745                         return; // Do not continue - custom-header-uploads no longer exists.
1746         }
1747
1748         if ( ! isset( $_wp_theme_features[ $feature ] ) )
1749                 return false;
1750
1751         switch ( $feature ) {
1752                 case 'custom-header' :
1753                         if ( ! did_action( 'wp_loaded' ) )
1754                                 break;
1755                         $support = get_theme_support( 'custom-header' );
1756                         if ( $support[0]['wp-head-callback'] )
1757                                 remove_action( 'wp_head', $support[0]['wp-head-callback'] );
1758                         remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
1759                         unset( $GLOBALS['custom_image_header'] );
1760                         break;
1761
1762                 case 'custom-background' :
1763                         if ( ! did_action( 'wp_loaded' ) )
1764                                 break;
1765                         $support = get_theme_support( 'custom-background' );
1766                         remove_action( 'wp_head', $support[0]['wp-head-callback'] );
1767                         remove_action( 'admin_menu', array( $GLOBALS['custom_background'], 'init' ) );
1768                         unset( $GLOBALS['custom_background'] );
1769                         break;
1770         }
1771
1772         unset( $_wp_theme_features[ $feature ] );
1773         return true;
1774 }
1775
1776 /**
1777  * Checks a theme's support for a given feature
1778  *
1779  * @since 2.9.0
1780  * @param string $feature the feature being checked
1781  * @return boolean
1782  */
1783 function current_theme_supports( $feature ) {
1784         global $_wp_theme_features;
1785
1786         if ( 'custom-header-uploads' == $feature )
1787                 return current_theme_supports( 'custom-header', 'uploads' );
1788
1789         if ( !isset( $_wp_theme_features[$feature] ) )
1790                 return false;
1791
1792         if ( 'title-tag' == $feature ) {
1793                 // Don't confirm support unless called internally.
1794                 $trace = debug_backtrace();
1795                 if ( ! in_array( $trace[1]['function'], array( '_wp_render_title_tag', 'wp_title' ) ) ) {
1796                         return false;
1797                 }
1798         }
1799
1800         // If no args passed then no extra checks need be performed
1801         if ( func_num_args() <= 1 )
1802                 return true;
1803
1804         $args = array_slice( func_get_args(), 1 );
1805
1806         switch ( $feature ) {
1807                 case 'post-thumbnails':
1808                         // post-thumbnails can be registered for only certain content/post types by passing
1809                         // an array of types to add_theme_support(). If no array was passed, then
1810                         // any type is accepted
1811                         if ( true === $_wp_theme_features[$feature] )  // Registered for all types
1812                                 return true;
1813                         $content_type = $args[0];
1814                         return in_array( $content_type, $_wp_theme_features[$feature][0] );
1815
1816                 case 'html5':
1817                 case 'post-formats':
1818                         // specific post formats can be registered by passing an array of types to
1819                         // add_theme_support()
1820
1821                         // Specific areas of HTML5 support *must* be passed via an array to add_theme_support()
1822
1823                         $type = $args[0];
1824                         return in_array( $type, $_wp_theme_features[$feature][0] );
1825
1826                 case 'custom-header':
1827                 case 'custom-background' :
1828                         // specific custom header and background capabilities can be registered by passing
1829                         // an array to add_theme_support()
1830                         $header_support = $args[0];
1831                         return ( isset( $_wp_theme_features[$feature][0][$header_support] ) && $_wp_theme_features[$feature][0][$header_support] );
1832         }
1833
1834         /**
1835          * Filter whether the current theme supports a specific feature.
1836          *
1837          * The dynamic portion of the hook name, `$feature`, refers to the specific theme
1838          * feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
1839          * 'custom-header', 'menus', 'automatic-feed-links', and 'html5'.
1840          *
1841          * @since 3.4.0
1842          *
1843          * @param bool   true     Whether the current theme supports the given feature. Default true.
1844          * @param array  $args    Array of arguments for the feature.
1845          * @param string $feature The theme feature.
1846          */
1847         return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[$feature] );
1848 }
1849
1850 /**
1851  * Checks a theme's support for a given feature before loading the functions which implement it.
1852  *
1853  * @since 2.9.0
1854  *
1855  * @param string $feature The feature being checked.
1856  * @param string $include Path to the file.
1857  * @return bool True if the current theme supports the supplied feature, false otherwise.
1858  */
1859 function require_if_theme_supports( $feature, $include ) {
1860         if ( current_theme_supports( $feature ) ) {
1861                 require ( $include );
1862                 return true;
1863         }
1864         return false;
1865 }
1866
1867 /**
1868  * Checks an attachment being deleted to see if it's a header or background image.
1869  *
1870  * If true it removes the theme modification which would be pointing at the deleted
1871  * attachment
1872  *
1873  * @access private
1874  * @since 3.0.0
1875  * @param int $id the attachment id
1876  */
1877 function _delete_attachment_theme_mod( $id ) {
1878         $attachment_image = wp_get_attachment_url( $id );
1879         $header_image = get_header_image();
1880         $background_image = get_background_image();
1881
1882         if ( $header_image && $header_image == $attachment_image )
1883                 remove_theme_mod( 'header_image' );
1884
1885         if ( $background_image && $background_image == $attachment_image )
1886                 remove_theme_mod( 'background_image' );
1887 }
1888
1889 /**
1890  * Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load
1891  *
1892  * @since 3.3.0
1893  */
1894 function check_theme_switched() {
1895         if ( $stylesheet = get_option( 'theme_switched' ) ) {
1896                 $old_theme = wp_get_theme( $stylesheet );
1897
1898                 // Prevent retrieve_widgets() from running since Customizer already called it up front
1899                 if ( get_option( 'theme_switched_via_customizer' ) ) {
1900                         remove_action( 'after_switch_theme', '_wp_sidebars_changed' );
1901                         update_option( 'theme_switched_via_customizer', false );
1902                 }
1903
1904                 if ( $old_theme->exists() ) {
1905                         /**
1906                          * Fires on the first WP load after a theme switch if the old theme still exists.
1907                          *
1908                          * This action fires multiple times and the parameters differs
1909                          * according to the context, if the old theme exists or not.
1910                          * If the old theme is missing, the parameter will be the slug
1911                          * of the old theme.
1912                          *
1913                          * @since 3.3.0
1914                          *
1915                          * @param string   $old_name  Old theme name.
1916                          * @param WP_Theme $old_theme WP_Theme instance of the old theme.
1917                          */
1918                         do_action( 'after_switch_theme', $old_theme->get( 'Name' ), $old_theme );
1919                 } else {
1920                         /** This action is documented in wp-includes/theme.php */
1921                         do_action( 'after_switch_theme', $stylesheet );
1922                 }
1923
1924                 update_option( 'theme_switched', false );
1925         }
1926 }
1927
1928 /**
1929  * Includes and instantiates the WP_Customize_Manager class.
1930  *
1931  * Fires when ?wp_customize=on or on wp-admin/customize.php.
1932  *
1933  * @since 3.4.0
1934  */
1935 function _wp_customize_include() {
1936         if ( ! ( ( isset( $_REQUEST['wp_customize'] ) && 'on' == $_REQUEST['wp_customize'] )
1937                 || ( is_admin() && 'customize.php' == basename( $_SERVER['PHP_SELF'] ) )
1938         ) )
1939                 return;
1940
1941         require( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
1942         // Init Customize class
1943         $GLOBALS['wp_customize'] = new WP_Customize_Manager;
1944 }
1945
1946 /**
1947  * Adds settings for the customize-loader script.
1948  *
1949  * @since 3.4.0
1950  */
1951 function _wp_customize_loader_settings() {
1952         global $wp_scripts;
1953
1954         $admin_origin = parse_url( admin_url() );
1955         $home_origin  = parse_url( home_url() );
1956         $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
1957
1958         $browser = array(
1959                 'mobile' => wp_is_mobile(),
1960                 'ios'    => wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] ),
1961         );
1962
1963         $settings = array(
1964                 'url'           => esc_url( admin_url( 'customize.php' ) ),
1965                 'isCrossDomain' => $cross_domain,
1966                 'browser'       => $browser,
1967                 'l10n'          => array(
1968                         'saveAlert'       => __( 'The changes you made will be lost if you navigate away from this page.' ),
1969                         'mainIframeTitle' => __( 'Customizer' ),
1970                 ),
1971         );
1972
1973         $script = 'var _wpCustomizeLoaderSettings = ' . wp_json_encode( $settings ) . ';';
1974
1975         $data = $wp_scripts->get_data( 'customize-loader', 'data' );
1976         if ( $data )
1977                 $script = "$data\n$script";
1978
1979         $wp_scripts->add_data( 'customize-loader', 'data', $script );
1980 }
1981
1982 /**
1983  * Returns a URL to load the Customizer.
1984  *
1985  * @since 3.4.0
1986  *
1987  * @param string $stylesheet Optional. Theme to customize. Defaults to current theme.
1988  *      The theme's stylesheet will be urlencoded if necessary.
1989  */
1990 function wp_customize_url( $stylesheet = null ) {
1991         $url = admin_url( 'customize.php' );
1992         if ( $stylesheet )
1993                 $url .= '?theme=' . urlencode( $stylesheet );
1994         return esc_url( $url );
1995 }
1996
1997 /**
1998  * Prints a script to check whether or not the Customizer is supported,
1999  * and apply either the no-customize-support or customize-support class
2000  * to the body.
2001  *
2002  * This function MUST be called inside the body tag.
2003  *
2004  * Ideally, call this function immediately after the body tag is opened.
2005  * This prevents a flash of unstyled content.
2006  *
2007  * It is also recommended that you add the "no-customize-support" class
2008  * to the body tag by default.
2009  *
2010  * @since 3.4.0
2011  */
2012 function wp_customize_support_script() {
2013         $admin_origin = parse_url( admin_url() );
2014         $home_origin  = parse_url( home_url() );
2015         $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) );
2016
2017         ?>
2018         <script type="text/javascript">
2019                 (function() {
2020                         var request, b = document.body, c = 'className', cs = 'customize-support', rcs = new RegExp('(^|\\s+)(no-)?'+cs+'(\\s+|$)');
2021
2022 <?php           if ( $cross_domain ): ?>
2023                         request = (function(){ var xhr = new XMLHttpRequest(); return ('withCredentials' in xhr); })();
2024 <?php           else: ?>
2025                         request = true;
2026 <?php           endif; ?>
2027
2028                         b[c] = b[c].replace( rcs, ' ' );
2029                         b[c] += ( window.postMessage && request ? ' ' : ' no-' ) + cs;
2030                 }());
2031         </script>
2032         <?php
2033 }
2034
2035 /**
2036  * Whether the site is being previewed in the Customizer.
2037  *
2038  * @since 4.0.0
2039  *
2040  * @global WP_Customize_Manager $wp_customize Customizer instance.
2041  *
2042  * @return bool True if the site is being previewed in the Customizer, false otherwise.
2043  */
2044 function is_customize_preview() {
2045         global $wp_customize;
2046
2047         return ( $wp_customize instanceof WP_Customize_Manager ) && $wp_customize->is_preview();
2048 }