[Summary view] [Print] [Text view]

   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   * @global string[] $wp_theme_directories
  18   *
  19   * @param array $args {
  20   *     Optional. The search arguments.
  21   *
  22   *     @type mixed $errors  True to return themes with errors, false to return
  23   *                          themes without errors, null to return all themes.
  24   *                          Default false.
  25   *     @type mixed $allowed (Multisite) True to return only allowed themes for a site.
  26   *                          False to return only disallowed themes for a site.
  27   *                          'site' to return only site-allowed themes.
  28   *                          'network' to return only network-allowed themes.
  29   *                          Null to return all themes. Default null.
  30   *     @type int   $blog_id (Multisite) The blog ID used to calculate which themes
  31   *                          are allowed. Default 0, synonymous for the current blog.
  32   * }
  33   * @return WP_Theme[] Array of WP_Theme objects.
  34   */
  35  function wp_get_themes( $args = array() ) {
  36      global $wp_theme_directories;
  37  
  38      $defaults = array(
  39          'errors'  => false,
  40          'allowed' => null,
  41          'blog_id' => 0,
  42      );
  43      $args     = wp_parse_args( $args, $defaults );
  44  
  45      $theme_directories = search_theme_directories();
  46  
  47      if ( is_array( $wp_theme_directories ) && count( $wp_theme_directories ) > 1 ) {
  48          /*
  49           * Make sure the active theme wins out, in case search_theme_directories() picks the wrong
  50           * one in the case of a conflict. (Normally, last registered theme root wins.)
  51           */
  52          $current_theme = get_stylesheet();
  53          if ( isset( $theme_directories[ $current_theme ] ) ) {
  54              $root_of_current_theme = get_raw_theme_root( $current_theme );
  55              if ( ! in_array( $root_of_current_theme, $wp_theme_directories, true ) ) {
  56                  $root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme;
  57              }
  58              $theme_directories[ $current_theme ]['theme_root'] = $root_of_current_theme;
  59          }
  60      }
  61  
  62      if ( empty( $theme_directories ) ) {
  63          return array();
  64      }
  65  
  66      if ( is_multisite() && null !== $args['allowed'] ) {
  67          $allowed = $args['allowed'];
  68          if ( 'network' === $allowed ) {
  69              $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_network() );
  70          } elseif ( 'site' === $allowed ) {
  71              $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_site( $args['blog_id'] ) );
  72          } elseif ( $allowed ) {
  73              $theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
  74          } else {
  75              $theme_directories = array_diff_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );
  76          }
  77      }
  78  
  79      $themes         = array();
  80      static $_themes = array();
  81  
  82      foreach ( $theme_directories as $theme => $theme_root ) {
  83          if ( isset( $_themes[ $theme_root['theme_root'] . '/' . $theme ] ) ) {
  84              $themes[ $theme ] = $_themes[ $theme_root['theme_root'] . '/' . $theme ];
  85          } else {
  86              $themes[ $theme ] = new WP_Theme( $theme, $theme_root['theme_root'] );
  87  
  88              $_themes[ $theme_root['theme_root'] . '/' . $theme ] = $themes[ $theme ];
  89          }
  90      }
  91  
  92      if ( null !== $args['errors'] ) {
  93          foreach ( $themes as $theme => $wp_theme ) {
  94              if ( (bool) $wp_theme->errors() !== $args['errors'] ) {
  95                  unset( $themes[ $theme ] );
  96              }
  97          }
  98      }
  99  
 100      return $themes;
 101  }
 102  
 103  /**
 104   * Gets a WP_Theme object for a theme.
 105   *
 106   * @since 3.4.0
 107   *
 108   * @global string[] $wp_theme_directories
 109   *
 110   * @param string $stylesheet Optional. Directory name for the theme. Defaults to active theme.
 111   * @param string $theme_root Optional. Absolute path of the theme root to look in.
 112   *                           If not specified, get_raw_theme_root() is used to calculate
 113   *                           the theme root for the $stylesheet provided (or active theme).
 114   * @return WP_Theme Theme object. Be sure to check the object's exists() method
 115   *                  if you need to confirm the theme's existence.
 116   */
 117  function wp_get_theme( $stylesheet = '', $theme_root = '' ) {
 118      global $wp_theme_directories;
 119  
 120      if ( empty( $stylesheet ) ) {
 121          $stylesheet = get_stylesheet();
 122      }
 123  
 124      if ( empty( $theme_root ) ) {
 125          $theme_root = get_raw_theme_root( $stylesheet );
 126          if ( false === $theme_root ) {
 127              $theme_root = WP_CONTENT_DIR . '/themes';
 128          } elseif ( ! in_array( $theme_root, (array) $wp_theme_directories, true ) ) {
 129              $theme_root = WP_CONTENT_DIR . $theme_root;
 130          }
 131      }
 132  
 133      return new WP_Theme( $stylesheet, $theme_root );
 134  }
 135  
 136  /**
 137   * Clears the cache held by get_theme_roots() and WP_Theme.
 138   *
 139   * @since 3.5.0
 140   * @param bool $clear_update_cache Whether to clear the theme updates cache.
 141   */
 142  function wp_clean_themes_cache( $clear_update_cache = true ) {
 143      if ( $clear_update_cache ) {
 144          delete_site_transient( 'update_themes' );
 145      }
 146      search_theme_directories( true );
 147      foreach ( wp_get_themes( array( 'errors' => null ) ) as $theme ) {
 148          $theme->cache_delete();
 149      }
 150  }
 151  
 152  /**
 153   * Whether a child theme is in use.
 154   *
 155   * @since 3.0.0
 156   * @since 6.5.0 Makes use of global template variables.
 157   *
 158   * @global string $wp_stylesheet_path Path to current theme's stylesheet directory.
 159   * @global string $wp_template_path   Path to current theme's template directory.
 160   *
 161   * @return bool True if a child theme is in use, false otherwise.
 162   */
 163  function is_child_theme() {
 164      global $wp_stylesheet_path, $wp_template_path;
 165  
 166      return $wp_stylesheet_path !== $wp_template_path;
 167  }
 168  
 169  /**
 170   * Retrieves name of the current stylesheet.
 171   *
 172   * The theme name that is currently set as the front end theme.
 173   *
 174   * For all intents and purposes, the template name and the stylesheet name
 175   * are going to be the same for most cases.
 176   *
 177   * @since 1.5.0
 178   *
 179   * @return string Stylesheet name.
 180   */
 181  function get_stylesheet() {
 182      /**
 183       * Filters the name of current stylesheet.
 184       *
 185       * @since 1.5.0
 186       *
 187       * @param string $stylesheet Name of the current stylesheet.
 188       */
 189      return apply_filters( 'stylesheet', get_option( 'stylesheet' ) );
 190  }
 191  
 192  /**
 193   * Retrieves stylesheet directory path for the active theme.
 194   *
 195   * @since 1.5.0
 196   * @since 6.4.0 Memoizes filter execution so that it only runs once for the current theme.
 197   * @since 6.4.2 Memoization removed.
 198   *
 199   * @return string Path to active theme's stylesheet directory.
 200   */
 201  function get_stylesheet_directory() {
 202      $stylesheet     = get_stylesheet();
 203      $theme_root     = get_theme_root( $stylesheet );
 204      $stylesheet_dir = "$theme_root/$stylesheet";
 205  
 206      /**
 207       * Filters the stylesheet directory path for the active theme.
 208       *
 209       * @since 1.5.0
 210       *
 211       * @param string $stylesheet_dir Absolute path to the active theme.
 212       * @param string $stylesheet     Directory name of the active theme.
 213       * @param string $theme_root     Absolute path to themes directory.
 214       */
 215      return apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root );
 216  }
 217  
 218  /**
 219   * Retrieves stylesheet directory URI for the active theme.
 220   *
 221   * @since 1.5.0
 222   *
 223   * @return string URI to active theme's stylesheet directory.
 224   */
 225  function get_stylesheet_directory_uri() {
 226      $stylesheet         = str_replace( '%2F', '/', rawurlencode( get_stylesheet() ) );
 227      $theme_root_uri     = get_theme_root_uri( $stylesheet );
 228      $stylesheet_dir_uri = "$theme_root_uri/$stylesheet";
 229  
 230      /**
 231       * Filters the stylesheet directory URI.
 232       *
 233       * @since 1.5.0
 234       *
 235       * @param string $stylesheet_dir_uri Stylesheet directory URI.
 236       * @param string $stylesheet         Name of the activated theme's directory.
 237       * @param string $theme_root_uri     Themes root URI.
 238       */
 239      return apply_filters( 'stylesheet_directory_uri', $stylesheet_dir_uri, $stylesheet, $theme_root_uri );
 240  }
 241  
 242  /**
 243   * Retrieves stylesheet URI for the active theme.
 244   *
 245   * The stylesheet file name is 'style.css' which is appended to the stylesheet directory URI path.
 246   * See get_stylesheet_directory_uri().
 247   *
 248   * @since 1.5.0
 249   *
 250   * @return string URI to active theme's stylesheet.
 251   */
 252  function get_stylesheet_uri() {
 253      $stylesheet_dir_uri = get_stylesheet_directory_uri();
 254      $stylesheet_uri     = $stylesheet_dir_uri . '/style.css';
 255      /**
 256       * Filters the URI of the active theme stylesheet.
 257       *
 258       * @since 1.5.0
 259       *
 260       * @param string $stylesheet_uri     Stylesheet URI for the active theme/child theme.
 261       * @param string $stylesheet_dir_uri Stylesheet directory URI for the active theme/child theme.
 262       */
 263      return apply_filters( 'stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
 264  }
 265  
 266  /**
 267   * Retrieves the localized stylesheet URI.
 268   *
 269   * The stylesheet directory for the localized stylesheet files are located, by
 270   * default, in the base theme directory. The name of the locale file will be the
 271   * locale followed by '.css'. If that does not exist, then the text direction
 272   * stylesheet will be checked for existence, for example 'ltr.css'.
 273   *
 274   * The theme may change the location of the stylesheet directory by either using
 275   * the {@see 'stylesheet_directory_uri'} or {@see 'locale_stylesheet_uri'} filters.
 276   *
 277   * If you want to change the location of the stylesheet files for the entire
 278   * WordPress workflow, then change the former. If you just have the locale in a
 279   * separate folder, then change the latter.
 280   *
 281   * @since 2.1.0
 282   *
 283   * @global WP_Locale $wp_locale WordPress date and time locale object.
 284   *
 285   * @return string URI to active theme's localized stylesheet.
 286   */
 287  function get_locale_stylesheet_uri() {
 288      global $wp_locale;
 289      $stylesheet_dir_uri = get_stylesheet_directory_uri();
 290      $dir                = get_stylesheet_directory();
 291      $locale             = get_locale();
 292      if ( file_exists( "$dir/$locale.css" ) ) {
 293          $stylesheet_uri = "$stylesheet_dir_uri/$locale.css";
 294      } elseif ( ! empty( $wp_locale->text_direction ) && file_exists( "$dir/{$wp_locale->text_direction}.css" ) ) {
 295          $stylesheet_uri = "$stylesheet_dir_uri/{$wp_locale->text_direction}.css";
 296      } else {
 297          $stylesheet_uri = '';
 298      }
 299      /**
 300       * Filters the localized stylesheet URI.
 301       *
 302       * @since 2.1.0
 303       *
 304       * @param string $stylesheet_uri     Localized stylesheet URI.
 305       * @param string $stylesheet_dir_uri Stylesheet directory URI.
 306       */
 307      return apply_filters( 'locale_stylesheet_uri', $stylesheet_uri, $stylesheet_dir_uri );
 308  }
 309  
 310  /**
 311   * Retrieves name of the active theme.
 312   *
 313   * @since 1.5.0
 314   *
 315   * @return string Template name.
 316   */
 317  function get_template() {
 318      /**
 319       * Filters the name of the active theme.
 320       *
 321       * @since 1.5.0
 322       *
 323       * @param string $template active theme's directory name.
 324       */
 325      return apply_filters( 'template', get_option( 'template' ) );
 326  }
 327  
 328  /**
 329   * Retrieves template directory path for the active theme.
 330   *
 331   * @since 1.5.0
 332   * @since 6.4.0 Memoizes filter execution so that it only runs once for the current theme.
 333   * @since 6.4.1 Memoization removed.
 334   *
 335   * @return string Path to active theme's template directory.
 336   */
 337  function get_template_directory() {
 338      $template     = get_template();
 339      $theme_root   = get_theme_root( $template );
 340      $template_dir = "$theme_root/$template";
 341  
 342      /**
 343       * Filters the active theme directory path.
 344       *
 345       * @since 1.5.0
 346       *
 347       * @param string $template_dir The path of the active theme directory.
 348       * @param string $template     Directory name of the active theme.
 349       * @param string $theme_root   Absolute path to the themes directory.
 350       */
 351      return apply_filters( 'template_directory', $template_dir, $template, $theme_root );
 352  }
 353  
 354  /**
 355   * Retrieves template directory URI for the active theme.
 356   *
 357   * @since 1.5.0
 358   *
 359   * @return string URI to active theme's template directory.
 360   */
 361  function get_template_directory_uri() {
 362      $template         = str_replace( '%2F', '/', rawurlencode( get_template() ) );
 363      $theme_root_uri   = get_theme_root_uri( $template );
 364      $template_dir_uri = "$theme_root_uri/$template";
 365  
 366      /**
 367       * Filters the active theme directory URI.
 368       *
 369       * @since 1.5.0
 370       *
 371       * @param string $template_dir_uri The URI of the active theme directory.
 372       * @param string $template         Directory name of the active theme.
 373       * @param string $theme_root_uri   The themes root URI.
 374       */
 375      return apply_filters( 'template_directory_uri', $template_dir_uri, $template, $theme_root_uri );
 376  }
 377  
 378  /**
 379   * Retrieves theme roots.
 380   *
 381   * @since 2.9.0
 382   *
 383   * @global string[] $wp_theme_directories
 384   *
 385   * @return array|string An array of theme roots keyed by template/stylesheet
 386   *                      or a single theme root if all themes have the same root.
 387   */
 388  function get_theme_roots() {
 389      global $wp_theme_directories;
 390  
 391      if ( ! is_array( $wp_theme_directories ) || count( $wp_theme_directories ) <= 1 ) {
 392          return '/themes';
 393      }
 394  
 395      $theme_roots = get_site_transient( 'theme_roots' );
 396      if ( false === $theme_roots ) {
 397          search_theme_directories( true ); // Regenerate the transient.
 398          $theme_roots = get_site_transient( 'theme_roots' );
 399      }
 400      return $theme_roots;
 401  }
 402  
 403  /**
 404   * Registers a directory that contains themes.
 405   *
 406   * @since 2.9.0
 407   *
 408   * @global string[] $wp_theme_directories
 409   *
 410   * @param string $directory Either the full filesystem path to a theme folder
 411   *                          or a folder within WP_CONTENT_DIR.
 412   * @return bool True if successfully registered a directory that contains themes,
 413   *              false if the directory does not exist.
 414   */
 415  function register_theme_directory( $directory ) {
 416      global $wp_theme_directories;
 417  
 418      if ( ! file_exists( $directory ) ) {
 419          // Try prepending as the theme directory could be relative to the content directory.
 420          $directory = WP_CONTENT_DIR . '/' . $directory;
 421          // If this directory does not exist, return and do not register.
 422          if ( ! file_exists( $directory ) ) {
 423              return false;
 424          }
 425      }
 426  
 427      if ( ! is_array( $wp_theme_directories ) ) {
 428          $wp_theme_directories = array();
 429      }
 430  
 431      $untrailed = untrailingslashit( $directory );
 432      if ( ! empty( $untrailed ) && ! in_array( $untrailed, $wp_theme_directories, true ) ) {
 433          $wp_theme_directories[] = $untrailed;
 434      }
 435  
 436      return true;
 437  }
 438  
 439  /**
 440   * Searches all registered theme directories for complete and valid themes.
 441   *
 442   * @since 2.9.0
 443   *
 444   * @global string[] $wp_theme_directories
 445   *
 446   * @param bool $force Optional. Whether to force a new directory scan. Default false.
 447   * @return array|false Valid themes found on success, false on failure.
 448   */
 449  function search_theme_directories( $force = false ) {
 450      global $wp_theme_directories;
 451      static $found_themes = null;
 452  
 453      if ( empty( $wp_theme_directories ) ) {
 454          return false;
 455      }
 456  
 457      if ( ! $force && isset( $found_themes ) ) {
 458          return $found_themes;
 459      }
 460  
 461      $found_themes = array();
 462  
 463      $wp_theme_directories = (array) $wp_theme_directories;
 464      $relative_theme_roots = array();
 465  
 466      /*
 467       * Set up maybe-relative, maybe-absolute array of theme directories.
 468       * We always want to return absolute, but we need to cache relative
 469       * to use in get_theme_root().
 470       */
 471      foreach ( $wp_theme_directories as $theme_root ) {
 472          if ( str_starts_with( $theme_root, WP_CONTENT_DIR ) ) {
 473              $relative_theme_roots[ str_replace( WP_CONTENT_DIR, '', $theme_root ) ] = $theme_root;
 474          } else {
 475              $relative_theme_roots[ $theme_root ] = $theme_root;
 476          }
 477      }
 478  
 479      /**
 480       * Filters whether to get the cache of the registered theme directories.
 481       *
 482       * @since 3.4.0
 483       *
 484       * @param bool   $cache_expiration Whether to get the cache of the theme directories. Default false.
 485       * @param string $context          The class or function name calling the filter.
 486       */
 487      $cache_expiration = apply_filters( 'wp_cache_themes_persistently', false, 'search_theme_directories' );
 488  
 489      if ( $cache_expiration ) {
 490          $cached_roots = get_site_transient( 'theme_roots' );
 491          if ( is_array( $cached_roots ) ) {
 492              foreach ( $cached_roots as $theme_dir => $theme_root ) {
 493                  // A cached theme root is no longer around, so skip it.
 494                  if ( ! isset( $relative_theme_roots[ $theme_root ] ) ) {
 495                      continue;
 496                  }
 497                  $found_themes[ $theme_dir ] = array(
 498                      'theme_file' => $theme_dir . '/style.css',
 499                      'theme_root' => $relative_theme_roots[ $theme_root ], // Convert relative to absolute.
 500                  );
 501              }
 502              return $found_themes;
 503          }
 504          if ( ! is_int( $cache_expiration ) ) {
 505              $cache_expiration = 30 * MINUTE_IN_SECONDS;
 506          }
 507      } else {
 508          $cache_expiration = 30 * MINUTE_IN_SECONDS;
 509      }
 510  
 511      /* Loop the registered theme directories and extract all themes */
 512      foreach ( $wp_theme_directories as $theme_root ) {
 513  
 514          // Start with directories in the root of the active theme directory.
 515          $dirs = @ scandir( $theme_root );
 516          if ( ! $dirs ) {
 517              wp_trigger_error( __FUNCTION__, "$theme_root is not readable" );
 518              continue;
 519          }
 520          foreach ( $dirs as $dir ) {
 521              if ( ! is_dir( $theme_root . '/' . $dir ) || '.' === $dir[0] || 'CVS' === $dir ) {
 522                  continue;
 523              }
 524              if ( file_exists( $theme_root . '/' . $dir . '/style.css' ) ) {
 525                  /*
 526                   * wp-content/themes/a-single-theme
 527                   * wp-content/themes is $theme_root, a-single-theme is $dir.
 528                   */
 529                  $found_themes[ $dir ] = array(
 530                      'theme_file' => $dir . '/style.css',
 531                      'theme_root' => $theme_root,
 532                  );
 533              } else {
 534                  $found_theme = false;
 535                  /*
 536                   * wp-content/themes/a-folder-of-themes/*
 537                   * wp-content/themes is $theme_root, a-folder-of-themes is $dir, then themes are $sub_dirs.
 538                   */
 539                  $sub_dirs = @ scandir( $theme_root . '/' . $dir );
 540                  if ( ! $sub_dirs ) {
 541                      wp_trigger_error( __FUNCTION__, "$theme_root/$dir is not readable" );
 542                      continue;
 543                  }
 544                  foreach ( $sub_dirs as $sub_dir ) {
 545                      if ( ! is_dir( $theme_root . '/' . $dir . '/' . $sub_dir ) || '.' === $dir[0] || 'CVS' === $dir ) {
 546                          continue;
 547                      }
 548                      if ( ! file_exists( $theme_root . '/' . $dir . '/' . $sub_dir . '/style.css' ) ) {
 549                          continue;
 550                      }
 551                      $found_themes[ $dir . '/' . $sub_dir ] = array(
 552                          'theme_file' => $dir . '/' . $sub_dir . '/style.css',
 553                          'theme_root' => $theme_root,
 554                      );
 555                      $found_theme                           = true;
 556                  }
 557                  /*
 558                   * Never mind the above, it's just a theme missing a style.css.
 559                   * Return it; WP_Theme will catch the error.
 560                   */
 561                  if ( ! $found_theme ) {
 562                      $found_themes[ $dir ] = array(
 563                          'theme_file' => $dir . '/style.css',
 564                          'theme_root' => $theme_root,
 565                      );
 566                  }
 567              }
 568          }
 569      }
 570  
 571      asort( $found_themes );
 572  
 573      $theme_roots          = array();
 574      $relative_theme_roots = array_flip( $relative_theme_roots );
 575  
 576      foreach ( $found_themes as $theme_dir => $theme_data ) {
 577          $theme_roots[ $theme_dir ] = $relative_theme_roots[ $theme_data['theme_root'] ]; // Convert absolute to relative.
 578      }
 579  
 580      if ( get_site_transient( 'theme_roots' ) !== $theme_roots ) {
 581          set_site_transient( 'theme_roots', $theme_roots, $cache_expiration );
 582      }
 583  
 584      return $found_themes;
 585  }
 586  
 587  /**
 588   * Retrieves path to themes directory.
 589   *
 590   * Does not have trailing slash.
 591   *
 592   * @since 1.5.0
 593   *
 594   * @global string[] $wp_theme_directories
 595   *
 596   * @param string $stylesheet_or_template Optional. The stylesheet or template name of the theme.
 597   *                                       Default is to leverage the main theme root.
 598   * @return string Themes directory path.
 599   */
 600  function get_theme_root( $stylesheet_or_template = '' ) {
 601      global $wp_theme_directories;
 602  
 603      $theme_root = '';
 604  
 605      if ( $stylesheet_or_template ) {
 606          $theme_root = get_raw_theme_root( $stylesheet_or_template );
 607          if ( $theme_root ) {
 608              /*
 609               * Always prepend WP_CONTENT_DIR unless the root currently registered as a theme directory.
 610               * This gives relative theme roots the benefit of the doubt when things go haywire.
 611               */
 612              if ( ! in_array( $theme_root, (array) $wp_theme_directories, true ) ) {
 613                  $theme_root = WP_CONTENT_DIR . $theme_root;
 614              }
 615          }
 616      }
 617  
 618      if ( ! $theme_root ) {
 619          $theme_root = WP_CONTENT_DIR . '/themes';
 620      }
 621  
 622      /**
 623       * Filters the absolute path to the themes directory.
 624       *
 625       * @since 1.5.0
 626       *
 627       * @param string $theme_root Absolute path to themes directory.
 628       */
 629      return apply_filters( 'theme_root', $theme_root );
 630  }
 631  
 632  /**
 633   * Retrieves URI for themes directory.
 634   *
 635   * Does not have trailing slash.
 636   *
 637   * @since 1.5.0
 638   *
 639   * @global string[] $wp_theme_directories
 640   *
 641   * @param string $stylesheet_or_template Optional. The stylesheet or template name of the theme.
 642   *                                       Default is to leverage the main theme root.
 643   * @param string $theme_root             Optional. The theme root for which calculations will be based,
 644   *                                       preventing the need for a get_raw_theme_root() call. Default empty.
 645   * @return string Themes directory URI.
 646   */
 647  function get_theme_root_uri( $stylesheet_or_template = '', $theme_root = '' ) {
 648      global $wp_theme_directories;
 649  
 650      if ( $stylesheet_or_template && ! $theme_root ) {
 651          $theme_root = get_raw_theme_root( $stylesheet_or_template );
 652      }
 653  
 654      if ( $stylesheet_or_template && $theme_root ) {
 655          if ( in_array( $theme_root, (array) $wp_theme_directories, true ) ) {
 656              // Absolute path. Make an educated guess. YMMV -- but note the filter below.
 657              if ( str_starts_with( $theme_root, WP_CONTENT_DIR ) ) {
 658                  $theme_root_uri = content_url( str_replace( WP_CONTENT_DIR, '', $theme_root ) );
 659              } elseif ( str_starts_with( $theme_root, ABSPATH ) ) {
 660                  $theme_root_uri = site_url( str_replace( ABSPATH, '', $theme_root ) );
 661              } elseif ( str_starts_with( $theme_root, WP_PLUGIN_DIR ) || str_starts_with( $theme_root, WPMU_PLUGIN_DIR ) ) {
 662                  $theme_root_uri = plugins_url( basename( $theme_root ), $theme_root );
 663              } else {
 664                  $theme_root_uri = $theme_root;
 665              }
 666          } else {
 667              $theme_root_uri = content_url( $theme_root );
 668          }
 669      } else {
 670          $theme_root_uri = content_url( 'themes' );
 671      }
 672  
 673      /**
 674       * Filters the URI for themes directory.
 675       *
 676       * @since 1.5.0
 677       *
 678       * @param string $theme_root_uri         The URI for themes directory.
 679       * @param string $siteurl                WordPress web address which is set in General Options.
 680       * @param string $stylesheet_or_template The stylesheet or template name of the theme.
 681       */
 682      return apply_filters( 'theme_root_uri', $theme_root_uri, get_option( 'siteurl' ), $stylesheet_or_template );
 683  }
 684  
 685  /**
 686   * Gets the raw theme root relative to the content directory with no filters applied.
 687   *
 688   * @since 3.1.0
 689   *
 690   * @global string[] $wp_theme_directories
 691   *
 692   * @param string $stylesheet_or_template The stylesheet or template name of the theme.
 693   * @param bool   $skip_cache             Optional. Whether to skip the cache.
 694   *                                       Defaults to false, meaning the cache is used.
 695   * @return string Theme root.
 696   */
 697  function get_raw_theme_root( $stylesheet_or_template, $skip_cache = false ) {
 698      global $wp_theme_directories;
 699  
 700      if ( ! is_array( $wp_theme_directories ) || count( $wp_theme_directories ) <= 1 ) {
 701          return '/themes';
 702      }
 703  
 704      $theme_root = false;
 705  
 706      // If requesting the root for the active theme, consult options to avoid calling get_theme_roots().
 707      if ( ! $skip_cache ) {
 708          if ( get_option( 'stylesheet' ) === $stylesheet_or_template ) {
 709              $theme_root = get_option( 'stylesheet_root' );
 710          } elseif ( get_option( 'template' ) === $stylesheet_or_template ) {
 711              $theme_root = get_option( 'template_root' );
 712          }
 713      }
 714  
 715      if ( empty( $theme_root ) ) {
 716          $theme_roots = get_theme_roots();
 717          if ( ! empty( $theme_roots[ $stylesheet_or_template ] ) ) {
 718              $theme_root = $theme_roots[ $stylesheet_or_template ];
 719          }
 720      }
 721  
 722      return $theme_root;
 723  }
 724  
 725  /**
 726   * Displays localized stylesheet link element.
 727   *
 728   * @since 2.1.0
 729   */
 730  function locale_stylesheet() {
 731      $stylesheet = get_locale_stylesheet_uri();
 732      if ( empty( $stylesheet ) ) {
 733          return;
 734      }
 735  
 736      printf(
 737          '<link rel="stylesheet" href="%s" media="screen" />',
 738          $stylesheet
 739      );
 740  }
 741  
 742  /**
 743   * Switches the theme.
 744   *
 745   * Accepts one argument: $stylesheet of the theme. It also accepts an additional function signature
 746   * of two arguments: $template then $stylesheet. This is for backward compatibility.
 747   *
 748   * @since 2.5.0
 749   *
 750   * @global string[]             $wp_theme_directories
 751   * @global WP_Customize_Manager $wp_customize
 752   * @global array                $sidebars_widgets
 753   * @global array                $wp_registered_sidebars
 754   *
 755   * @param string $stylesheet Stylesheet name.
 756   */
 757  function switch_theme( $stylesheet ) {
 758      global $wp_theme_directories, $wp_customize, $sidebars_widgets, $wp_registered_sidebars;
 759  
 760      $requirements = validate_theme_requirements( $stylesheet );
 761      if ( is_wp_error( $requirements ) ) {
 762          wp_die( $requirements );
 763      }
 764  
 765      $_sidebars_widgets = null;
 766      if ( 'wp_ajax_customize_save' === current_action() ) {
 767          $old_sidebars_widgets_data_setting = $wp_customize->get_setting( 'old_sidebars_widgets_data' );
 768          if ( $old_sidebars_widgets_data_setting ) {
 769              $_sidebars_widgets = $wp_customize->post_value( $old_sidebars_widgets_data_setting );
 770          }
 771      } elseif ( is_array( $sidebars_widgets ) ) {
 772          $_sidebars_widgets = $sidebars_widgets;
 773      }
 774  
 775      if ( is_array( $_sidebars_widgets ) ) {
 776          set_theme_mod(
 777              'sidebars_widgets',
 778              array(
 779                  'time' => time(),
 780                  'data' => $_sidebars_widgets,
 781              )
 782          );
 783      }
 784  
 785      $nav_menu_locations = get_theme_mod( 'nav_menu_locations' );
 786      update_option( 'theme_switch_menu_locations', $nav_menu_locations, true );
 787  
 788      if ( func_num_args() > 1 ) {
 789          $stylesheet = func_get_arg( 1 );
 790      }
 791  
 792      $old_theme = wp_get_theme();
 793      $new_theme = wp_get_theme( $stylesheet );
 794      $template  = $new_theme->get_template();
 795  
 796      if ( wp_is_recovery_mode() ) {
 797          $paused_themes = wp_paused_themes();
 798          $paused_themes->delete( $old_theme->get_stylesheet() );
 799          $paused_themes->delete( $old_theme->get_template() );
 800      }
 801  
 802      update_option( 'template', $template );
 803      update_option( 'stylesheet', $stylesheet );
 804  
 805      if ( count( $wp_theme_directories ) > 1 ) {
 806          update_option( 'template_root', get_raw_theme_root( $template, true ) );
 807          update_option( 'stylesheet_root', get_raw_theme_root( $stylesheet, true ) );
 808      } else {
 809          delete_option( 'template_root' );
 810          delete_option( 'stylesheet_root' );
 811      }
 812  
 813      $new_name = $new_theme->get( 'Name' );
 814  
 815      update_option( 'current_theme', $new_name );
 816  
 817      // Migrate from the old mods_{name} option to theme_mods_{slug}.
 818      if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
 819          $default_theme_mods = (array) get_option( 'mods_' . $new_name );
 820          if ( ! empty( $nav_menu_locations ) && empty( $default_theme_mods['nav_menu_locations'] ) ) {
 821              $default_theme_mods['nav_menu_locations'] = $nav_menu_locations;
 822          }
 823          add_option( "theme_mods_$stylesheet", $default_theme_mods );
 824      } else {
 825          /*
 826           * Since retrieve_widgets() is called when initializing a theme in the Customizer,
 827           * we need to remove the theme mods to avoid overwriting changes made via
 828           * the Customizer when accessing wp-admin/widgets.php.
 829           */
 830          if ( 'wp_ajax_customize_save' === current_action() ) {
 831              remove_theme_mod( 'sidebars_widgets' );
 832          }
 833      }
 834  
 835      // Stores classic sidebars for later use by block themes.
 836      if ( $new_theme->is_block_theme() ) {
 837          set_theme_mod( 'wp_classic_sidebars', $wp_registered_sidebars );
 838      }
 839  
 840      update_option( 'theme_switched', $old_theme->get_stylesheet() );
 841  
 842      /*
 843       * Reset template globals when switching themes outside of a switched blog
 844       * context to ensure templates will be loaded from the new theme.
 845       */
 846      if ( ! is_multisite() || ! ms_is_switched() ) {
 847          wp_set_template_globals();
 848      }
 849  
 850      // Clear pattern caches.
 851      if ( ! is_multisite() ) {
 852          $new_theme->delete_pattern_cache();
 853          $old_theme->delete_pattern_cache();
 854      }
 855  
 856      // Set autoload=no for the old theme, autoload=yes for the switched theme.
 857      $theme_mods_options = array(
 858          'theme_mods_' . $stylesheet                  => 'yes',
 859          'theme_mods_' . $old_theme->get_stylesheet() => 'no',
 860      );
 861      wp_set_option_autoload_values( $theme_mods_options );
 862  
 863      /**
 864       * Fires after the theme is switched.
 865       *
 866       * See {@see 'after_switch_theme'}.
 867       *
 868       * @since 1.5.0
 869       * @since 4.5.0 Introduced the `$old_theme` parameter.
 870       *
 871       * @param string   $new_name  Name of the new theme.
 872       * @param WP_Theme $new_theme WP_Theme instance of the new theme.
 873       * @param WP_Theme $old_theme WP_Theme instance of the old theme.
 874       */
 875      do_action( 'switch_theme', $new_name, $new_theme, $old_theme );
 876  }
 877  
 878  /**
 879   * Checks that the active theme has the required files.
 880   *
 881   * Standalone themes need to have a `templates/index.html` or `index.php` template file.
 882   * Child themes need to have a `Template` header in the `style.css` stylesheet.
 883   *
 884   * Does not initially check the default theme, which is the fallback and should always exist.
 885   * But if it doesn't exist, it'll fall back to the latest core default theme that does exist.
 886   * Will switch theme to the fallback theme if active theme does not validate.
 887   *
 888   * You can use the {@see 'validate_current_theme'} filter to return false to disable
 889   * this functionality.
 890   *
 891   * @since 1.5.0
 892   * @since 6.0.0 Removed the requirement for block themes to have an `index.php` template.
 893   *
 894   * @see WP_DEFAULT_THEME
 895   *
 896   * @return bool
 897   */
 898  function validate_current_theme() {
 899      /**
 900       * Filters whether to validate the active theme.
 901       *
 902       * @since 2.7.0
 903       *
 904       * @param bool $validate Whether to validate the active theme. Default true.
 905       */
 906      if ( wp_installing() || ! apply_filters( 'validate_current_theme', true ) ) {
 907          return true;
 908      }
 909  
 910      if (
 911          ! file_exists( get_template_directory() . '/templates/index.html' )
 912          && ! file_exists( get_template_directory() . '/block-templates/index.html' ) // Deprecated path support since 5.9.0.
 913          && ! file_exists( get_template_directory() . '/index.php' )
 914      ) {
 915          // Invalid.
 916      } elseif ( ! file_exists( get_template_directory() . '/style.css' ) ) {
 917          // Invalid.
 918      } elseif ( is_child_theme() && ! file_exists( get_stylesheet_directory() . '/style.css' ) ) {
 919          // Invalid.
 920      } else {
 921          // Valid.
 922          return true;
 923      }
 924  
 925      $default = wp_get_theme( WP_DEFAULT_THEME );
 926      if ( $default->exists() ) {
 927          switch_theme( WP_DEFAULT_THEME );
 928          return false;
 929      }
 930  
 931      /**
 932       * If we're in an invalid state but WP_DEFAULT_THEME doesn't exist,
 933       * switch to the latest core default theme that's installed.
 934       *
 935       * If it turns out that this latest core default theme is our current
 936       * theme, then there's nothing we can do about that, so we have to bail,
 937       * rather than going into an infinite loop. (This is why there are
 938       * checks against WP_DEFAULT_THEME above, also.) We also can't do anything
 939       * if it turns out there is no default theme installed. (That's `false`.)
 940       */
 941      $default = WP_Theme::get_core_default_theme();
 942      if ( false === $default || get_stylesheet() === $default->get_stylesheet() ) {
 943          return true;
 944      }
 945  
 946      switch_theme( $default->get_stylesheet() );
 947      return false;
 948  }
 949  
 950  /**
 951   * Validates the theme requirements for WordPress version and PHP version.
 952   *
 953   * Uses the information from `Requires at least` and `Requires PHP` headers
 954   * defined in the theme's `style.css` file.
 955   *
 956   * @since 5.5.0
 957   * @since 5.8.0 Removed support for using `readme.txt` as a fallback.
 958   *
 959   * @param string $stylesheet Directory name for the theme.
 960   * @return true|WP_Error True if requirements are met, WP_Error on failure.
 961   */
 962  function validate_theme_requirements( $stylesheet ) {
 963      $theme = wp_get_theme( $stylesheet );
 964  
 965      $requirements = array(
 966          'requires'     => ! empty( $theme->get( 'RequiresWP' ) ) ? $theme->get( 'RequiresWP' ) : '',
 967          'requires_php' => ! empty( $theme->get( 'RequiresPHP' ) ) ? $theme->get( 'RequiresPHP' ) : '',
 968      );
 969  
 970      $compatible_wp  = is_wp_version_compatible( $requirements['requires'] );
 971      $compatible_php = is_php_version_compatible( $requirements['requires_php'] );
 972  
 973      if ( ! $compatible_wp && ! $compatible_php ) {
 974          return new WP_Error(
 975              'theme_wp_php_incompatible',
 976              sprintf(
 977                  /* translators: %s: Theme name. */
 978                  _x( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.', 'theme' ),
 979                  $theme->display( 'Name' )
 980              )
 981          );
 982      } elseif ( ! $compatible_php ) {
 983          return new WP_Error(
 984              'theme_php_incompatible',
 985              sprintf(
 986                  /* translators: %s: Theme name. */
 987                  _x( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.', 'theme' ),
 988                  $theme->display( 'Name' )
 989              )
 990          );
 991      } elseif ( ! $compatible_wp ) {
 992          return new WP_Error(
 993              'theme_wp_incompatible',
 994              sprintf(
 995                  /* translators: %s: Theme name. */
 996                  _x( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.', 'theme' ),
 997                  $theme->display( 'Name' )
 998              )
 999          );
1000      }
1001  
1002      /**
1003       * Filters the theme requirement validation response.
1004       *
1005       * If a theme fails due to a Core-provided validation (incompatible WP, PHP versions), this
1006       * filter will not fire. A WP_Error response will already be returned.
1007       *
1008       * This filter is intended to add additional validation steps by site administrators.
1009       *
1010       * @since 6.9.0
1011       *
1012       * @param bool|WP_Error $met_requirements True if the theme meets requirements, WP_Error if not.
1013       * @param string $stylesheet Directory name for the theme.
1014       */
1015      return apply_filters( 'validate_theme_requirements', true, $stylesheet );
1016  }
1017  
1018  /**
1019   * Retrieves all theme modifications.
1020   *
1021   * @since 3.1.0
1022   * @since 5.9.0 The return value is always an array.
1023   *
1024   * @return array Theme modifications.
1025   */
1026  function get_theme_mods() {
1027      $theme_slug = get_option( 'stylesheet' );
1028      $mods       = get_option( "theme_mods_$theme_slug" );
1029  
1030      if ( false === $mods ) {
1031          $theme_name = get_option( 'current_theme' );
1032          if ( false === $theme_name ) {
1033              $theme_name = wp_get_theme()->get( 'Name' );
1034          }
1035  
1036          $mods = get_option( "mods_$theme_name" ); // Deprecated location.
1037          if ( is_admin() && false !== $mods ) {
1038              update_option( "theme_mods_$theme_slug", $mods );
1039              delete_option( "mods_$theme_name" );
1040          }
1041      }
1042  
1043      if ( ! is_array( $mods ) ) {
1044          $mods = array();
1045      }
1046  
1047      return $mods;
1048  }
1049  
1050  /**
1051   * Retrieves theme modification value for the active theme.
1052   *
1053   * If the modification name does not exist and `$default_value` is a string, then the
1054   * default will be passed through the {@link https://www.php.net/sprintf sprintf()}
1055   * PHP function with the template directory URI as the first value and the
1056   * stylesheet directory URI as the second value.
1057   *
1058   * @since 2.1.0
1059   *
1060   * @param string $name          Theme modification name.
1061   * @param mixed  $default_value Optional. Theme modification default value. Default false.
1062   * @return mixed Theme modification value.
1063   */
1064  function get_theme_mod( $name, $default_value = false ) {
1065      $mods = get_theme_mods();
1066  
1067      if ( isset( $mods[ $name ] ) ) {
1068          /**
1069           * Filters the theme modification, or 'theme_mod', value.
1070           *
1071           * The dynamic portion of the hook name, `$name`, refers to the key name
1072           * of the modification array. For example, 'header_textcolor', 'header_image',
1073           * and so on depending on the theme options.
1074           *
1075           * @since 2.2.0
1076           *
1077           * @param mixed $current_mod The value of the active theme modification.
1078           */
1079          return apply_filters( "theme_mod_{$name}", $mods[ $name ] );
1080      }
1081  
1082      if ( is_string( $default_value ) ) {
1083          // Only run the replacement if an sprintf() string format pattern was found.
1084          if ( preg_match( '#(?<!%)%(?:\d+\$?)?s#', $default_value ) ) {
1085              // Remove a single trailing percent sign.
1086              $default_value = preg_replace( '#(?<!%)%$#', '', $default_value );
1087              $default_value = sprintf( $default_value, get_template_directory_uri(), get_stylesheet_directory_uri() );
1088          }
1089      }
1090  
1091      /** This filter is documented in wp-includes/theme.php */
1092      return apply_filters( "theme_mod_{$name}", $default_value );
1093  }
1094  
1095  /**
1096   * Updates theme modification value for the active theme.
1097   *
1098   * @since 2.1.0
1099   * @since 5.6.0 A return value was added.
1100   *
1101   * @param string $name  Theme modification name.
1102   * @param mixed  $value Theme modification value.
1103   * @return bool True if the value was updated, false otherwise.
1104   */
1105  function set_theme_mod( $name, $value ) {
1106      $mods      = get_theme_mods();
1107      $old_value = $mods[ $name ] ?? false;
1108  
1109      /**
1110       * Filters the theme modification, or 'theme_mod', value on save.
1111       *
1112       * The dynamic portion of the hook name, `$name`, refers to the key name
1113       * of the modification array. For example, 'header_textcolor', 'header_image',
1114       * and so on depending on the theme options.
1115       *
1116       * @since 3.9.0
1117       *
1118       * @param mixed $value     The new value of the theme modification.
1119       * @param mixed $old_value The current value of the theme modification.
1120       */
1121      $mods[ $name ] = apply_filters( "pre_set_theme_mod_{$name}", $value, $old_value );
1122  
1123      $theme = get_option( 'stylesheet' );
1124  
1125      return update_option( "theme_mods_$theme", $mods );
1126  }
1127  
1128  /**
1129   * Removes theme modification name from active theme list.
1130   *
1131   * If removing the name also removes all elements, then the entire option
1132   * will be removed.
1133   *
1134   * @since 2.1.0
1135   *
1136   * @param string $name Theme modification name.
1137   */
1138  function remove_theme_mod( $name ) {
1139      $mods = get_theme_mods();
1140  
1141      if ( ! isset( $mods[ $name ] ) ) {
1142          return;
1143      }
1144  
1145      unset( $mods[ $name ] );
1146  
1147      if ( empty( $mods ) ) {
1148          remove_theme_mods();
1149          return;
1150      }
1151  
1152      $theme = get_option( 'stylesheet' );
1153  
1154      update_option( "theme_mods_$theme", $mods );
1155  }
1156  
1157  /**
1158   * Removes theme modifications option for the active theme.
1159   *
1160   * @since 2.1.0
1161   */
1162  function remove_theme_mods() {
1163      delete_option( 'theme_mods_' . get_option( 'stylesheet' ) );
1164  
1165      // Old style.
1166      $theme_name = get_option( 'current_theme' );
1167      if ( false === $theme_name ) {
1168          $theme_name = wp_get_theme()->get( 'Name' );
1169      }
1170  
1171      delete_option( 'mods_' . $theme_name );
1172  }
1173  
1174  /**
1175   * Retrieves the custom header text color in 3- or 6-digit hexadecimal form.
1176   *
1177   * @since 2.1.0
1178   *
1179   * @return string Header text color in 3- or 6-digit hexadecimal form (minus the hash symbol).
1180   */
1181  function get_header_textcolor() {
1182      return get_theme_mod( 'header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
1183  }
1184  
1185  /**
1186   * Displays the custom header text color in 3- or 6-digit hexadecimal form (minus the hash symbol).
1187   *
1188   * @since 2.1.0
1189   */
1190  function header_textcolor() {
1191      echo get_header_textcolor();
1192  }
1193  
1194  /**
1195   * Whether to display the header text.
1196   *
1197   * @since 3.4.0
1198   *
1199   * @return bool
1200   */
1201  function display_header_text() {
1202      if ( ! current_theme_supports( 'custom-header', 'header-text' ) ) {
1203          return false;
1204      }
1205  
1206      $text_color = get_theme_mod( 'header_textcolor', get_theme_support( 'custom-header', 'default-text-color' ) );
1207      return 'blank' !== $text_color;
1208  }
1209  
1210  /**
1211   * Checks whether a header image is set or not.
1212   *
1213   * @since 4.2.0
1214   *
1215   * @see get_header_image()
1216   *
1217   * @return bool Whether a header image is set or not.
1218   */
1219  function has_header_image() {
1220      return (bool) get_header_image();
1221  }
1222  
1223  /**
1224   * Retrieves header image for custom header.
1225   *
1226   * @since 2.1.0
1227   *
1228   * @return string|false
1229   */
1230  function get_header_image() {
1231      $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
1232  
1233      if ( 'remove-header' === $url ) {
1234          return false;
1235      }
1236  
1237      if ( is_random_header_image() ) {
1238          $url = get_random_header_image();
1239      }
1240  
1241      /**
1242       * Filters the header image URL.
1243       *
1244       * @since 6.1.0
1245       *
1246       * @param string $url Header image URL.
1247       */
1248      $url = apply_filters( 'get_header_image', $url );
1249  
1250      if ( ! is_string( $url ) ) {
1251          return false;
1252      }
1253  
1254      $url = trim( $url );
1255      return sanitize_url( set_url_scheme( $url ) );
1256  }
1257  
1258  /**
1259   * Creates image tag markup for a custom header image.
1260   *
1261   * @since 4.4.0
1262   *
1263   * @param array $attr Optional. Additional attributes for the image tag. Can be used
1264   *                              to override the default attributes. Default empty.
1265   * @return string HTML image element markup or empty string on failure.
1266   */
1267  function get_header_image_tag( $attr = array() ) {
1268      $header      = get_custom_header();
1269      $header->url = get_header_image();
1270  
1271      if ( ! $header->url ) {
1272          return '';
1273      }
1274  
1275      $width  = absint( $header->width );
1276      $height = absint( $header->height );
1277      $alt    = '';
1278  
1279      // Use alternative text assigned to the image, if available. Otherwise, leave it empty.
1280      if ( ! empty( $header->attachment_id ) ) {
1281          $image_alt = get_post_meta( $header->attachment_id, '_wp_attachment_image_alt', true );
1282  
1283          if ( is_string( $image_alt ) ) {
1284              $alt = $image_alt;
1285          }
1286      }
1287  
1288      $attr = wp_parse_args(
1289          $attr,
1290          array(
1291              'src'    => $header->url,
1292              'width'  => $width,
1293              'height' => $height,
1294              'alt'    => $alt,
1295          )
1296      );
1297  
1298      // Generate 'srcset' and 'sizes' if not already present.
1299      if ( empty( $attr['srcset'] ) && ! empty( $header->attachment_id ) ) {
1300          $image_meta = get_post_meta( $header->attachment_id, '_wp_attachment_metadata', true );
1301          $size_array = array( $width, $height );
1302  
1303          if ( is_array( $image_meta ) ) {
1304              $srcset = wp_calculate_image_srcset( $size_array, $header->url, $image_meta, $header->attachment_id );
1305  
1306              if ( ! empty( $attr['sizes'] ) ) {
1307                  $sizes = $attr['sizes'];
1308              } else {
1309                  $sizes = wp_calculate_image_sizes( $size_array, $header->url, $image_meta, $header->attachment_id );
1310              }
1311  
1312              if ( $srcset && $sizes ) {
1313                  $attr['srcset'] = $srcset;
1314                  $attr['sizes']  = $sizes;
1315              }
1316          }
1317      }
1318  
1319      $attr = array_merge(
1320          $attr,
1321          wp_get_loading_optimization_attributes( 'img', $attr, 'get_header_image_tag' )
1322      );
1323  
1324      /*
1325       * If the default value of `lazy` for the `loading` attribute is overridden
1326       * to omit the attribute for this image, ensure it is not included.
1327       */
1328      if ( isset( $attr['loading'] ) && ! $attr['loading'] ) {
1329          unset( $attr['loading'] );
1330      }
1331  
1332      // If the `fetchpriority` attribute is overridden and set to false or an empty string.
1333      if ( isset( $attr['fetchpriority'] ) && ! $attr['fetchpriority'] ) {
1334          unset( $attr['fetchpriority'] );
1335      }
1336  
1337      // If the `decoding` attribute is overridden and set to false or an empty string.
1338      if ( isset( $attr['decoding'] ) && ! $attr['decoding'] ) {
1339          unset( $attr['decoding'] );
1340      }
1341  
1342      /**
1343       * Filters the list of header image attributes.
1344       *
1345       * @since 5.9.0
1346       *
1347       * @param array  $attr   Array of the attributes for the image tag.
1348       * @param object $header The custom header object returned by 'get_custom_header()'.
1349       */
1350      $attr = apply_filters( 'get_header_image_tag_attributes', $attr, $header );
1351  
1352      $attr = array_map( 'esc_attr', $attr );
1353      $html = '<img';
1354  
1355      foreach ( $attr as $name => $value ) {
1356          $html .= ' ' . $name . '="' . $value . '"';
1357      }
1358  
1359      $html .= ' />';
1360  
1361      /**
1362       * Filters the markup of header images.
1363       *
1364       * @since 4.4.0
1365       *
1366       * @param string $html   The HTML image tag markup being filtered.
1367       * @param object $header The custom header object returned by 'get_custom_header()'.
1368       * @param array  $attr   Array of the attributes for the image tag.
1369       */
1370      return apply_filters( 'get_header_image_tag', $html, $header, $attr );
1371  }
1372  
1373  /**
1374   * Displays the image markup for a custom header image.
1375   *
1376   * @since 4.4.0
1377   *
1378   * @param array $attr Optional. Attributes for the image markup. Default empty.
1379   */
1380  function the_header_image_tag( $attr = array() ) {
1381      echo get_header_image_tag( $attr );
1382  }
1383  
1384  /**
1385   * Gets random header image data from registered images in theme.
1386   *
1387   * @since 3.4.0
1388   *
1389   * @access private
1390   *
1391   * @global array $_wp_default_headers
1392   *
1393   * @return object
1394   */
1395  function _get_random_header_data() {
1396      global $_wp_default_headers;
1397      static $_wp_random_header = null;
1398  
1399      if ( empty( $_wp_random_header ) ) {
1400          $header_image_mod = get_theme_mod( 'header_image', '' );
1401          $headers          = array();
1402  
1403          if ( 'random-uploaded-image' === $header_image_mod ) {
1404              $headers = get_uploaded_header_images();
1405          } elseif ( ! empty( $_wp_default_headers ) ) {
1406              if ( 'random-default-image' === $header_image_mod ) {
1407                  $headers = $_wp_default_headers;
1408              } else {
1409                  if ( current_theme_supports( 'custom-header', 'random-default' ) ) {
1410                      $headers = $_wp_default_headers;
1411                  }
1412              }
1413          }
1414  
1415          if ( empty( $headers ) ) {
1416              return new stdClass();
1417          }
1418  
1419          $_wp_random_header = (object) $headers[ array_rand( $headers ) ];
1420  
1421          $_wp_random_header->url = sprintf(
1422              $_wp_random_header->url,
1423              get_template_directory_uri(),
1424              get_stylesheet_directory_uri()
1425          );
1426  
1427          $_wp_random_header->thumbnail_url = sprintf(
1428              $_wp_random_header->thumbnail_url,
1429              get_template_directory_uri(),
1430              get_stylesheet_directory_uri()
1431          );
1432      }
1433  
1434      return $_wp_random_header;
1435  }
1436  
1437  /**
1438   * Gets random header image URL from registered images in theme.
1439   *
1440   * @since 3.2.0
1441   *
1442   * @return string Path to header image.
1443   */
1444  function get_random_header_image() {
1445      $random_image = _get_random_header_data();
1446  
1447      if ( empty( $random_image->url ) ) {
1448          return '';
1449      }
1450  
1451      return $random_image->url;
1452  }
1453  
1454  /**
1455   * Checks if random header image is in use.
1456   *
1457   * Always true if user expressly chooses the option in Appearance > Header.
1458   * Also true if theme has multiple header images registered, no specific header image
1459   * is chosen, and theme turns on random headers with add_theme_support().
1460   *
1461   * @since 3.2.0
1462   *
1463   * @param string $type The random pool to use. Possible values include 'any',
1464   *                     'default', 'uploaded'. Default 'any'.
1465   * @return bool
1466   */
1467  function is_random_header_image( $type = 'any' ) {
1468      $header_image_mod = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
1469  
1470      if ( 'any' === $type ) {
1471          if ( 'random-default-image' === $header_image_mod
1472              || 'random-uploaded-image' === $header_image_mod
1473              || ( empty( $header_image_mod ) && '' !== get_random_header_image() )
1474          ) {
1475              return true;
1476          }
1477      } else {
1478          if ( "random-$type-image" === $header_image_mod ) {
1479              return true;
1480          } elseif ( 'default' === $type
1481              && empty( $header_image_mod ) && '' !== get_random_header_image()
1482          ) {
1483              return true;
1484          }
1485      }
1486  
1487      return false;
1488  }
1489  
1490  /**
1491   * Displays header image URL.
1492   *
1493   * @since 2.1.0
1494   */
1495  function header_image() {
1496      $image = get_header_image();
1497  
1498      if ( $image ) {
1499          echo esc_url( $image );
1500      }
1501  }
1502  
1503  /**
1504   * Gets the header images uploaded for the active theme.
1505   *
1506   * @since 3.2.0
1507   *
1508   * @return array
1509   */
1510  function get_uploaded_header_images() {
1511      $header_images = array();
1512  
1513      $headers = get_posts(
1514          array(
1515              'post_type'  => 'attachment',
1516              'meta_key'   => '_wp_attachment_is_custom_header',
1517              'meta_value' => get_option( 'stylesheet' ),
1518              'orderby'    => 'none',
1519              'nopaging'   => true,
1520          )
1521      );
1522  
1523      if ( empty( $headers ) ) {
1524          return array();
1525      }
1526  
1527      foreach ( (array) $headers as $header ) {
1528          $url          = sanitize_url( wp_get_attachment_url( $header->ID ) );
1529          $header_data  = wp_get_attachment_metadata( $header->ID );
1530          $header_index = $header->ID;
1531  
1532          $header_images[ $header_index ]                      = array();
1533          $header_images[ $header_index ]['attachment_id']     = $header->ID;
1534          $header_images[ $header_index ]['url']               = $url;
1535          $header_images[ $header_index ]['thumbnail_url']     = $url;
1536          $header_images[ $header_index ]['alt_text']          = get_post_meta( $header->ID, '_wp_attachment_image_alt', true );
1537          $header_images[ $header_index ]['attachment_parent'] = $header_data['attachment_parent'] ?? '';
1538  
1539          if ( isset( $header_data['width'] ) ) {
1540              $header_images[ $header_index ]['width'] = $header_data['width'];
1541          }
1542          if ( isset( $header_data['height'] ) ) {
1543              $header_images[ $header_index ]['height'] = $header_data['height'];
1544          }
1545      }
1546  
1547      return $header_images;
1548  }
1549  
1550  /**
1551   * Gets the header image data.
1552   *
1553   * @since 3.4.0
1554   *
1555   * @global array $_wp_default_headers
1556   *
1557   * @return object
1558   */
1559  function get_custom_header() {
1560      global $_wp_default_headers;
1561  
1562      if ( is_random_header_image() ) {
1563          $data = _get_random_header_data();
1564      } else {
1565          $data = get_theme_mod( 'header_image_data' );
1566          if ( ! $data && current_theme_supports( 'custom-header', 'default-image' ) ) {
1567              $directory_args        = array( get_template_directory_uri(), get_stylesheet_directory_uri() );
1568              $data                  = array();
1569              $data['url']           = vsprintf( get_theme_support( 'custom-header', 'default-image' ), $directory_args );
1570              $data['thumbnail_url'] = $data['url'];
1571              if ( ! empty( $_wp_default_headers ) ) {
1572                  foreach ( (array) $_wp_default_headers as $default_header ) {
1573                      $url = vsprintf( $default_header['url'], $directory_args );
1574                      if ( $data['url'] === $url ) {
1575                          $data                  = $default_header;
1576                          $data['url']           = $url;
1577                          $data['thumbnail_url'] = vsprintf( $data['thumbnail_url'], $directory_args );
1578                          break;
1579                      }
1580                  }
1581              }
1582          }
1583      }
1584  
1585      $default = array(
1586          'url'           => '',
1587          'thumbnail_url' => '',
1588          'width'         => get_theme_support( 'custom-header', 'width' ),
1589          'height'        => get_theme_support( 'custom-header', 'height' ),
1590          'video'         => get_theme_support( 'custom-header', 'video' ),
1591      );
1592      return (object) wp_parse_args( $data, $default );
1593  }
1594  
1595  /**
1596   * Registers a selection of default headers to be displayed by the custom header admin UI.
1597   *
1598   * @since 3.0.0
1599   *
1600   * @global array $_wp_default_headers
1601   *
1602   * @param array $headers Array of headers keyed by a string ID. The IDs point to arrays
1603   *                       containing 'url', 'thumbnail_url', and 'description' keys.
1604   */
1605  function register_default_headers( $headers ) {
1606      global $_wp_default_headers;
1607  
1608      $_wp_default_headers = array_merge( (array) $_wp_default_headers, (array) $headers );
1609  }
1610  
1611  /**
1612   * Unregisters default headers.
1613   *
1614   * This function must be called after register_default_headers() has already added the
1615   * header you want to remove.
1616   *
1617   * @see register_default_headers()
1618   * @since 3.0.0
1619   *
1620   * @global array $_wp_default_headers
1621   *
1622   * @param string|array $header The header string id (key of array) to remove, or an array thereof.
1623   * @return bool|null A single header returns true on success, false on failure.
1624   *                   There is currently no return value for multiple headers.
1625   */
1626  function unregister_default_headers( $header ) {
1627      global $_wp_default_headers;
1628  
1629      if ( is_array( $header ) ) {
1630          array_map( 'unregister_default_headers', $header );
1631          return null;
1632      } elseif ( isset( $_wp_default_headers[ $header ] ) ) {
1633          unset( $_wp_default_headers[ $header ] );
1634          return true;
1635      } else {
1636          return false;
1637      }
1638  }
1639  
1640  /**
1641   * Checks whether a header video is set or not.
1642   *
1643   * @since 4.7.0
1644   *
1645   * @see get_header_video_url()
1646   *
1647   * @return bool Whether a header video is set or not.
1648   */
1649  function has_header_video() {
1650      return (bool) get_header_video_url();
1651  }
1652  
1653  /**
1654   * Retrieves header video URL for custom header.
1655   *
1656   * Uses a local video if present, or falls back to an external video.
1657   *
1658   * @since 4.7.0
1659   *
1660   * @return string|false Header video URL or false if there is no video.
1661   */
1662  function get_header_video_url() {
1663      $id = absint( get_theme_mod( 'header_video' ) );
1664  
1665      if ( $id ) {
1666          // Get the file URL from the attachment ID.
1667          $url = wp_get_attachment_url( $id );
1668      } else {
1669          $url = get_theme_mod( 'external_header_video' );
1670      }
1671  
1672      /**
1673       * Filters the header video URL.
1674       *
1675       * @since 4.7.3
1676       *
1677       * @param string $url Header video URL, if available.
1678       */
1679      $url = apply_filters( 'get_header_video_url', $url );
1680  
1681      if ( ! $id && ! $url ) {
1682          return false;
1683      }
1684  
1685      return sanitize_url( set_url_scheme( $url ) );
1686  }
1687  
1688  /**
1689   * Displays header video URL.
1690   *
1691   * @since 4.7.0
1692   */
1693  function the_header_video_url() {
1694      $video = get_header_video_url();
1695  
1696      if ( $video ) {
1697          echo esc_url( $video );
1698      }
1699  }
1700  
1701  /**
1702   * Retrieves header video settings.
1703   *
1704   * @since 4.7.0
1705   *
1706   * @return array
1707   */
1708  function get_header_video_settings() {
1709      $header     = get_custom_header();
1710      $video_url  = get_header_video_url();
1711      $video_type = wp_check_filetype( $video_url, wp_get_mime_types() );
1712  
1713      $settings = array(
1714          'mimeType'  => '',
1715          'posterUrl' => get_header_image(),
1716          'videoUrl'  => $video_url,
1717          'width'     => absint( $header->width ),
1718          'height'    => absint( $header->height ),
1719          'minWidth'  => 900,
1720          'minHeight' => 500,
1721          'l10n'      => array(
1722              'pause'      => __( 'Pause' ),
1723              'play'       => __( 'Play' ),
1724              'pauseSpeak' => __( 'Video is paused.' ),
1725              'playSpeak'  => __( 'Video is playing.' ),
1726          ),
1727      );
1728  
1729      if ( preg_match( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#', $video_url ) ) {
1730          $settings['mimeType'] = 'video/x-youtube';
1731      } elseif ( ! empty( $video_type['type'] ) ) {
1732          $settings['mimeType'] = $video_type['type'];
1733      }
1734  
1735      /**
1736       * Filters header video settings.
1737       *
1738       * @since 4.7.0
1739       *
1740       * @param array $settings An array of header video settings.
1741       */
1742      return apply_filters( 'header_video_settings', $settings );
1743  }
1744  
1745  /**
1746   * Checks whether a custom header is set or not.
1747   *
1748   * @since 4.7.0
1749   *
1750   * @return bool True if a custom header is set. False if not.
1751   */
1752  function has_custom_header() {
1753      if ( has_header_image() || ( has_header_video() && is_header_video_active() ) ) {
1754          return true;
1755      }
1756  
1757      return false;
1758  }
1759  
1760  /**
1761   * Checks whether the custom header video is eligible to show on the current page.
1762   *
1763   * @since 4.7.0
1764   *
1765   * @return bool True if the custom header video should be shown. False if not.
1766   */
1767  function is_header_video_active() {
1768      if ( ! get_theme_support( 'custom-header', 'video' ) ) {
1769          return false;
1770      }
1771  
1772      $video_active_cb = get_theme_support( 'custom-header', 'video-active-callback' );
1773  
1774      if ( empty( $video_active_cb ) || ! is_callable( $video_active_cb ) ) {
1775          $show_video = true;
1776      } else {
1777          $show_video = call_user_func( $video_active_cb );
1778      }
1779  
1780      /**
1781       * Filters whether the custom header video is eligible to show on the current page.
1782       *
1783       * @since 4.7.0
1784       *
1785       * @param bool $show_video Whether the custom header video should be shown. Returns the value
1786       *                         of the theme setting for the `custom-header`'s `video-active-callback`.
1787       *                         If no callback is set, the default value is that of `is_front_page()`.
1788       */
1789      return apply_filters( 'is_header_video_active', $show_video );
1790  }
1791  
1792  /**
1793   * Retrieves the markup for a custom header.
1794   *
1795   * The container div will always be returned in the Customizer preview.
1796   *
1797   * @since 4.7.0
1798   *
1799   * @return string The markup for a custom header on success.
1800   */
1801  function get_custom_header_markup() {
1802      if ( ! has_custom_header() && ! is_customize_preview() ) {
1803          return '';
1804      }
1805  
1806      return sprintf(
1807          '<div id="wp-custom-header" class="wp-custom-header">%s</div>',
1808          get_header_image_tag()
1809      );
1810  }
1811  
1812  /**
1813   * Prints the markup for a custom header.
1814   *
1815   * A container div will always be printed in the Customizer preview.
1816   *
1817   * @since 4.7.0
1818   */
1819  function the_custom_header_markup() {
1820      $custom_header = get_custom_header_markup();
1821      if ( empty( $custom_header ) ) {
1822          return;
1823      }
1824  
1825      echo $custom_header;
1826  
1827      if ( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ) {
1828          wp_enqueue_script( 'wp-custom-header' );
1829          wp_localize_script( 'wp-custom-header', '_wpCustomHeaderSettings', get_header_video_settings() );
1830      }
1831  }
1832  
1833  /**
1834   * Retrieves background image for custom background.
1835   *
1836   * @since 3.0.0
1837   *
1838   * @return string
1839   */
1840  function get_background_image() {
1841      return get_theme_mod( 'background_image', get_theme_support( 'custom-background', 'default-image' ) );
1842  }
1843  
1844  /**
1845   * Displays background image path.
1846   *
1847   * @since 3.0.0
1848   */
1849  function background_image() {
1850      echo get_background_image();
1851  }
1852  
1853  /**
1854   * Retrieves value for custom background color.
1855   *
1856   * @since 3.0.0
1857   *
1858   * @return string
1859   */
1860  function get_background_color() {
1861      return get_theme_mod( 'background_color', get_theme_support( 'custom-background', 'default-color' ) );
1862  }
1863  
1864  /**
1865   * Displays background color value.
1866   *
1867   * @since 3.0.0
1868   */
1869  function background_color() {
1870      echo get_background_color();
1871  }
1872  
1873  /**
1874   * Default custom background callback.
1875   *
1876   * @since 3.0.0
1877   */
1878  function _custom_background_cb() {
1879      // $background is the saved custom image, or the default image.
1880      $background = set_url_scheme( get_background_image() );
1881  
1882      /*
1883       * $color is the saved custom color.
1884       * A default has to be specified in style.css. It will not be printed here.
1885       */
1886      $color = get_background_color();
1887  
1888      if ( get_theme_support( 'custom-background', 'default-color' ) === $color ) {
1889          $color = false;
1890      }
1891  
1892      if ( ! $background && ! $color ) {
1893          if ( is_customize_preview() ) {
1894              echo '<style id="custom-background-css"></style>';
1895          }
1896          return;
1897      }
1898  
1899      $style = $color ? 'background-color: ' . maybe_hash_hex_color( $color ) . ';' : '';
1900  
1901      if ( $background ) {
1902          $image = ' background-image: url("' . sanitize_url( $background ) . '");';
1903  
1904          // Background Position.
1905          $position_x = get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
1906          $position_y = get_theme_mod( 'background_position_y', get_theme_support( 'custom-background', 'default-position-y' ) );
1907  
1908          if ( ! in_array( $position_x, array( 'left', 'center', 'right' ), true ) ) {
1909              $position_x = 'left';
1910          }
1911  
1912          if ( ! in_array( $position_y, array( 'top', 'center', 'bottom' ), true ) ) {
1913              $position_y = 'top';
1914          }
1915  
1916          $position = " background-position: $position_x $position_y;";
1917  
1918          // Background Size.
1919          $size = get_theme_mod( 'background_size', get_theme_support( 'custom-background', 'default-size' ) );
1920  
1921          if ( ! in_array( $size, array( 'auto', 'contain', 'cover' ), true ) ) {
1922              $size = 'auto';
1923          }
1924  
1925          $size = " background-size: $size;";
1926  
1927          // Background Repeat.
1928          $repeat = get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) );
1929  
1930          if ( ! in_array( $repeat, array( 'repeat-x', 'repeat-y', 'repeat', 'no-repeat' ), true ) ) {
1931              $repeat = 'repeat';
1932          }
1933  
1934          $repeat = " background-repeat: $repeat;";
1935  
1936          // Background Scroll.
1937          $attachment = get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) );
1938  
1939          if ( 'fixed' !== $attachment ) {
1940              $attachment = 'scroll';
1941          }
1942  
1943          $attachment = " background-attachment: $attachment;";
1944  
1945          $style .= $image . $position . $size . $repeat . $attachment;
1946      }
1947  
1948      $processor = new WP_HTML_Tag_Processor( '<style id="custom-background-css"></style>' );
1949      $processor->next_tag();
1950  
1951      $style_tag_content = 'body.custom-background { ' . trim( $style ) . ' }';
1952      $processor->set_modifiable_text( "\n{$style_tag_content}\n" );
1953      echo "{$processor->get_updated_html()}\n";
1954  }
1955  
1956  /**
1957   * Renders the Custom CSS style element.
1958   *
1959   * @since 4.7.0
1960   */
1961  function wp_custom_css_cb() {
1962      $styles = wp_get_custom_css();
1963      if ( ! $styles && ! is_customize_preview() ) {
1964          return;
1965      }
1966  
1967      $processor = new WP_HTML_Tag_Processor( '<style></style>' );
1968      $processor->next_tag();
1969      $processor->set_attribute( 'id', 'wp-custom-css' );
1970      $processor->set_modifiable_text( "\n{$styles}\n" );
1971      echo "{$processor->get_updated_html()}\n";
1972  }
1973  
1974  /**
1975   * Fetches the `custom_css` post for a given theme.
1976   *
1977   * @since 4.7.0
1978   *
1979   * @param string $stylesheet Optional. A theme object stylesheet name. Defaults to the active theme.
1980   * @return WP_Post|null The custom_css post or null if none exists.
1981   */
1982  function wp_get_custom_css_post( $stylesheet = '' ) {
1983      if ( empty( $stylesheet ) ) {
1984          $stylesheet = get_stylesheet();
1985      }
1986  
1987      $custom_css_query_vars = array(
1988          'post_type'              => 'custom_css',
1989          'post_status'            => get_post_stati(),
1990          'name'                   => sanitize_title( $stylesheet ),
1991          'posts_per_page'         => 1,
1992          'no_found_rows'          => true,
1993          'cache_results'          => true,
1994          'update_post_meta_cache' => false,
1995          'update_post_term_cache' => false,
1996          'lazy_load_term_meta'    => false,
1997      );
1998  
1999      $post = null;
2000      if ( get_stylesheet() === $stylesheet ) {
2001          $post_id = get_theme_mod( 'custom_css_post_id' );
2002  
2003          if ( $post_id > 0 && get_post( $post_id ) ) {
2004              $post = get_post( $post_id );
2005          }
2006  
2007          // `-1` indicates no post exists; no query necessary.
2008          if ( ! $post && -1 !== $post_id ) {
2009              $query = new WP_Query( $custom_css_query_vars );
2010              $post  = $query->post;
2011              /*
2012               * Cache the lookup. See wp_update_custom_css_post().
2013               * @todo This should get cleared if a custom_css post is added/removed.
2014               */
2015              set_theme_mod( 'custom_css_post_id', $post ? $post->ID : -1 );
2016          }
2017      } else {
2018          $query = new WP_Query( $custom_css_query_vars );
2019          $post  = $query->post;
2020      }
2021  
2022      return $post;
2023  }
2024  
2025  /**
2026   * Fetches the saved Custom CSS content for rendering.
2027   *
2028   * @since 4.7.0
2029   *
2030   * @param string $stylesheet Optional. A theme object stylesheet name. Defaults to the active theme.
2031   * @return string The Custom CSS Post content.
2032   */
2033  function wp_get_custom_css( $stylesheet = '' ) {
2034      $css = '';
2035  
2036      if ( empty( $stylesheet ) ) {
2037          $stylesheet = get_stylesheet();
2038      }
2039  
2040      $post = wp_get_custom_css_post( $stylesheet );
2041      if ( $post ) {
2042          $css = $post->post_content;
2043      }
2044  
2045      /**
2046       * Filters the custom CSS output into the head element.
2047       *
2048       * @since 4.7.0
2049       *
2050       * @param string $css        CSS pulled in from the Custom CSS post type.
2051       * @param string $stylesheet The theme stylesheet name.
2052       */
2053      $css = apply_filters( 'wp_get_custom_css', $css, $stylesheet );
2054  
2055      return $css;
2056  }
2057  
2058  /**
2059   * Updates the `custom_css` post for a given theme.
2060   *
2061   * Inserts a `custom_css` post when one doesn't yet exist.
2062   *
2063   * @since 4.7.0
2064   *
2065   * @param string $css CSS, stored in `post_content`.
2066   * @param array  $args {
2067   *     Args.
2068   *
2069   *     @type string $preprocessed Optional. Pre-processed CSS, stored in `post_content_filtered`.
2070   *                                Normally empty string.
2071   *     @type string $stylesheet   Optional. Stylesheet (child theme) to update.
2072   *                                Defaults to active theme/stylesheet.
2073   * }
2074   * @return WP_Post|WP_Error Post on success, error on failure.
2075   */
2076  function wp_update_custom_css_post( $css, $args = array() ) {
2077      $args = wp_parse_args(
2078          $args,
2079          array(
2080              'preprocessed' => '',
2081              'stylesheet'   => get_stylesheet(),
2082          )
2083      );
2084  
2085      $data = array(
2086          'css'          => $css,
2087          'preprocessed' => $args['preprocessed'],
2088      );
2089  
2090      /**
2091       * Filters the `css` (`post_content`) and `preprocessed` (`post_content_filtered`) args
2092       * for a `custom_css` post being updated.
2093       *
2094       * This filter can be used by plugin that offer CSS pre-processors, to store the original
2095       * pre-processed CSS in `post_content_filtered` and then store processed CSS in `post_content`.
2096       * When used in this way, the `post_content_filtered` should be supplied as the setting value
2097       * instead of `post_content` via a the `customize_value_custom_css` filter, for example:
2098       *
2099       * <code>
2100       * add_filter( 'customize_value_custom_css', function( $value, $setting ) {
2101       *     $post = wp_get_custom_css_post( $setting->stylesheet );
2102       *     if ( $post && ! empty( $post->post_content_filtered ) ) {
2103       *         $css = $post->post_content_filtered;
2104       *     }
2105       *     return $css;
2106       * }, 10, 2 );
2107       * </code>
2108       *
2109       * @since 4.7.0
2110       * @param array $data {
2111       *     Custom CSS data.
2112       *
2113       *     @type string $css          CSS stored in `post_content`.
2114       *     @type string $preprocessed Pre-processed CSS stored in `post_content_filtered`.
2115       *                                Normally empty string.
2116       * }
2117       * @param array $args {
2118       *     The args passed into `wp_update_custom_css_post()` merged with defaults.
2119       *
2120       *     @type string $css          The original CSS passed in to be updated.
2121       *     @type string $preprocessed The original preprocessed CSS passed in to be updated.
2122       *     @type string $stylesheet   The stylesheet (theme) being updated.
2123       * }
2124       */
2125      $data = apply_filters( 'update_custom_css_data', $data, array_merge( $args, compact( 'css' ) ) );
2126  
2127      $post_data = array(
2128          'post_title'            => $args['stylesheet'],
2129          'post_name'             => sanitize_title( $args['stylesheet'] ),
2130          'post_type'             => 'custom_css',
2131          'post_status'           => 'publish',
2132          'post_content'          => $data['css'],
2133          'post_content_filtered' => $data['preprocessed'],
2134      );
2135  
2136      // Update post if it already exists, otherwise create a new one.
2137      $post = wp_get_custom_css_post( $args['stylesheet'] );
2138      if ( $post ) {
2139          $post_data['ID'] = $post->ID;
2140          $r               = wp_update_post( wp_slash( $post_data ), true );
2141      } else {
2142          $r = wp_insert_post( wp_slash( $post_data ), true );
2143  
2144          if ( ! is_wp_error( $r ) ) {
2145              if ( get_stylesheet() === $args['stylesheet'] ) {
2146                  set_theme_mod( 'custom_css_post_id', $r );
2147              }
2148  
2149              // Trigger creation of a revision. This should be removed once #30854 is resolved.
2150              $revisions = wp_get_latest_revision_id_and_total_count( $r );
2151              if ( ! is_wp_error( $revisions ) && 0 === $revisions['count'] ) {
2152                  wp_save_post_revision( $r );
2153              }
2154          }
2155      }
2156  
2157      if ( is_wp_error( $r ) ) {
2158          return $r;
2159      }
2160      return get_post( $r );
2161  }
2162  
2163  /**
2164   * Adds callback for custom TinyMCE editor stylesheets.
2165   *
2166   * The parameter $stylesheet is the name of the stylesheet, relative to
2167   * the theme root. It also accepts an array of stylesheets.
2168   * It is optional and defaults to 'editor-style.css'.
2169   *
2170   * This function automatically adds another stylesheet with -rtl prefix, e.g. editor-style-rtl.css.
2171   * If that file doesn't exist, it is removed before adding the stylesheet(s) to TinyMCE.
2172   * If an array of stylesheets is passed to add_editor_style(),
2173   * RTL is only added for the first stylesheet.
2174   *
2175   * Since version 3.4 the TinyMCE body has .rtl CSS class.
2176   * It is a better option to use that class and add any RTL styles to the main stylesheet.
2177   *
2178   * @since 3.0.0
2179   *
2180   * @global array $editor_styles
2181   *
2182   * @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
2183   *                                 Defaults to 'editor-style.css'
2184   */
2185  function add_editor_style( $stylesheet = 'editor-style.css' ) {
2186      global $editor_styles;
2187  
2188      add_theme_support( 'editor-style' );
2189  
2190      $editor_styles = (array) $editor_styles;
2191      $stylesheet    = (array) $stylesheet;
2192  
2193      if ( is_rtl() ) {
2194          $rtl_stylesheet = str_replace( '.css', '-rtl.css', $stylesheet[0] );
2195          $stylesheet[]   = $rtl_stylesheet;
2196      }
2197  
2198      $editor_styles = array_merge( $editor_styles, $stylesheet );
2199  }
2200  
2201  /**
2202   * Removes all visual editor stylesheets.
2203   *
2204   * @since 3.1.0
2205   *
2206   * @global array $editor_styles
2207   *
2208   * @return bool True on success, false if there were no stylesheets to remove.
2209   */
2210  function remove_editor_styles() {
2211      if ( ! current_theme_supports( 'editor-style' ) ) {
2212          return false;
2213      }
2214      _remove_theme_support( 'editor-style' );
2215      if ( is_admin() ) {
2216          $GLOBALS['editor_styles'] = array();
2217      }
2218      return true;
2219  }
2220  
2221  /**
2222   * Retrieves any registered editor stylesheet URLs.
2223   *
2224   * @since 4.0.0
2225   *
2226   * @global array $editor_styles Registered editor stylesheets
2227   *
2228   * @return string[] If registered, a list of editor stylesheet URLs.
2229   */
2230  function get_editor_stylesheets() {
2231      $stylesheets = array();
2232      // Load editor_style.css if the active theme supports it.
2233      if ( ! empty( $GLOBALS['editor_styles'] ) && is_array( $GLOBALS['editor_styles'] ) ) {
2234          $editor_styles = $GLOBALS['editor_styles'];
2235  
2236          $editor_styles = array_unique( array_filter( $editor_styles ) );
2237          $style_uri     = get_stylesheet_directory_uri();
2238          $style_dir     = get_stylesheet_directory();
2239  
2240          // Support externally referenced styles (like, say, fonts).
2241          foreach ( $editor_styles as $key => $file ) {
2242              if ( preg_match( '~^(https?:)?//~', $file ) ) {
2243                  $stylesheets[] = sanitize_url( $file );
2244                  unset( $editor_styles[ $key ] );
2245              }
2246          }
2247  
2248          // Look in a parent theme first, that way child theme CSS overrides.
2249          if ( is_child_theme() ) {
2250              $template_uri = get_template_directory_uri();
2251              $template_dir = get_template_directory();
2252  
2253              foreach ( $editor_styles as $key => $file ) {
2254                  if ( $file && file_exists( "$template_dir/$file" ) ) {
2255                      $stylesheets[] = "$template_uri/$file";
2256                  }
2257              }
2258          }
2259  
2260          foreach ( $editor_styles as $file ) {
2261              if ( $file && file_exists( "$style_dir/$file" ) ) {
2262                  $stylesheets[] = "$style_uri/$file";
2263              }
2264          }
2265      }
2266  
2267      /**
2268       * Filters the array of URLs of stylesheets applied to the editor.
2269       *
2270       * @since 4.3.0
2271       *
2272       * @param string[] $stylesheets Array of URLs of stylesheets to be applied to the editor.
2273       */
2274      return apply_filters( 'editor_stylesheets', $stylesheets );
2275  }
2276  
2277  /**
2278   * Expands a theme's starter content configuration using core-provided data.
2279   *
2280   * @since 4.7.0
2281   *
2282   * @return array Array of starter content.
2283   */
2284  function get_theme_starter_content() {
2285      $theme_support = get_theme_support( 'starter-content' );
2286      if ( is_array( $theme_support ) && ! empty( $theme_support[0] ) && is_array( $theme_support[0] ) ) {
2287          $config = $theme_support[0];
2288      } else {
2289          $config = array();
2290      }
2291  
2292      $core_content = array(
2293          'widgets'   => array(
2294              'text_business_info' => array(
2295                  'text',
2296                  array(
2297                      'title'  => _x( 'Find Us', 'Theme starter content' ),
2298                      'text'   => implode(
2299                          '',
2300                          array(
2301                              '<strong>' . _x( 'Address', 'Theme starter content' ) . "</strong>\n",
2302                              _x( '123 Main Street', 'Theme starter content' ) . "\n",
2303                              _x( 'New York, NY 10001', 'Theme starter content' ) . "\n\n",
2304                              '<strong>' . _x( 'Hours', 'Theme starter content' ) . "</strong>\n",
2305                              _x( 'Monday&ndash;Friday: 9:00AM&ndash;5:00PM', 'Theme starter content' ) . "\n",
2306                              _x( 'Saturday &amp; Sunday: 11:00AM&ndash;3:00PM', 'Theme starter content' ),
2307                          )
2308                      ),
2309                      'filter' => true,
2310                      'visual' => true,
2311                  ),
2312              ),
2313              'text_about'         => array(
2314                  'text',
2315                  array(
2316                      'title'  => _x( 'About This Site', 'Theme starter content' ),
2317                      'text'   => _x( 'This may be a good place to introduce yourself and your site or include some credits.', 'Theme starter content' ),
2318                      'filter' => true,
2319                      'visual' => true,
2320                  ),
2321              ),
2322              'archives'           => array(
2323                  'archives',
2324                  array(
2325                      'title' => _x( 'Archives', 'Theme starter content' ),
2326                  ),
2327              ),
2328              'calendar'           => array(
2329                  'calendar',
2330                  array(
2331                      'title' => _x( 'Calendar', 'Theme starter content' ),
2332                  ),
2333              ),
2334              'categories'         => array(
2335                  'categories',
2336                  array(
2337                      'title' => _x( 'Categories', 'Theme starter content' ),
2338                  ),
2339              ),
2340              'meta'               => array(
2341                  'meta',
2342                  array(
2343                      'title' => _x( 'Meta', 'Theme starter content' ),
2344                  ),
2345              ),
2346              'recent-comments'    => array(
2347                  'recent-comments',
2348                  array(
2349                      'title' => _x( 'Recent Comments', 'Theme starter content' ),
2350                  ),
2351              ),
2352              'recent-posts'       => array(
2353                  'recent-posts',
2354                  array(
2355                      'title' => _x( 'Recent Posts', 'Theme starter content' ),
2356                  ),
2357              ),
2358              'search'             => array(
2359                  'search',
2360                  array(
2361                      'title' => _x( 'Search', 'Theme starter content' ),
2362                  ),
2363              ),
2364          ),
2365          'nav_menus' => array(
2366              'link_home'       => array(
2367                  'type'  => 'custom',
2368                  'title' => _x( 'Home', 'Theme starter content' ),
2369                  'url'   => home_url( '/' ),
2370              ),
2371              'page_home'       => array( // Deprecated in favor of 'link_home'.
2372                  'type'      => 'post_type',
2373                  'object'    => 'page',
2374                  'object_id' => '{{home}}',
2375              ),
2376              'page_about'      => array(
2377                  'type'      => 'post_type',
2378                  'object'    => 'page',
2379                  'object_id' => '{{about}}',
2380              ),
2381              'page_blog'       => array(
2382                  'type'      => 'post_type',
2383                  'object'    => 'page',
2384                  'object_id' => '{{blog}}',
2385              ),
2386              'page_news'       => array(
2387                  'type'      => 'post_type',
2388                  'object'    => 'page',
2389                  'object_id' => '{{news}}',
2390              ),
2391              'page_contact'    => array(
2392                  'type'      => 'post_type',
2393                  'object'    => 'page',
2394                  'object_id' => '{{contact}}',
2395              ),
2396  
2397              'link_email'      => array(
2398                  'title' => _x( 'Email', 'Theme starter content' ),
2399                  'url'   => 'mailto:wordpress@example.com',
2400              ),
2401              'link_facebook'   => array(
2402                  'title' => _x( 'Facebook', 'Theme starter content' ),
2403                  'url'   => 'https://www.facebook.com/wordpress',
2404              ),
2405              'link_foursquare' => array(
2406                  'title' => _x( 'Foursquare', 'Theme starter content' ),
2407                  'url'   => 'https://foursquare.com/',
2408              ),
2409              'link_github'     => array(
2410                  'title' => _x( 'GitHub', 'Theme starter content' ),
2411                  'url'   => 'https://github.com/wordpress/',
2412              ),
2413              'link_instagram'  => array(
2414                  'title' => _x( 'Instagram', 'Theme starter content' ),
2415                  'url'   => 'https://www.instagram.com/explore/tags/wordcamp/',
2416              ),
2417              'link_linkedin'   => array(
2418                  'title' => _x( 'LinkedIn', 'Theme starter content' ),
2419                  'url'   => 'https://www.linkedin.com/company/1089783',
2420              ),
2421              'link_pinterest'  => array(
2422                  'title' => _x( 'Pinterest', 'Theme starter content' ),
2423                  'url'   => 'https://www.pinterest.com/',
2424              ),
2425              'link_twitter'    => array(
2426                  'title' => _x( 'Twitter', 'Theme starter content' ),
2427                  'url'   => 'https://twitter.com/wordpress',
2428              ),
2429              'link_yelp'       => array(
2430                  'title' => _x( 'Yelp', 'Theme starter content' ),
2431                  'url'   => 'https://www.yelp.com',
2432              ),
2433              'link_youtube'    => array(
2434                  'title' => _x( 'YouTube', 'Theme starter content' ),
2435                  'url'   => 'https://www.youtube.com/channel/UCdof4Ju7amm1chz1gi1T2ZA',
2436              ),
2437          ),
2438          'posts'     => array(
2439              'home'             => array(
2440                  'post_type'    => 'page',
2441                  'post_title'   => _x( 'Home', 'Theme starter content' ),
2442                  'post_content' => sprintf(
2443                      "<!-- wp:paragraph -->\n<p>%s</p>\n<!-- /wp:paragraph -->",
2444                      _x( 'Welcome to your site! This is your homepage, which is what most visitors will see when they come to your site for the first time.', 'Theme starter content' )
2445                  ),
2446              ),
2447              'about'            => array(
2448                  'post_type'    => 'page',
2449                  'post_title'   => _x( 'About', 'Theme starter content' ),
2450                  'post_content' => sprintf(
2451                      "<!-- wp:paragraph -->\n<p>%s</p>\n<!-- /wp:paragraph -->",
2452                      _x( 'You might be an artist who would like to introduce yourself and your work here or maybe you are a business with a mission to describe.', 'Theme starter content' )
2453                  ),
2454              ),
2455              'contact'          => array(
2456                  'post_type'    => 'page',
2457                  'post_title'   => _x( 'Contact', 'Theme starter content' ),
2458                  'post_content' => sprintf(
2459                      "<!-- wp:paragraph -->\n<p>%s</p>\n<!-- /wp:paragraph -->",
2460                      _x( 'This is a page with some basic contact information, such as an address and phone number. You might also try a plugin to add a contact form.', 'Theme starter content' )
2461                  ),
2462              ),
2463              'blog'             => array(
2464                  'post_type'  => 'page',
2465                  'post_title' => _x( 'Blog', 'Theme starter content' ),
2466              ),
2467              'news'             => array(
2468                  'post_type'  => 'page',
2469                  'post_title' => _x( 'News', 'Theme starter content' ),
2470              ),
2471  
2472              'homepage-section' => array(
2473                  'post_type'    => 'page',
2474                  'post_title'   => _x( 'A homepage section', 'Theme starter content' ),
2475                  'post_content' => sprintf(
2476                      "<!-- wp:paragraph -->\n<p>%s</p>\n<!-- /wp:paragraph -->",
2477                      _x( 'This is an example of a homepage section. Homepage sections can be any page other than the homepage itself, including the page that shows your latest blog posts.', 'Theme starter content' )
2478                  ),
2479              ),
2480          ),
2481      );
2482  
2483      $content = array();
2484  
2485      foreach ( $config as $type => $args ) {
2486          switch ( $type ) {
2487              // Use options and theme_mods as-is.
2488              case 'options':
2489              case 'theme_mods':
2490                  $content[ $type ] = $config[ $type ];
2491                  break;
2492  
2493              // Widgets are grouped into sidebars.
2494              case 'widgets':
2495                  foreach ( $config[ $type ] as $sidebar_id => $widgets ) {
2496                      foreach ( $widgets as $id => $widget ) {
2497                          if ( is_array( $widget ) ) {
2498  
2499                              // Item extends core content.
2500                              if ( ! empty( $core_content[ $type ][ $id ] ) ) {
2501                                  $widget = array(
2502                                      $core_content[ $type ][ $id ][0],
2503                                      array_merge( $core_content[ $type ][ $id ][1], $widget ),
2504                                  );
2505                              }
2506  
2507                              $content[ $type ][ $sidebar_id ][] = $widget;
2508                          } elseif ( is_string( $widget )
2509                              && ! empty( $core_content[ $type ] )
2510                              && ! empty( $core_content[ $type ][ $widget ] )
2511                          ) {
2512                              $content[ $type ][ $sidebar_id ][] = $core_content[ $type ][ $widget ];
2513                          }
2514                      }
2515                  }
2516                  break;
2517  
2518              // And nav menu items are grouped into nav menus.
2519              case 'nav_menus':
2520                  foreach ( $config[ $type ] as $nav_menu_location => $nav_menu ) {
2521  
2522                      // Ensure nav menus get a name.
2523                      if ( empty( $nav_menu['name'] ) ) {
2524                          $nav_menu['name'] = $nav_menu_location;
2525                      }
2526  
2527                      $content[ $type ][ $nav_menu_location ]['name'] = $nav_menu['name'];
2528  
2529                      foreach ( $nav_menu['items'] as $id => $nav_menu_item ) {
2530                          if ( is_array( $nav_menu_item ) ) {
2531  
2532                              // Item extends core content.
2533                              if ( ! empty( $core_content[ $type ][ $id ] ) ) {
2534                                  $nav_menu_item = array_merge( $core_content[ $type ][ $id ], $nav_menu_item );
2535                              }
2536  
2537                              $content[ $type ][ $nav_menu_location ]['items'][] = $nav_menu_item;
2538                          } elseif ( is_string( $nav_menu_item )
2539                              && ! empty( $core_content[ $type ] )
2540                              && ! empty( $core_content[ $type ][ $nav_menu_item ] )
2541                          ) {
2542                              $content[ $type ][ $nav_menu_location ]['items'][] = $core_content[ $type ][ $nav_menu_item ];
2543                          }
2544                      }
2545                  }
2546                  break;
2547  
2548              // Attachments are posts but have special treatment.
2549              case 'attachments':
2550                  foreach ( $config[ $type ] as $id => $item ) {
2551                      if ( ! empty( $item['file'] ) ) {
2552                          $content[ $type ][ $id ] = $item;
2553                      }
2554                  }
2555                  break;
2556  
2557              /*
2558               * All that's left now are posts (besides attachments).
2559               * Not a default case for the sake of clarity and future work.
2560               */
2561              case 'posts':
2562                  foreach ( $config[ $type ] as $id => $item ) {
2563                      if ( is_array( $item ) ) {
2564  
2565                          // Item extends core content.
2566                          if ( ! empty( $core_content[ $type ][ $id ] ) ) {
2567                              $item = array_merge( $core_content[ $type ][ $id ], $item );
2568                          }
2569  
2570                          // Enforce a subset of fields.
2571                          $content[ $type ][ $id ] = wp_array_slice_assoc(
2572                              $item,
2573                              array(
2574                                  'post_type',
2575                                  'post_title',
2576                                  'post_excerpt',
2577                                  'post_name',
2578                                  'post_content',
2579                                  'menu_order',
2580                                  'comment_status',
2581                                  'thumbnail',
2582                                  'template',
2583                              )
2584                          );
2585                      } elseif ( is_string( $item ) && ! empty( $core_content[ $type ][ $item ] ) ) {
2586                          $content[ $type ][ $item ] = $core_content[ $type ][ $item ];
2587                      }
2588                  }
2589                  break;
2590          }
2591      }
2592  
2593      /**
2594       * Filters the expanded array of starter content.
2595       *
2596       * @since 4.7.0
2597       *
2598       * @param array $content Array of starter content.
2599       * @param array $config  Array of theme-specific starter content configuration.
2600       */
2601      return apply_filters( 'get_theme_starter_content', $content, $config );
2602  }
2603  
2604  /**
2605   * Registers theme support for a given feature.
2606   *
2607   * Must be called in the theme's functions.php file to work.
2608   * If attached to a hook, it must be {@see 'after_setup_theme'}.
2609   * The {@see 'init'} hook may be too late for some features.
2610   *
2611   * Example usage:
2612   *
2613   *     add_theme_support( 'title-tag' );
2614   *     add_theme_support( 'custom-logo', array(
2615   *         'height' => 480,
2616   *         'width'  => 720,
2617   *     ) );
2618   *
2619   * @since 2.9.0
2620   * @since 3.4.0 The `custom-header-uploads` feature was deprecated.
2621   * @since 3.6.0 The `html5` feature was added.
2622   * @since 3.6.1 The `html5` feature requires an array of types to be passed. Defaults to
2623   *              'comment-list', 'comment-form', 'search-form' for backward compatibility.
2624   * @since 3.9.0 The `html5` feature now also accepts 'gallery' and 'caption'.
2625   * @since 4.1.0 The `title-tag` feature was added.
2626   * @since 4.5.0 The `customize-selective-refresh-widgets` feature was added.
2627   * @since 4.7.0 The `starter-content` feature was added.
2628   * @since 5.0.0 The `responsive-embeds`, `align-wide`, `dark-editor-style`, `disable-custom-colors`,
2629   *              `disable-custom-font-sizes`, `editor-color-palette`, `editor-font-sizes`,
2630   *              `editor-styles`, and `wp-block-styles` features were added.
2631   * @since 5.3.0 The `html5` feature now also accepts 'script' and 'style'.
2632   * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
2633   *              by adding it to the function signature.
2634   * @since 5.4.0 The `disable-custom-gradients` feature limits to default gradients or gradients added
2635   *              through `editor-gradient-presets` theme support.
2636   * @since 5.5.0 The `core-block-patterns` feature was added and is enabled by default.
2637   * @since 5.5.0 The `custom-logo` feature now also accepts 'unlink-homepage-logo'.
2638   * @since 5.6.0 The `post-formats` feature warns if no array is passed as the second parameter.
2639   * @since 5.8.0 The `widgets-block-editor` feature enables the Widgets block editor.
2640   * @since 5.8.0 The `block-templates` feature indicates whether a theme uses block-based templates.
2641   * @since 6.0.0 The `html5` feature warns if no array is passed as the second parameter.
2642   * @since 6.1.0 The `block-template-parts` feature allows to edit any reusable template part from site editor.
2643   * @since 6.1.0 The `disable-layout-styles` feature disables the default layout styles.
2644   * @since 6.3.0 The `link-color` feature allows to enable the link color setting.
2645   * @since 6.3.0 The `border` feature allows themes without theme.json to add border styles to blocks.
2646   * @since 6.5.0 The `appearance-tools` feature enables a few design tools for blocks,
2647   *              see `WP_Theme_JSON::APPEARANCE_TOOLS_OPT_INS` for a complete list.
2648   * @since 6.6.0 The `editor-spacing-sizes` feature was added.
2649   * @since 7.0.0 The `html5` feature's 'script' and 'style' arguments are deprecated and unused.
2650   *
2651   * @global array $_wp_theme_features
2652   *
2653   * @param string $feature The feature being added. Likely core values include:
2654   *                          - 'admin-bar'
2655   *                          - 'align-wide'
2656   *                          - 'appearance-tools'
2657   *                          - 'automatic-feed-links'
2658   *                          - 'block-templates'
2659   *                          - 'block-template-parts'
2660   *                          - 'border'
2661   *                          - 'core-block-patterns'
2662   *                          - 'custom-background'
2663   *                          - 'custom-header'
2664   *                          - 'custom-line-height'
2665   *                          - 'custom-logo'
2666   *                          - 'customize-selective-refresh-widgets'
2667   *                          - 'custom-spacing'
2668   *                          - 'custom-units'
2669   *                          - 'dark-editor-style'
2670   *                          - 'disable-custom-colors'
2671   *                          - 'disable-custom-font-sizes'
2672   *                          - 'disable-custom-gradients'
2673   *                          - 'disable-layout-styles'
2674   *                          - 'editor-color-palette'
2675   *                          - 'editor-gradient-presets'
2676   *                          - 'editor-font-sizes'
2677   *                          - 'editor-spacing-sizes'
2678   *                          - 'editor-styles'
2679   *                          - 'featured-content'
2680   *                          - 'html5'
2681   *                          - 'link-color'
2682   *                          - 'menus'
2683   *                          - 'post-formats'
2684   *                          - 'post-thumbnails'
2685   *                          - 'responsive-embeds'
2686   *                          - 'starter-content'
2687   *                          - 'title-tag'
2688   *                          - 'widgets'
2689   *                          - 'widgets-block-editor'
2690   *                          - 'wp-block-styles'
2691   * @param mixed  ...$args Optional extra arguments to pass along with certain features.
2692   * @return void|false Void on success, false on failure.
2693   */
2694  function add_theme_support( $feature, ...$args ) {
2695      global $_wp_theme_features;
2696  
2697      if ( ! $args ) {
2698          $args = true;
2699      }
2700  
2701      switch ( $feature ) {
2702          case 'post-thumbnails':
2703              // All post types are already supported.
2704              if ( true === get_theme_support( 'post-thumbnails' ) ) {
2705                  return;
2706              }
2707  
2708              /*
2709               * Merge post types with any that already declared their support
2710               * for post thumbnails.
2711               */
2712              if ( isset( $args[0] ) && is_array( $args[0] ) && isset( $_wp_theme_features['post-thumbnails'] ) ) {
2713                  $args[0] = array_unique( array_merge( $_wp_theme_features['post-thumbnails'][0], $args[0] ) );
2714              }
2715  
2716              break;
2717  
2718          case 'post-formats':
2719              if ( isset( $args[0] ) && is_array( $args[0] ) ) {
2720                  $post_formats = get_post_format_slugs();
2721                  unset( $post_formats['standard'] );
2722  
2723                  $args[0] = array_intersect( $args[0], array_keys( $post_formats ) );
2724              } else {
2725                  _doing_it_wrong(
2726                      "add_theme_support( 'post-formats' )",
2727                      __( 'You need to pass an array of post formats.' ),
2728                      '5.6.0'
2729                  );
2730                  return false;
2731              }
2732              break;
2733  
2734          case 'html5':
2735              // You can't just pass 'html5', you need to pass an array of types.
2736              if ( empty( $args[0] ) || ! is_array( $args[0] ) ) {
2737                  _doing_it_wrong(
2738                      "add_theme_support( 'html5' )",
2739                      __( 'You need to pass an array of types.' ),
2740                      '3.6.1'
2741                  );
2742  
2743                  if ( ! empty( $args[0] ) && ! is_array( $args[0] ) ) {
2744                      return false;
2745                  }
2746  
2747                  // Build an array of types for back-compat.
2748                  $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
2749              }
2750  
2751              // Calling 'html5' again merges, rather than overwrites.
2752              if ( isset( $_wp_theme_features['html5'] ) ) {
2753                  $args[0] = array_merge( $_wp_theme_features['html5'][0], $args[0] );
2754              }
2755              break;
2756  
2757          case 'custom-logo':
2758              if ( true === $args ) {
2759                  $args = array( 0 => array() );
2760              }
2761              $defaults = array(
2762                  'width'                => null,
2763                  'height'               => null,
2764                  'flex-width'           => false,
2765                  'flex-height'          => false,
2766                  'header-text'          => '',
2767                  'unlink-homepage-logo' => false,
2768              );
2769              $args[0]  = wp_parse_args( array_intersect_key( $args[0], $defaults ), $defaults );
2770  
2771              // Allow full flexibility if no size is specified.
2772              if ( is_null( $args[0]['width'] ) && is_null( $args[0]['height'] ) ) {
2773                  $args[0]['flex-width']  = true;
2774                  $args[0]['flex-height'] = true;
2775              }
2776              break;
2777  
2778          case 'custom-header-uploads':
2779              return add_theme_support( 'custom-header', array( 'uploads' => true ) );
2780  
2781          case 'custom-header':
2782              if ( true === $args ) {
2783                  $args = array( 0 => array() );
2784              }
2785  
2786              $defaults = array(
2787                  'default-image'          => '',
2788                  'random-default'         => false,
2789                  'width'                  => 0,
2790                  'height'                 => 0,
2791                  'flex-height'            => false,
2792                  'flex-width'             => false,
2793                  'default-text-color'     => '',
2794                  'header-text'            => true,
2795                  'uploads'                => true,
2796                  'wp-head-callback'       => '',
2797                  'admin-head-callback'    => '',
2798                  'admin-preview-callback' => '',
2799                  'video'                  => false,
2800                  'video-active-callback'  => 'is_front_page',
2801              );
2802  
2803              $jit = isset( $args[0]['__jit'] );
2804              unset( $args[0]['__jit'] );
2805  
2806              /*
2807               * Merge in data from previous add_theme_support() calls.
2808               * The first value registered wins. (A child theme is set up first.)
2809               */
2810              if ( isset( $_wp_theme_features['custom-header'] ) ) {
2811                  $args[0] = wp_parse_args( $_wp_theme_features['custom-header'][0], $args[0] );
2812              }
2813  
2814              /*
2815               * Load in the defaults at the end, as we need to insure first one wins.
2816               * This will cause all constants to be defined, as each arg will then be set to the default.
2817               */
2818              if ( $jit ) {
2819                  $args[0] = wp_parse_args( $args[0], $defaults );
2820              }
2821  
2822              /*
2823               * If a constant was defined, use that value. Otherwise, define the constant to ensure
2824               * the constant is always accurate (and is not defined later,  overriding our value).
2825               * As stated above, the first value wins.
2826               * Once we get to wp_loaded (just-in-time), define any constants we haven't already.
2827               * Constants should be avoided. Don't reference them. This is just for backward compatibility.
2828               */
2829  
2830              if ( defined( 'NO_HEADER_TEXT' ) ) {
2831                  $args[0]['header-text'] = ! NO_HEADER_TEXT;
2832              } elseif ( isset( $args[0]['header-text'] ) ) {
2833                  define( 'NO_HEADER_TEXT', empty( $args[0]['header-text'] ) );
2834              }
2835  
2836              if ( defined( 'HEADER_IMAGE_WIDTH' ) ) {
2837                  $args[0]['width'] = (int) HEADER_IMAGE_WIDTH;
2838              } elseif ( isset( $args[0]['width'] ) ) {
2839                  define( 'HEADER_IMAGE_WIDTH', (int) $args[0]['width'] );
2840              }
2841  
2842              if ( defined( 'HEADER_IMAGE_HEIGHT' ) ) {
2843                  $args[0]['height'] = (int) HEADER_IMAGE_HEIGHT;
2844              } elseif ( isset( $args[0]['height'] ) ) {
2845                  define( 'HEADER_IMAGE_HEIGHT', (int) $args[0]['height'] );
2846              }
2847  
2848              if ( defined( 'HEADER_TEXTCOLOR' ) ) {
2849                  $args[0]['default-text-color'] = HEADER_TEXTCOLOR;
2850              } elseif ( isset( $args[0]['default-text-color'] ) ) {
2851                  define( 'HEADER_TEXTCOLOR', $args[0]['default-text-color'] );
2852              }
2853  
2854              if ( defined( 'HEADER_IMAGE' ) ) {
2855                  $args[0]['default-image'] = HEADER_IMAGE;
2856              } elseif ( isset( $args[0]['default-image'] ) ) {
2857                  define( 'HEADER_IMAGE', $args[0]['default-image'] );
2858              }
2859  
2860              if ( $jit && ! empty( $args[0]['default-image'] ) ) {
2861                  $args[0]['random-default'] = false;
2862              }
2863  
2864              /*
2865               * If headers are supported, and we still don't have a defined width or height,
2866               * we have implicit flex sizes.
2867               */
2868              if ( $jit ) {
2869                  if ( empty( $args[0]['width'] ) && empty( $args[0]['flex-width'] ) ) {
2870                      $args[0]['flex-width'] = true;
2871                  }
2872                  if ( empty( $args[0]['height'] ) && empty( $args[0]['flex-height'] ) ) {
2873                      $args[0]['flex-height'] = true;
2874                  }
2875              }
2876  
2877              break;
2878  
2879          case 'custom-background':
2880              if ( true === $args ) {
2881                  $args = array( 0 => array() );
2882              }
2883  
2884              $defaults = array(
2885                  'default-image'          => '',
2886                  'default-preset'         => 'default',
2887                  'default-position-x'     => 'left',
2888                  'default-position-y'     => 'top',
2889                  'default-size'           => 'auto',
2890                  'default-repeat'         => 'repeat',
2891                  'default-attachment'     => 'scroll',
2892                  'default-color'          => '',
2893                  'wp-head-callback'       => '_custom_background_cb',
2894                  'admin-head-callback'    => '',
2895                  'admin-preview-callback' => '',
2896              );
2897  
2898              $jit = isset( $args[0]['__jit'] );
2899              unset( $args[0]['__jit'] );
2900  
2901              // Merge in data from previous add_theme_support() calls. The first value registered wins.
2902              if ( isset( $_wp_theme_features['custom-background'] ) ) {
2903                  $args[0] = wp_parse_args( $_wp_theme_features['custom-background'][0], $args[0] );
2904              }
2905  
2906              if ( $jit ) {
2907                  $args[0] = wp_parse_args( $args[0], $defaults );
2908              }
2909  
2910              if ( defined( 'BACKGROUND_COLOR' ) ) {
2911                  $args[0]['default-color'] = BACKGROUND_COLOR;
2912              } elseif ( isset( $args[0]['default-color'] ) || $jit ) {
2913                  define( 'BACKGROUND_COLOR', $args[0]['default-color'] );
2914              }
2915  
2916              if ( defined( 'BACKGROUND_IMAGE' ) ) {
2917                  $args[0]['default-image'] = BACKGROUND_IMAGE;
2918              } elseif ( isset( $args[0]['default-image'] ) || $jit ) {
2919                  define( 'BACKGROUND_IMAGE', $args[0]['default-image'] );
2920              }
2921  
2922              break;
2923  
2924          // Ensure that 'title-tag' is accessible in the admin.
2925          case 'title-tag':
2926              // Can be called in functions.php but must happen before wp_loaded, i.e. not in header.php.
2927              if ( did_action( 'wp_loaded' ) ) {
2928                  _doing_it_wrong(
2929                      "add_theme_support( 'title-tag' )",
2930                      sprintf(
2931                          /* translators: 1: title-tag, 2: wp_loaded */
2932                          __( 'Theme support for %1$s should be registered before the %2$s hook.' ),
2933                          '<code>title-tag</code>',
2934                          '<code>wp_loaded</code>'
2935                      ),
2936                      '4.1.0'
2937                  );
2938  
2939                  return false;
2940              }
2941      }
2942  
2943      $_wp_theme_features[ $feature ] = $args;
2944  }
2945  
2946  /**
2947   * Registers the internal custom header and background routines.
2948   *
2949   * @since 3.4.0
2950   * @access private
2951   *
2952   * @global Custom_Image_Header $custom_image_header
2953   * @global Custom_Background   $custom_background
2954   */
2955  function _custom_header_background_just_in_time() {
2956      global $custom_image_header, $custom_background;
2957  
2958      if ( current_theme_supports( 'custom-header' ) ) {
2959          // In case any constants were defined after an add_custom_image_header() call, re-run.
2960          add_theme_support( 'custom-header', array( '__jit' => true ) );
2961  
2962          $args = get_theme_support( 'custom-header' );
2963          if ( $args[0]['wp-head-callback'] ) {
2964              add_action( 'wp_head', $args[0]['wp-head-callback'] );
2965          }
2966  
2967          if ( is_admin() ) {
2968              require_once  ABSPATH . 'wp-admin/includes/class-custom-image-header.php';
2969              $custom_image_header = new Custom_Image_Header( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
2970          }
2971      }
2972  
2973      if ( current_theme_supports( 'custom-background' ) ) {
2974          // In case any constants were defined after an add_custom_background() call, re-run.
2975          add_theme_support( 'custom-background', array( '__jit' => true ) );
2976  
2977          $args = get_theme_support( 'custom-background' );
2978          add_action( 'wp_head', $args[0]['wp-head-callback'] );
2979  
2980          if ( is_admin() ) {
2981              require_once  ABSPATH . 'wp-admin/includes/class-custom-background.php';
2982              $custom_background = new Custom_Background( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] );
2983          }
2984      }
2985  }
2986  
2987  /**
2988   * Adds CSS to hide header text for custom logo, based on Customizer setting.
2989   *
2990   * @since 4.5.0
2991   * @access private
2992   */
2993  function _custom_logo_header_styles() {
2994      if ( ! current_theme_supports( 'custom-header', 'header-text' )
2995          && get_theme_support( 'custom-logo', 'header-text' )
2996          && ! get_theme_mod( 'header_text', true )
2997      ) {
2998          $classes = (array) get_theme_support( 'custom-logo', 'header-text' );
2999          $classes = array_map( 'sanitize_html_class', $classes );
3000          $classes = '.' . implode( ', .', $classes );
3001          ?>
3002          <!-- Custom Logo: hide header text -->
3003          <style id="custom-logo-css">
3004              <?php echo $classes; ?> {
3005                  position: absolute;
3006                  clip-path: inset(50%);
3007              }
3008          </style>
3009          <?php
3010      }
3011  }
3012  
3013  /**
3014   * Gets the theme support arguments passed when registering that support.
3015   *
3016   * Example usage:
3017   *
3018   *     get_theme_support( 'custom-logo' );
3019   *     get_theme_support( 'custom-header', 'width' );
3020   *
3021   * @since 3.1.0
3022   * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
3023   *              by adding it to the function signature.
3024   *
3025   * @global array $_wp_theme_features
3026   *
3027   * @param string $feature The feature to check. See add_theme_support() for the list
3028   *                        of possible values.
3029   * @param mixed  ...$args Optional extra arguments to be checked against certain features.
3030   * @return mixed The array of extra arguments or the value for the registered feature.
3031   */
3032  function get_theme_support( $feature, ...$args ) {
3033      global $_wp_theme_features;
3034  
3035      if ( ! isset( $_wp_theme_features[ $feature ] ) ) {
3036          return false;
3037      }
3038  
3039      if ( ! $args ) {
3040          return $_wp_theme_features[ $feature ];
3041      }
3042  
3043      switch ( $feature ) {
3044          case 'custom-logo':
3045          case 'custom-header':
3046          case 'custom-background':
3047              return $_wp_theme_features[ $feature ][0][ $args[0] ] ?? false;
3048  
3049          default:
3050              return $_wp_theme_features[ $feature ];
3051      }
3052  }
3053  
3054  /**
3055   * Allows a theme to de-register its support of a certain feature
3056   *
3057   * Should be called in the theme's functions.php file. Generally would
3058   * be used for child themes to override support from the parent theme.
3059   *
3060   * @since 3.0.0
3061   *
3062   * @see add_theme_support()
3063   *
3064   * @param string $feature The feature being removed. See add_theme_support() for the list
3065   *                        of possible values.
3066   * @return bool Whether feature was removed.
3067   */
3068  function remove_theme_support( $feature ) {
3069      // Do not remove internal registrations that are not used directly by themes.
3070      if ( in_array( $feature, array( 'editor-style', 'widgets', 'menus' ), true ) ) {
3071          return false;
3072      }
3073  
3074      return _remove_theme_support( $feature );
3075  }
3076  
3077  /**
3078   * Do not use. Removes theme support internally without knowledge of those not used
3079   * by themes directly.
3080   *
3081   * @access private
3082   * @since 3.1.0
3083   * @global array               $_wp_theme_features
3084   * @global Custom_Image_Header $custom_image_header
3085   * @global Custom_Background   $custom_background
3086   *
3087   * @param string $feature The feature being removed. See add_theme_support() for the list
3088   *                        of possible values.
3089   * @return bool True if support was removed, false if the feature was not registered.
3090   */
3091  function _remove_theme_support( $feature ) {
3092      global $_wp_theme_features;
3093  
3094      switch ( $feature ) {
3095          case 'custom-header-uploads':
3096              if ( ! isset( $_wp_theme_features['custom-header'] ) ) {
3097                  return false;
3098              }
3099              add_theme_support( 'custom-header', array( 'uploads' => false ) );
3100              return true; // Do not continue - custom-header-uploads no longer exists.
3101      }
3102  
3103      if ( ! isset( $_wp_theme_features[ $feature ] ) ) {
3104          return false;
3105      }
3106  
3107      switch ( $feature ) {
3108          case 'custom-header':
3109              if ( ! did_action( 'wp_loaded' ) ) {
3110                  break;
3111              }
3112              $support = get_theme_support( 'custom-header' );
3113              if ( isset( $support[0]['wp-head-callback'] ) ) {
3114                  remove_action( 'wp_head', $support[0]['wp-head-callback'] );
3115              }
3116              if ( isset( $GLOBALS['custom_image_header'] ) ) {
3117                  remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
3118                  unset( $GLOBALS['custom_image_header'] );
3119              }
3120              break;
3121  
3122          case 'custom-background':
3123              if ( ! did_action( 'wp_loaded' ) ) {
3124                  break;
3125              }
3126              $support = get_theme_support( 'custom-background' );
3127              if ( isset( $support[0]['wp-head-callback'] ) ) {
3128                  remove_action( 'wp_head', $support[0]['wp-head-callback'] );
3129              }
3130              remove_action( 'admin_menu', array( $GLOBALS['custom_background'], 'init' ) );
3131              unset( $GLOBALS['custom_background'] );
3132              break;
3133      }
3134  
3135      unset( $_wp_theme_features[ $feature ] );
3136  
3137      return true;
3138  }
3139  
3140  /**
3141   * Checks a theme's support for a given feature.
3142   *
3143   * Example usage:
3144   *
3145   *     current_theme_supports( 'custom-logo' );
3146   *     current_theme_supports( 'html5', 'comment-form' );
3147   *
3148   * @since 2.9.0
3149   * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
3150   *              by adding it to the function signature.
3151   *
3152   * @global array $_wp_theme_features
3153   *
3154   * @param string $feature The feature being checked. See add_theme_support() for the list
3155   *                        of possible values.
3156   * @param mixed  ...$args Optional extra arguments to be checked against certain features.
3157   * @return bool True if the active theme supports the feature, false otherwise.
3158   */
3159  function current_theme_supports( $feature, ...$args ) {
3160      global $_wp_theme_features;
3161  
3162      if ( 'custom-header-uploads' === $feature ) {
3163          return current_theme_supports( 'custom-header', 'uploads' );
3164      }
3165  
3166      if ( ! isset( $_wp_theme_features[ $feature ] ) ) {
3167          return false;
3168      }
3169  
3170      // If no args passed then no extra checks need to be performed.
3171      if ( ! $args ) {
3172          /** This filter is documented in wp-includes/theme.php */
3173          return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
3174      }
3175  
3176      switch ( $feature ) {
3177          case 'post-thumbnails':
3178              /*
3179               * post-thumbnails can be registered for only certain content/post types
3180               * by passing an array of types to add_theme_support().
3181               * If no array was passed, then any type is accepted.
3182               */
3183              if ( true === $_wp_theme_features[ $feature ] ) {  // Registered for all types.
3184                  return true;
3185              }
3186              $content_type = $args[0];
3187              return in_array( $content_type, $_wp_theme_features[ $feature ][0], true );
3188  
3189          case 'html5':
3190          case 'post-formats':
3191              /*
3192               * Specific post formats can be registered by passing an array of types
3193               * to add_theme_support().
3194               *
3195               * Specific areas of HTML5 support *must* be passed via an array to add_theme_support().
3196               */
3197              $type = $args[0];
3198              return in_array( $type, $_wp_theme_features[ $feature ][0], true );
3199  
3200          case 'custom-logo':
3201          case 'custom-header':
3202          case 'custom-background':
3203              // Specific capabilities can be registered by passing an array to add_theme_support().
3204              return ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) && $_wp_theme_features[ $feature ][0][ $args[0] ] );
3205      }
3206  
3207      /**
3208       * Filters whether the active theme supports a specific feature.
3209       *
3210       * The dynamic portion of the hook name, `$feature`, refers to the specific
3211       * theme feature. See add_theme_support() for the list of possible values.
3212       *
3213       * @since 3.4.0
3214       *
3215       * @param bool   $supports Whether the active theme supports the given feature. Default true.
3216       * @param array  $args     Array of arguments for the feature.
3217       * @param string $feature  The theme feature.
3218       */
3219      return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
3220  }
3221  
3222  /**
3223   * Checks a theme's support for a given feature before loading the functions which implement it.
3224   *
3225   * @since 2.9.0
3226   *
3227   * @param string $feature The feature being checked. See add_theme_support() for the list
3228   *                        of possible values.
3229   * @param string $file    Path to the file.
3230   * @return bool True if the active theme supports the supplied feature, false otherwise.
3231   */
3232  function require_if_theme_supports( $feature, $file ) {
3233      if ( current_theme_supports( $feature ) ) {
3234          require $file;
3235          return true;
3236      }
3237      return false;
3238  }
3239  
3240  /**
3241   * Registers a theme feature for use in add_theme_support().
3242   *
3243   * This does not indicate that the active theme supports the feature, it only describes
3244   * the feature's supported options.
3245   *
3246   * @since 5.5.0
3247   *
3248   * @see add_theme_support()
3249   *
3250   * @global array $_wp_registered_theme_features
3251   *
3252   * @param string $feature The name uniquely identifying the feature. See add_theme_support()
3253   *                        for the list of possible values.
3254   * @param array  $args {
3255   *     Data used to describe the theme.
3256   *
3257   *     @type string     $type         The type of data associated with this feature.
3258   *                                    Valid values are 'string', 'boolean', 'integer',
3259   *                                    'number', 'array', and 'object'. Defaults to 'boolean'.
3260   *     @type bool       $variadic     Does this feature utilize the variadic support
3261   *                                    of add_theme_support(), or are all arguments specified
3262   *                                    as the second parameter. Must be used with the "array" type.
3263   *     @type string     $description  A short description of the feature. Included in
3264   *                                    the Themes REST API schema. Intended for developers.
3265   *     @type bool|array $show_in_rest {
3266   *         Whether this feature should be included in the Themes REST API endpoint.
3267   *         Defaults to not being included. When registering an 'array' or 'object' type,
3268   *         this argument must be an array with the 'schema' key.
3269   *
3270   *         @type array    $schema           Specifies the JSON Schema definition describing
3271   *                                          the feature. If any objects in the schema do not include
3272   *                                          the 'additionalProperties' keyword, it is set to false.
3273   *         @type string   $name             An alternate name to be used as the property name
3274   *                                          in the REST API.
3275   *         @type callable $prepare_callback A function used to format the theme support in the REST API.
3276   *                                          Receives the raw theme support value.
3277   *      }
3278   * }
3279   * @return true|WP_Error True if the theme feature was successfully registered, a WP_Error object if not.
3280   */
3281  function register_theme_feature( $feature, $args = array() ) {
3282      global $_wp_registered_theme_features;
3283  
3284      if ( ! is_array( $_wp_registered_theme_features ) ) {
3285          $_wp_registered_theme_features = array();
3286      }
3287  
3288      $defaults = array(
3289          'type'         => 'boolean',
3290          'variadic'     => false,
3291          'description'  => '',
3292          'show_in_rest' => false,
3293      );
3294  
3295      $args = wp_parse_args( $args, $defaults );
3296  
3297      if ( true === $args['show_in_rest'] ) {
3298          $args['show_in_rest'] = array();
3299      }
3300  
3301      if ( is_array( $args['show_in_rest'] ) ) {
3302          $args['show_in_rest'] = wp_parse_args(
3303              $args['show_in_rest'],
3304              array(
3305                  'schema'           => array(),
3306                  'name'             => $feature,
3307                  'prepare_callback' => null,
3308              )
3309          );
3310      }
3311  
3312      if ( ! in_array( $args['type'], array( 'string', 'boolean', 'integer', 'number', 'array', 'object' ), true ) ) {
3313          return new WP_Error(
3314              'invalid_type',
3315              __( 'The feature "type" is not valid JSON Schema type.' )
3316          );
3317      }
3318  
3319      if ( true === $args['variadic'] && 'array' !== $args['type'] ) {
3320          return new WP_Error(
3321              'variadic_must_be_array',
3322              __( 'When registering a "variadic" theme feature, the "type" must be an "array".' )
3323          );
3324      }
3325  
3326      if ( false !== $args['show_in_rest'] && in_array( $args['type'], array( 'array', 'object' ), true ) ) {
3327          if ( ! is_array( $args['show_in_rest'] ) || empty( $args['show_in_rest']['schema'] ) ) {
3328              return new WP_Error(
3329                  'missing_schema',
3330                  __( 'When registering an "array" or "object" feature to show in the REST API, the feature\'s schema must also be defined.' )
3331              );
3332          }
3333  
3334          if ( 'array' === $args['type'] && ! isset( $args['show_in_rest']['schema']['items'] ) ) {
3335              return new WP_Error(
3336                  'missing_schema_items',
3337                  __( 'When registering an "array" feature, the feature\'s schema must include the "items" keyword.' )
3338              );
3339          }
3340  
3341          if ( 'object' === $args['type'] && ! isset( $args['show_in_rest']['schema']['properties'] ) ) {
3342              return new WP_Error(
3343                  'missing_schema_properties',
3344                  __( 'When registering an "object" feature, the feature\'s schema must include the "properties" keyword.' )
3345              );
3346          }
3347      }
3348  
3349      if ( is_array( $args['show_in_rest'] ) ) {
3350          if ( isset( $args['show_in_rest']['prepare_callback'] )
3351              && ! is_callable( $args['show_in_rest']['prepare_callback'] )
3352          ) {
3353              return new WP_Error(
3354                  'invalid_rest_prepare_callback',
3355                  sprintf(
3356                      /* translators: %s: prepare_callback */
3357                      __( 'The "%s" must be a callable function.' ),
3358                      'prepare_callback'
3359                  )
3360              );
3361          }
3362  
3363          $args['show_in_rest']['schema'] = wp_parse_args(
3364              $args['show_in_rest']['schema'],
3365              array(
3366                  'description' => $args['description'],
3367                  'type'        => $args['type'],
3368                  'default'     => false,
3369              )
3370          );
3371  
3372          if ( is_bool( $args['show_in_rest']['schema']['default'] )
3373              && ! in_array( 'boolean', (array) $args['show_in_rest']['schema']['type'], true )
3374          ) {
3375              // Automatically include the "boolean" type when the default value is a boolean.
3376              $args['show_in_rest']['schema']['type'] = (array) $args['show_in_rest']['schema']['type'];
3377              array_unshift( $args['show_in_rest']['schema']['type'], 'boolean' );
3378          }
3379  
3380          $args['show_in_rest']['schema'] = rest_default_additional_properties_to_false( $args['show_in_rest']['schema'] );
3381      }
3382  
3383      $_wp_registered_theme_features[ $feature ] = $args;
3384  
3385      return true;
3386  }
3387  
3388  /**
3389   * Gets the list of registered theme features.
3390   *
3391   * @since 5.5.0
3392   *
3393   * @global array $_wp_registered_theme_features
3394   *
3395   * @return array[] List of theme features, keyed by their name.
3396   */
3397  function get_registered_theme_features() {
3398      global $_wp_registered_theme_features;
3399  
3400      if ( ! is_array( $_wp_registered_theme_features ) ) {
3401          return array();
3402      }
3403  
3404      return $_wp_registered_theme_features;
3405  }
3406  
3407  /**
3408   * Gets the registration config for a theme feature.
3409   *
3410   * @since 5.5.0
3411   *
3412   * @global array $_wp_registered_theme_features
3413   *
3414   * @param string $feature The feature name. See add_theme_support() for the list
3415   *                        of possible values.
3416   * @return array|null The registration args, or null if the feature was not registered.
3417   */
3418  function get_registered_theme_feature( $feature ) {
3419      global $_wp_registered_theme_features;
3420  
3421      if ( ! is_array( $_wp_registered_theme_features ) ) {
3422          return null;
3423      }
3424  
3425      return $_wp_registered_theme_features[ $feature ] ?? null;
3426  }
3427  
3428  /**
3429   * Checks an attachment being deleted to see if it's a header or background image.
3430   *
3431   * If true it removes the theme modification which would be pointing at the deleted
3432   * attachment.
3433   *
3434   * @access private
3435   * @since 3.0.0
3436   * @since 4.3.0 Also removes `header_image_data`.
3437   * @since 4.5.0 Also removes custom logo theme mods.
3438   * @since 6.6.0 Also removes `site_logo` option set by the site logo block.
3439   *
3440   * @param int $id The attachment ID.
3441   */
3442  function _delete_attachment_theme_mod( $id ) {
3443      $attachment_image = wp_get_attachment_url( $id );
3444      $header_image     = get_header_image();
3445      $background_image = get_background_image();
3446      $custom_logo_id   = (int) get_theme_mod( 'custom_logo' );
3447      $site_logo_id     = (int) get_option( 'site_logo' );
3448  
3449      if ( $custom_logo_id && $custom_logo_id === $id ) {
3450          remove_theme_mod( 'custom_logo' );
3451          remove_theme_mod( 'header_text' );
3452      }
3453  
3454      if ( $site_logo_id && $site_logo_id === $id ) {
3455          delete_option( 'site_logo' );
3456      }
3457  
3458      if ( $header_image && $header_image === $attachment_image ) {
3459          remove_theme_mod( 'header_image' );
3460          remove_theme_mod( 'header_image_data' );
3461      }
3462  
3463      if ( $background_image && $background_image === $attachment_image ) {
3464          remove_theme_mod( 'background_image' );
3465      }
3466  }
3467  
3468  /**
3469   * Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load.
3470   *
3471   * See {@see 'after_switch_theme'}.
3472   *
3473   * @since 3.3.0
3474   */
3475  function check_theme_switched() {
3476      $stylesheet = get_option( 'theme_switched' );
3477  
3478      if ( $stylesheet ) {
3479          $old_theme = wp_get_theme( $stylesheet );
3480  
3481          // Prevent widget & menu mapping from running since Customizer already called it up front.
3482          if ( get_option( 'theme_switched_via_customizer' ) ) {
3483              remove_action( 'after_switch_theme', '_wp_menus_changed' );
3484              remove_action( 'after_switch_theme', '_wp_sidebars_changed' );
3485              update_option( 'theme_switched_via_customizer', false );
3486          }
3487  
3488          if ( $old_theme->exists() ) {
3489              /**
3490               * Fires on the next WP load after the theme has been switched.
3491               *
3492               * The parameters differ according to whether the old theme exists or not.
3493               * If the old theme is missing, the old name will instead be the slug
3494               * of the old theme.
3495               *
3496               * See {@see 'switch_theme'}.
3497               *
3498               * @since 3.3.0
3499               *
3500               * @param string   $old_name  Old theme name.
3501               * @param WP_Theme $old_theme WP_Theme instance of the old theme.
3502               */
3503              do_action( 'after_switch_theme', $old_theme->get( 'Name' ), $old_theme );
3504          } else {
3505              /** This action is documented in wp-includes/theme.php */
3506              do_action( 'after_switch_theme', $stylesheet, $old_theme );
3507          }
3508  
3509          flush_rewrite_rules();
3510  
3511          update_option( 'theme_switched', false );
3512      }
3513  }
3514  
3515  /**
3516   * Includes and instantiates the WP_Customize_Manager class.
3517   *
3518   * Loads the Customizer at plugins_loaded when accessing the customize.php admin
3519   * page or when any request includes a wp_customize=on param or a customize_changeset
3520   * param (a UUID). This param is a signal for whether to bootstrap the Customizer when
3521   * WordPress is loading, especially in the Customizer preview
3522   * or when making Customizer Ajax requests for widgets or menus.
3523   *
3524   * @since 3.4.0
3525   *
3526   * @global WP_Customize_Manager $wp_customize
3527   */
3528  function _wp_customize_include() {
3529  
3530      $is_customize_admin_page = ( is_admin() && 'customize.php' === basename( $_SERVER['PHP_SELF'] ) );
3531      $should_include          = (
3532          $is_customize_admin_page
3533          ||
3534          ( isset( $_REQUEST['wp_customize'] ) && 'on' === $_REQUEST['wp_customize'] )
3535          ||
3536          ( ! empty( $_GET['customize_changeset_uuid'] ) || ! empty( $_POST['customize_changeset_uuid'] ) )
3537      );
3538  
3539      if ( ! $should_include ) {
3540          return;
3541      }
3542  
3543      /*
3544       * Note that wp_unslash() is not being used on the input vars because it is
3545       * called before wp_magic_quotes() gets called. Besides this fact, none of
3546       * the values should contain any characters needing slashes anyway.
3547       */
3548      $keys       = array(
3549          'changeset_uuid',
3550          'customize_changeset_uuid',
3551          'customize_theme',
3552          'theme',
3553          'customize_messenger_channel',
3554          'customize_autosaved',
3555      );
3556      $input_vars = array_merge(
3557          wp_array_slice_assoc( $_GET, $keys ),
3558          wp_array_slice_assoc( $_POST, $keys )
3559      );
3560  
3561      $theme             = null;
3562      $autosaved         = null;
3563      $messenger_channel = null;
3564  
3565      /*
3566       * Value false indicates UUID should be determined after_setup_theme
3567       * to either re-use existing saved changeset or else generate a new UUID if none exists.
3568       */
3569      $changeset_uuid = false;
3570  
3571      /*
3572       * Set initially to false since defaults to true for back-compat;
3573       * can be overridden via the customize_changeset_branching filter.
3574       */
3575      $branching = false;
3576  
3577      if ( $is_customize_admin_page && isset( $input_vars['changeset_uuid'] ) ) {
3578          $changeset_uuid = sanitize_key( $input_vars['changeset_uuid'] );
3579      } elseif ( ! empty( $input_vars['customize_changeset_uuid'] ) ) {
3580          $changeset_uuid = sanitize_key( $input_vars['customize_changeset_uuid'] );
3581      }
3582  
3583      // Note that theme will be sanitized via WP_Theme.
3584      if ( $is_customize_admin_page && isset( $input_vars['theme'] ) ) {
3585          $theme = $input_vars['theme'];
3586      } elseif ( isset( $input_vars['customize_theme'] ) ) {
3587          $theme = $input_vars['customize_theme'];
3588      }
3589  
3590      if ( ! empty( $input_vars['customize_autosaved'] ) ) {
3591          $autosaved = true;
3592      }
3593  
3594      if ( isset( $input_vars['customize_messenger_channel'] ) ) {
3595          $messenger_channel = sanitize_key( $input_vars['customize_messenger_channel'] );
3596      }
3597  
3598      /*
3599       * Note that settings must be previewed even outside the customizer preview
3600       * and also in the customizer pane itself. This is to enable loading an existing
3601       * changeset into the customizer. Previewing the settings only has to be prevented
3602       * here in the case of a customize_save action because this will cause WP to think
3603       * there is nothing changed that needs to be saved.
3604       */
3605      $is_customize_save_action = (
3606          wp_doing_ajax()
3607          &&
3608          isset( $_REQUEST['action'] )
3609          &&
3610          'customize_save' === wp_unslash( $_REQUEST['action'] )
3611      );
3612      $settings_previewed       = ! $is_customize_save_action;
3613  
3614      require_once  ABSPATH . WPINC . '/class-wp-customize-manager.php';
3615      $GLOBALS['wp_customize'] = new WP_Customize_Manager(
3616          compact(
3617              'changeset_uuid',
3618              'theme',
3619              'messenger_channel',
3620              'settings_previewed',
3621              'autosaved',
3622              'branching'
3623          )
3624      );
3625  }
3626  
3627  /**
3628   * Publishes a snapshot's changes.
3629   *
3630   * @since 4.7.0
3631   * @access private
3632   *
3633   * @global WP_Customize_Manager $wp_customize Customizer instance.
3634   *
3635   * @param string  $new_status     New post status.
3636   * @param string  $old_status     Old post status.
3637   * @param WP_Post $changeset_post Changeset post object.
3638   */
3639  function _wp_customize_publish_changeset( $new_status, $old_status, $changeset_post ) {
3640      global $wp_customize;
3641  
3642      $is_publishing_changeset = (
3643          'customize_changeset' === $changeset_post->post_type
3644          &&
3645          'publish' === $new_status
3646          &&
3647          'publish' !== $old_status
3648      );
3649      if ( ! $is_publishing_changeset ) {
3650          return;
3651      }
3652  
3653      if ( empty( $wp_customize ) ) {
3654          require_once  ABSPATH . WPINC . '/class-wp-customize-manager.php';
3655          $wp_customize = new WP_Customize_Manager(
3656              array(
3657                  'changeset_uuid'     => $changeset_post->post_name,
3658                  'settings_previewed' => false,
3659              )
3660          );
3661      }
3662  
3663      if ( ! did_action( 'customize_register' ) ) {
3664          /*
3665           * When running from CLI or Cron, the customize_register action will need
3666           * to be triggered in order for core, themes, and plugins to register their
3667           * settings. Normally core will add_action( 'customize_register' ) at
3668           * priority 10 to register the core settings, and if any themes/plugins
3669           * also add_action( 'customize_register' ) at the same priority, they
3670           * will have a $wp_customize with those settings registered since they
3671           * call add_action() afterward, normally. However, when manually doing
3672           * the customize_register action after the setup_theme, then the order
3673           * will be reversed for two actions added at priority 10, resulting in
3674           * the core settings no longer being available as expected to themes/plugins.
3675           * So the following manually calls the method that registers the core
3676           * settings up front before doing the action.
3677           */
3678          remove_action( 'customize_register', array( $wp_customize, 'register_controls' ) );
3679          $wp_customize->register_controls();
3680  
3681          /** This filter is documented in wp-includes/class-wp-customize-manager.php */
3682          do_action( 'customize_register', $wp_customize );
3683      }
3684      $wp_customize->_publish_changeset_values( $changeset_post->ID );
3685  
3686      /*
3687       * Trash the changeset post if revisions are not enabled. Unpublished
3688       * changesets by default get garbage collected due to the auto-draft status.
3689       * When a changeset post is published, however, it would no longer get cleaned
3690       * out. This is a problem when the changeset posts are never displayed anywhere,
3691       * since they would just be endlessly piling up. So here we use the revisions
3692       * feature to indicate whether or not a published changeset should get trashed
3693       * and thus garbage collected.
3694       */
3695      if ( ! wp_revisions_enabled( $changeset_post ) ) {
3696          $wp_customize->trash_changeset_post( $changeset_post->ID );
3697      }
3698  }
3699  
3700  /**
3701   * Filters changeset post data upon insert to ensure post_name is intact.
3702   *
3703   * This is needed to prevent the post_name from being dropped when the post is
3704   * transitioned into pending status by a contributor.
3705   *
3706   * @since 4.7.0
3707   *
3708   * @see wp_insert_post()
3709   *
3710   * @param array $post_data          An array of slashed post data.
3711   * @param array $supplied_post_data An array of sanitized, but otherwise unmodified post data.
3712   * @return array Filtered data.
3713   */
3714  function _wp_customize_changeset_filter_insert_post_data( $post_data, $supplied_post_data ) {
3715      if ( isset( $post_data['post_type'] ) && 'customize_changeset' === $post_data['post_type'] ) {
3716  
3717          // Prevent post_name from being dropped, such as when contributor saves a changeset post as pending.
3718          if ( empty( $post_data['post_name'] ) && ! empty( $supplied_post_data['post_name'] ) ) {
3719              $post_data['post_name'] = $supplied_post_data['post_name'];
3720          }
3721      }
3722      return $post_data;
3723  }
3724  
3725  /**
3726   * Adds settings for the customize-loader script.
3727   *
3728   * @since 3.4.0
3729   */
3730  function _wp_customize_loader_settings() {
3731      $admin_origin = parse_url( admin_url() );
3732      $home_origin  = parse_url( home_url() );
3733      $cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) );
3734  
3735      $browser = array(
3736          'mobile' => wp_is_mobile(),
3737          'ios'    => wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] ),
3738      );
3739  
3740      $settings = array(
3741          'url'           => esc_url( admin_url( 'customize.php' ) ),
3742          'isCrossDomain' => $cross_domain,
3743          'browser'       => $browser,
3744          'l10n'          => array(
3745              'saveAlert'       => __( 'The changes you made will be lost if you navigate away from this page.' ),
3746              'mainIframeTitle' => __( 'Customizer' ),
3747          ),
3748      );
3749  
3750      $script = 'var _wpCustomizeLoaderSettings = ' . wp_json_encode( $settings, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) . ';';
3751  
3752      $wp_scripts = wp_scripts();
3753      $data       = $wp_scripts->get_data( 'customize-loader', 'data' );
3754      if ( $data ) {
3755          $script = "$data\n$script";
3756      }
3757  
3758      $wp_scripts->add_data( 'customize-loader', 'data', $script );
3759  }
3760  
3761  /**
3762   * Returns a URL to load the Customizer.
3763   *
3764   * @since 3.4.0
3765   *
3766   * @param string $stylesheet Optional. Theme to customize. Defaults to active theme.
3767   *                           The theme's stylesheet will be urlencoded if necessary.
3768   * @return string
3769   */
3770  function wp_customize_url( $stylesheet = '' ) {
3771      $url = admin_url( 'customize.php' );
3772      if ( $stylesheet ) {
3773          $url = add_query_arg( 'theme', urlencode( $stylesheet ), $url );
3774      }
3775      return esc_url( $url );
3776  }
3777  
3778  /**
3779   * Prints a script to check whether or not the Customizer is supported,
3780   * and apply either the no-customize-support or customize-support class
3781   * to the body.
3782   *
3783   * This function MUST be called inside the body tag.
3784   *
3785   * Ideally, call this function immediately after the body tag is opened.
3786   * This prevents a flash of unstyled content.
3787   *
3788   * It is also recommended that you add the "no-customize-support" class
3789   * to the body tag by default.
3790   *
3791   * @since 3.4.0
3792   * @since 4.7.0 Support for IE8 and below is explicitly removed via conditional comments.
3793   * @since 5.5.0 IE8 and older are no longer supported.
3794   */
3795  function wp_customize_support_script() {
3796      $admin_origin = parse_url( admin_url() );
3797      $home_origin  = parse_url( home_url() );
3798      $cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) );
3799      ob_start();
3800      ?>
3801      <script>
3802          (function() {
3803              var request, b = document.body, c = 'className', cs = 'customize-support', rcs = new RegExp('(^|\\s+)(no-)?'+cs+'(\\s+|$)');
3804  
3805      <?php    if ( $cross_domain ) : ?>
3806              request = (function(){ var xhr = new XMLHttpRequest(); return ('withCredentials' in xhr); })();
3807      <?php    else : ?>
3808              request = true;
3809      <?php    endif; ?>
3810  
3811              b[c] = b[c].replace( rcs, ' ' );
3812              // The customizer requires postMessage and CORS (if the site is cross domain).
3813              b[c] += ( window.postMessage && request ? ' ' : ' no-' ) + cs;
3814          }());
3815      </script>
3816      <?php
3817      wp_print_inline_script_tag( wp_remove_surrounding_empty_script_tags( ob_get_clean() ) . "\n//# sourceURL=" . rawurlencode( __FUNCTION__ ) );
3818  }
3819  
3820  /**
3821   * Whether the site is being previewed in the Customizer.
3822   *
3823   * @since 4.0.0
3824   *
3825   * @global WP_Customize_Manager $wp_customize Customizer instance.
3826   *
3827   * @return bool True if the site is being previewed in the Customizer, false otherwise.
3828   */
3829  function is_customize_preview() {
3830      global $wp_customize;
3831  
3832      return ( $wp_customize instanceof WP_Customize_Manager ) && $wp_customize->is_preview();
3833  }
3834  
3835  /**
3836   * Makes sure that auto-draft posts get their post_date bumped or status changed
3837   * to draft to prevent premature garbage-collection.
3838   *
3839   * When a changeset is updated but remains an auto-draft, ensure the post_date
3840   * for the auto-draft posts remains the same so that it will be
3841   * garbage-collected at the same time by `wp_delete_auto_drafts()`. Otherwise,
3842   * if the changeset is updated to be a draft then update the posts
3843   * to have a far-future post_date so that they will never be garbage collected
3844   * unless the changeset post itself is deleted.
3845   *
3846   * When a changeset is updated to be a persistent draft or to be scheduled for
3847   * publishing, then transition any dependent auto-drafts to a draft status so
3848   * that they likewise will not be garbage-collected but also so that they can
3849   * be edited in the admin before publishing since there is not yet a post/page
3850   * editing flow in the Customizer. See #39752.
3851   *
3852   * @link https://core.trac.wordpress.org/ticket/39752
3853   *
3854   * @since 4.8.0
3855   * @access private
3856   * @see wp_delete_auto_drafts()
3857   *
3858   * @global wpdb $wpdb WordPress database abstraction object.
3859   *
3860   * @param string   $new_status Transition to this post status.
3861   * @param string   $old_status Previous post status.
3862   * @param \WP_Post $post       Post data.
3863   */
3864  function _wp_keep_alive_customize_changeset_dependent_auto_drafts( $new_status, $old_status, $post ) {
3865      global $wpdb;
3866      unset( $old_status );
3867  
3868      // Short-circuit if not a changeset or if the changeset was published.
3869      if ( 'customize_changeset' !== $post->post_type || 'publish' === $new_status ) {
3870          return;
3871      }
3872  
3873      $data = json_decode( $post->post_content, true );
3874      if ( empty( $data['nav_menus_created_posts']['value'] ) ) {
3875          return;
3876      }
3877  
3878      /*
3879       * Actually, in lieu of keeping alive, trash any customization drafts here if the changeset itself is
3880       * getting trashed. This is needed because when a changeset transitions to a draft, then any of the
3881       * dependent auto-draft post/page stubs will also get transitioned to customization drafts which
3882       * are then visible in the WP Admin. We cannot wait for the deletion of the changeset in which
3883       * _wp_delete_customize_changeset_dependent_auto_drafts() will be called, since they need to be
3884       * trashed to remove from visibility immediately.
3885       */
3886      if ( 'trash' === $new_status ) {
3887          foreach ( $data['nav_menus_created_posts']['value'] as $post_id ) {
3888              if ( ! empty( $post_id ) && 'draft' === get_post_status( $post_id ) ) {
3889                  wp_trash_post( $post_id );
3890              }
3891          }
3892          return;
3893      }
3894  
3895      $post_args = array();
3896      if ( 'auto-draft' === $new_status ) {
3897          /*
3898           * Keep the post date for the post matching the changeset
3899           * so that it will not be garbage-collected before the changeset.
3900           */
3901          $post_args['post_date'] = $post->post_date; // Note wp_delete_auto_drafts() only looks at this date.
3902      } else {
3903          /*
3904           * Since the changeset no longer has an auto-draft (and it is not published)
3905           * it is now a persistent changeset, a long-lived draft, and so any
3906           * associated auto-draft posts should likewise transition into having a draft
3907           * status. These drafts will be treated differently than regular drafts in
3908           * that they will be tied to the given changeset. The publish meta box is
3909           * replaced with a notice about how the post is part of a set of customized changes
3910           * which will be published when the changeset is published.
3911           */
3912          $post_args['post_status'] = 'draft';
3913      }
3914  
3915      foreach ( $data['nav_menus_created_posts']['value'] as $post_id ) {
3916          if ( empty( $post_id ) || 'auto-draft' !== get_post_status( $post_id ) ) {
3917              continue;
3918          }
3919          $wpdb->update(
3920              $wpdb->posts,
3921              $post_args,
3922              array( 'ID' => $post_id )
3923          );
3924          clean_post_cache( $post_id );
3925      }
3926  }
3927  
3928  /**
3929   * Creates the initial theme features when the 'setup_theme' action is fired.
3930   *
3931   * See {@see 'setup_theme'}.
3932   *
3933   * @since 5.5.0
3934   * @since 6.0.1 The `block-templates` feature was added.
3935   */
3936  function create_initial_theme_features() {
3937      register_theme_feature(
3938          'align-wide',
3939          array(
3940              'description'  => __( 'Whether theme opts in to wide alignment CSS class.' ),
3941              'show_in_rest' => true,
3942          )
3943      );
3944      register_theme_feature(
3945          'automatic-feed-links',
3946          array(
3947              'description'  => __( 'Whether posts and comments RSS feed links are added to head.' ),
3948              'show_in_rest' => true,
3949          )
3950      );
3951      register_theme_feature(
3952          'block-templates',
3953          array(
3954              'description'  => __( 'Whether a theme uses block-based templates.' ),
3955              'show_in_rest' => true,
3956          )
3957      );
3958      register_theme_feature(
3959          'block-template-parts',
3960          array(
3961              'description'  => __( 'Whether a theme uses block-based template parts.' ),
3962              'show_in_rest' => true,
3963          )
3964      );
3965      register_theme_feature(
3966          'custom-background',
3967          array(
3968              'description'  => __( 'Custom background if defined by the theme.' ),
3969              'type'         => 'object',
3970              'show_in_rest' => array(
3971                  'schema' => array(
3972                      'properties' => array(
3973                          'default-image'      => array(
3974                              'type'   => 'string',
3975                              'format' => 'uri',
3976                          ),
3977                          'default-preset'     => array(
3978                              'type' => 'string',
3979                              'enum' => array(
3980                                  'default',
3981                                  'fill',
3982                                  'fit',
3983                                  'repeat',
3984                                  'custom',
3985                              ),
3986                          ),
3987                          'default-position-x' => array(
3988                              'type' => 'string',
3989                              'enum' => array(
3990                                  'left',
3991                                  'center',
3992                                  'right',
3993                              ),
3994                          ),
3995                          'default-position-y' => array(
3996                              'type' => 'string',
3997                              'enum' => array(
3998                                  'left',
3999                                  'center',
4000                                  'right',
4001                              ),
4002                          ),
4003                          'default-size'       => array(
4004                              'type' => 'string',
4005                              'enum' => array(
4006                                  'auto',
4007                                  'contain',
4008                                  'cover',
4009                              ),
4010                          ),
4011                          'default-repeat'     => array(
4012                              'type' => 'string',
4013                              'enum' => array(
4014                                  'repeat-x',
4015                                  'repeat-y',
4016                                  'repeat',
4017                                  'no-repeat',
4018                              ),
4019                          ),
4020                          'default-attachment' => array(
4021                              'type' => 'string',
4022                              'enum' => array(
4023                                  'scroll',
4024                                  'fixed',
4025                              ),
4026                          ),
4027                          'default-color'      => array(
4028                              'type' => 'string',
4029                          ),
4030                      ),
4031                  ),
4032              ),
4033          )
4034      );
4035      register_theme_feature(
4036          'custom-header',
4037          array(
4038              'description'  => __( 'Custom header if defined by the theme.' ),
4039              'type'         => 'object',
4040              'show_in_rest' => array(
4041                  'schema' => array(
4042                      'properties' => array(
4043                          'default-image'      => array(
4044                              'type'   => 'string',
4045                              'format' => 'uri',
4046                          ),
4047                          'random-default'     => array(
4048                              'type' => 'boolean',
4049                          ),
4050                          'width'              => array(
4051                              'type' => 'integer',
4052                          ),
4053                          'height'             => array(
4054                              'type' => 'integer',
4055                          ),
4056                          'flex-height'        => array(
4057                              'type' => 'boolean',
4058                          ),
4059                          'flex-width'         => array(
4060                              'type' => 'boolean',
4061                          ),
4062                          'default-text-color' => array(
4063                              'type' => 'string',
4064                          ),
4065                          'header-text'        => array(
4066                              'type' => 'boolean',
4067                          ),
4068                          'uploads'            => array(
4069                              'type' => 'boolean',
4070                          ),
4071                          'video'              => array(
4072                              'type' => 'boolean',
4073                          ),
4074                      ),
4075                  ),
4076              ),
4077          )
4078      );
4079      register_theme_feature(
4080          'custom-logo',
4081          array(
4082              'type'         => 'object',
4083              'description'  => __( 'Custom logo if defined by the theme.' ),
4084              'show_in_rest' => array(
4085                  'schema' => array(
4086                      'properties' => array(
4087                          'width'                => array(
4088                              'type' => 'integer',
4089                          ),
4090                          'height'               => array(
4091                              'type' => 'integer',
4092                          ),
4093                          'flex-width'           => array(
4094                              'type' => 'boolean',
4095                          ),
4096                          'flex-height'          => array(
4097                              'type' => 'boolean',
4098                          ),
4099                          'header-text'          => array(
4100                              'type'  => 'array',
4101                              'items' => array(
4102                                  'type' => 'string',
4103                              ),
4104                          ),
4105                          'unlink-homepage-logo' => array(
4106                              'type' => 'boolean',
4107                          ),
4108                      ),
4109                  ),
4110              ),
4111          )
4112      );
4113      register_theme_feature(
4114          'customize-selective-refresh-widgets',
4115          array(
4116              'description'  => __( 'Whether the theme enables Selective Refresh for Widgets being managed with the Customizer.' ),
4117              'show_in_rest' => true,
4118          )
4119      );
4120      register_theme_feature(
4121          'dark-editor-style',
4122          array(
4123              'description'  => __( 'Whether theme opts in to the dark editor style UI.' ),
4124              'show_in_rest' => true,
4125          )
4126      );
4127      register_theme_feature(
4128          'disable-custom-colors',
4129          array(
4130              'description'  => __( 'Whether the theme disables custom colors.' ),
4131              'show_in_rest' => true,
4132          )
4133      );
4134      register_theme_feature(
4135          'disable-custom-font-sizes',
4136          array(
4137              'description'  => __( 'Whether the theme disables custom font sizes.' ),
4138              'show_in_rest' => true,
4139          )
4140      );
4141      register_theme_feature(
4142          'disable-custom-gradients',
4143          array(
4144              'description'  => __( 'Whether the theme disables custom gradients.' ),
4145              'show_in_rest' => true,
4146          )
4147      );
4148      register_theme_feature(
4149          'disable-layout-styles',
4150          array(
4151              'description'  => __( 'Whether the theme disables generated layout styles.' ),
4152              'show_in_rest' => true,
4153          )
4154      );
4155      register_theme_feature(
4156          'editor-color-palette',
4157          array(
4158              'type'         => 'array',
4159              'description'  => __( 'Custom color palette if defined by the theme.' ),
4160              'show_in_rest' => array(
4161                  'schema' => array(
4162                      'items' => array(
4163                          'type'       => 'object',
4164                          'properties' => array(
4165                              'name'  => array(
4166                                  'type' => 'string',
4167                              ),
4168                              'slug'  => array(
4169                                  'type' => 'string',
4170                              ),
4171                              'color' => array(
4172                                  'type' => 'string',
4173                              ),
4174                          ),
4175                      ),
4176                  ),
4177              ),
4178          )
4179      );
4180      register_theme_feature(
4181          'editor-font-sizes',
4182          array(
4183              'type'         => 'array',
4184              'description'  => __( 'Custom font sizes if defined by the theme.' ),
4185              'show_in_rest' => array(
4186                  'schema' => array(
4187                      'items' => array(
4188                          'type'       => 'object',
4189                          'properties' => array(
4190                              'name' => array(
4191                                  'type' => 'string',
4192                              ),
4193                              'size' => array(
4194                                  'type' => 'number',
4195                              ),
4196                              'slug' => array(
4197                                  'type' => 'string',
4198                              ),
4199                          ),
4200                      ),
4201                  ),
4202              ),
4203          )
4204      );
4205      register_theme_feature(
4206          'editor-gradient-presets',
4207          array(
4208              'type'         => 'array',
4209              'description'  => __( 'Custom gradient presets if defined by the theme.' ),
4210              'show_in_rest' => array(
4211                  'schema' => array(
4212                      'items' => array(
4213                          'type'       => 'object',
4214                          'properties' => array(
4215                              'name'     => array(
4216                                  'type' => 'string',
4217                              ),
4218                              'gradient' => array(
4219                                  'type' => 'string',
4220                              ),
4221                              'slug'     => array(
4222                                  'type' => 'string',
4223                              ),
4224                          ),
4225                      ),
4226                  ),
4227              ),
4228          )
4229      );
4230      register_theme_feature(
4231          'editor-spacing-sizes',
4232          array(
4233              'type'         => 'array',
4234              'description'  => __( 'Custom spacing sizes if defined by the theme.' ),
4235              'show_in_rest' => array(
4236                  'schema' => array(
4237                      'items' => array(
4238                          'type'       => 'object',
4239                          'properties' => array(
4240                              'name' => array(
4241                                  'type' => 'string',
4242                              ),
4243                              'size' => array(
4244                                  'type' => 'string',
4245                              ),
4246                              'slug' => array(
4247                                  'type' => 'string',
4248                              ),
4249                          ),
4250                      ),
4251                  ),
4252              ),
4253          )
4254      );
4255      register_theme_feature(
4256          'editor-styles',
4257          array(
4258              'description'  => __( 'Whether theme opts in to the editor styles CSS wrapper.' ),
4259              'show_in_rest' => true,
4260          )
4261      );
4262      register_theme_feature(
4263          'html5',
4264          array(
4265              'type'         => 'array',
4266              'description'  => __( 'Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.' ),
4267              'show_in_rest' => array(
4268                  'schema' => array(
4269                      'items' => array(
4270                          'type' => 'string',
4271                          'enum' => array(
4272                              'search-form',
4273                              'comment-form',
4274                              'comment-list',
4275                              'gallery',
4276                              'caption',
4277                              'script',
4278                              'style',
4279                          ),
4280                      ),
4281                  ),
4282              ),
4283          )
4284      );
4285      register_theme_feature(
4286          'post-formats',
4287          array(
4288              'type'         => 'array',
4289              'description'  => __( 'Post formats supported.' ),
4290              'show_in_rest' => array(
4291                  'name'             => 'formats',
4292                  'schema'           => array(
4293                      'items'   => array(
4294                          'type' => 'string',
4295                          'enum' => get_post_format_slugs(),
4296                      ),
4297                      'default' => array( 'standard' ),
4298                  ),
4299                  'prepare_callback' => static function ( $formats ) {
4300                      $formats = is_array( $formats ) ? array_values( $formats[0] ) : array();
4301                      $formats = array_merge( array( 'standard' ), $formats );
4302  
4303                      return $formats;
4304                  },
4305              ),
4306          )
4307      );
4308      register_theme_feature(
4309          'post-thumbnails',
4310          array(
4311              'type'         => 'array',
4312              'description'  => __( 'The post types that support thumbnails or true if all post types are supported.' ),
4313              'show_in_rest' => array(
4314                  'type'   => array( 'boolean', 'array' ),
4315                  'schema' => array(
4316                      'items' => array(
4317                          'type' => 'string',
4318                      ),
4319                  ),
4320              ),
4321          )
4322      );
4323      register_theme_feature(
4324          'responsive-embeds',
4325          array(
4326              'description'  => __( 'Whether the theme supports responsive embedded content.' ),
4327              'show_in_rest' => true,
4328          )
4329      );
4330      register_theme_feature(
4331          'title-tag',
4332          array(
4333              'description'  => __( 'Whether the theme can manage the document title tag.' ),
4334              'show_in_rest' => true,
4335          )
4336      );
4337      register_theme_feature(
4338          'wp-block-styles',
4339          array(
4340              'description'  => __( 'Whether theme opts in to default WordPress block styles for viewing.' ),
4341              'show_in_rest' => true,
4342          )
4343      );
4344  }
4345  
4346  /**
4347   * Returns whether the active theme is a block-based theme or not.
4348   *
4349   * @since 5.9.0
4350   *
4351   * @global string[] $wp_theme_directories
4352   *
4353   * @return bool Whether the active theme is a block-based theme or not.
4354   */
4355  function wp_is_block_theme() {
4356      if ( empty( $GLOBALS['wp_theme_directories'] ) ) {
4357          _doing_it_wrong( __FUNCTION__, __( 'This function should not be called before the theme directory is registered.' ), '6.8.0' );
4358          return false;
4359      }
4360  
4361      return wp_get_theme()->is_block_theme();
4362  }
4363  
4364  /**
4365   * Given an element name, returns a class name.
4366   *
4367   * Alias of WP_Theme_JSON::get_element_class_name.
4368   *
4369   * @since 6.1.0
4370   *
4371   * @param string $element The name of the element.
4372   *
4373   * @return string The name of the class.
4374   */
4375  function wp_theme_get_element_class_name( $element ) {
4376      return WP_Theme_JSON::get_element_class_name( $element );
4377  }
4378  
4379  /**
4380   * Adds default theme supports for block themes when the 'after_setup_theme' action fires.
4381   *
4382   * See {@see 'after_setup_theme'}.
4383   *
4384   * @since 5.9.0
4385   * @access private
4386   */
4387  function _add_default_theme_supports() {
4388      if ( ! wp_is_block_theme() ) {
4389          return;
4390      }
4391  
4392      add_theme_support( 'post-thumbnails' );
4393      add_theme_support( 'responsive-embeds' );
4394      add_theme_support( 'editor-styles' );
4395      /*
4396       * Makes block themes support HTML5 by default for the comment block and search form
4397       * (which use default template functions) and `[caption]` and `[gallery]` shortcodes.
4398       * Other blocks contain their own HTML5 markup.
4399       */
4400      add_theme_support( 'html5', array( 'comment-form', 'comment-list', 'search-form', 'gallery', 'caption', 'style', 'script' ) );
4401      add_theme_support( 'automatic-feed-links' );
4402  
4403      add_filter( 'should_load_separate_core_block_assets', '__return_true' );
4404      add_filter( 'should_load_block_assets_on_demand', '__return_true' );
4405  
4406      /*
4407       * Remove the Customizer's Menus panel when block theme is active.
4408       */
4409      add_filter(
4410          'customize_panel_active',
4411          static function ( $active, WP_Customize_Panel $panel ) {
4412              if (
4413                  'nav_menus' === $panel->id &&
4414                  ! current_theme_supports( 'menus' ) &&
4415                  ! current_theme_supports( 'widgets' )
4416              ) {
4417                  $active = false;
4418              }
4419              return $active;
4420          },
4421          10,
4422          2
4423      );
4424  }