| [ Index ] |
PHP Cross Reference of WordPress |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WP_Theme Class 4 * 5 * @package WordPress 6 * @subpackage Theme 7 * @since 3.4.0 8 */ 9 final class WP_Theme implements ArrayAccess { 10 11 /** 12 * Whether the theme has been marked as updateable. 13 * 14 * @since 4.4.0 15 * @var bool 16 * 17 * @see WP_MS_Themes_List_Table 18 */ 19 public $update = false; 20 21 /** 22 * Headers for style.css files. 23 * 24 * @since 3.4.0 25 * @since 5.4.0 Added `Requires at least` and `Requires PHP` headers. 26 * @var array 27 */ 28 private static $file_headers = array( 29 'Name' => 'Theme Name', 30 'ThemeURI' => 'Theme URI', 31 'Description' => 'Description', 32 'Author' => 'Author', 33 'AuthorURI' => 'Author URI', 34 'Version' => 'Version', 35 'Template' => 'Template', 36 'Status' => 'Status', 37 'Tags' => 'Tags', 38 'TextDomain' => 'Text Domain', 39 'DomainPath' => 'Domain Path', 40 'RequiresWP' => 'Requires at least', 41 'RequiresPHP' => 'Requires PHP', 42 ); 43 44 /** 45 * Default themes. 46 * 47 * @var array 48 */ 49 private static $default_themes = array( 50 'classic' => 'WordPress Classic', 51 'default' => 'WordPress Default', 52 'twentyten' => 'Twenty Ten', 53 'twentyeleven' => 'Twenty Eleven', 54 'twentytwelve' => 'Twenty Twelve', 55 'twentythirteen' => 'Twenty Thirteen', 56 'twentyfourteen' => 'Twenty Fourteen', 57 'twentyfifteen' => 'Twenty Fifteen', 58 'twentysixteen' => 'Twenty Sixteen', 59 'twentyseventeen' => 'Twenty Seventeen', 60 'twentynineteen' => 'Twenty Nineteen', 61 'twentytwenty' => 'Twenty Twenty', 62 ); 63 64 /** 65 * Renamed theme tags. 66 * 67 * @var array 68 */ 69 private static $tag_map = array( 70 'fixed-width' => 'fixed-layout', 71 'flexible-width' => 'fluid-layout', 72 ); 73 74 /** 75 * Absolute path to the theme root, usually wp-content/themes 76 * 77 * @var string 78 */ 79 private $theme_root; 80 81 /** 82 * Header data from the theme's style.css file. 83 * 84 * @var array 85 */ 86 private $headers = array(); 87 88 /** 89 * Header data from the theme's style.css file after being sanitized. 90 * 91 * @var array 92 */ 93 private $headers_sanitized; 94 95 /** 96 * Header name from the theme's style.css after being translated. 97 * 98 * Cached due to sorting functions running over the translated name. 99 * 100 * @var string 101 */ 102 private $name_translated; 103 104 /** 105 * Errors encountered when initializing the theme. 106 * 107 * @var WP_Error 108 */ 109 private $errors; 110 111 /** 112 * The directory name of the theme's files, inside the theme root. 113 * 114 * In the case of a child theme, this is directory name of the child theme. 115 * Otherwise, 'stylesheet' is the same as 'template'. 116 * 117 * @var string 118 */ 119 private $stylesheet; 120 121 /** 122 * The directory name of the theme's files, inside the theme root. 123 * 124 * In the case of a child theme, this is the directory name of the parent theme. 125 * Otherwise, 'template' is the same as 'stylesheet'. 126 * 127 * @var string 128 */ 129 private $template; 130 131 /** 132 * A reference to the parent theme, in the case of a child theme. 133 * 134 * @var WP_Theme 135 */ 136 private $parent; 137 138 /** 139 * URL to the theme root, usually an absolute URL to wp-content/themes 140 * 141 * @var string 142 */ 143 private $theme_root_uri; 144 145 /** 146 * Flag for whether the theme's textdomain is loaded. 147 * 148 * @var bool 149 */ 150 private $textdomain_loaded; 151 152 /** 153 * Stores an md5 hash of the theme root, to function as the cache key. 154 * 155 * @var string 156 */ 157 private $cache_hash; 158 159 /** 160 * Flag for whether the themes cache bucket should be persistently cached. 161 * 162 * Default is false. Can be set with the {@see 'wp_cache_themes_persistently'} filter. 163 * 164 * @var bool 165 */ 166 private static $persistently_cache; 167 168 /** 169 * Expiration time for the themes cache bucket. 170 * 171 * By default the bucket is not cached, so this value is useless. 172 * 173 * @var bool 174 */ 175 private static $cache_expiration = 1800; 176 177 /** 178 * Constructor for WP_Theme. 179 * 180 * @since 3.4.0 181 * 182 * @global array $wp_theme_directories 183 * 184 * @param string $theme_dir Directory of the theme within the theme_root. 185 * @param string $theme_root Theme root. 186 * @param WP_Theme|null $_child If this theme is a parent theme, the child may be passed for validation purposes. 187 */ 188 public function __construct( $theme_dir, $theme_root, $_child = null ) { 189 global $wp_theme_directories; 190 191 // Initialize caching on first run. 192 if ( ! isset( self::$persistently_cache ) ) { 193 /** This action is documented in wp-includes/theme.php */ 194 self::$persistently_cache = apply_filters( 'wp_cache_themes_persistently', false, 'WP_Theme' ); 195 if ( self::$persistently_cache ) { 196 wp_cache_add_global_groups( 'themes' ); 197 if ( is_int( self::$persistently_cache ) ) { 198 self::$cache_expiration = self::$persistently_cache; 199 } 200 } else { 201 wp_cache_add_non_persistent_groups( 'themes' ); 202 } 203 } 204 205 $this->theme_root = $theme_root; 206 $this->stylesheet = $theme_dir; 207 208 // Correct a situation where the theme is 'some-directory/some-theme' but 'some-directory' was passed in as part of the theme root instead. 209 if ( ! in_array( $theme_root, (array) $wp_theme_directories, true ) 210 && in_array( dirname( $theme_root ), (array) $wp_theme_directories, true ) 211 ) { 212 $this->stylesheet = basename( $this->theme_root ) . '/' . $this->stylesheet; 213 $this->theme_root = dirname( $theme_root ); 214 } 215 216 $this->cache_hash = md5( $this->theme_root . '/' . $this->stylesheet ); 217 $theme_file = $this->stylesheet . '/style.css'; 218 219 $cache = $this->cache_get( 'theme' ); 220 221 if ( is_array( $cache ) ) { 222 foreach ( array( 'errors', 'headers', 'template' ) as $key ) { 223 if ( isset( $cache[ $key ] ) ) { 224 $this->$key = $cache[ $key ]; 225 } 226 } 227 if ( $this->errors ) { 228 return; 229 } 230 if ( isset( $cache['theme_root_template'] ) ) { 231 $theme_root_template = $cache['theme_root_template']; 232 } 233 } elseif ( ! file_exists( $this->theme_root . '/' . $theme_file ) ) { 234 $this->headers['Name'] = $this->stylesheet; 235 if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet ) ) { 236 $this->errors = new WP_Error( 237 'theme_not_found', 238 sprintf( 239 /* translators: %s: Theme directory name. */ 240 __( 'The theme directory "%s" does not exist.' ), 241 esc_html( $this->stylesheet ) 242 ) 243 ); 244 } else { 245 $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) ); 246 } 247 $this->template = $this->stylesheet; 248 $this->cache_add( 249 'theme', 250 array( 251 'headers' => $this->headers, 252 'errors' => $this->errors, 253 'stylesheet' => $this->stylesheet, 254 'template' => $this->template, 255 ) 256 ); 257 if ( ! file_exists( $this->theme_root ) ) { // Don't cache this one. 258 $this->errors->add( 'theme_root_missing', __( 'Error: The themes directory is either empty or doesn’t exist. Please check your installation.' ) ); 259 } 260 return; 261 } elseif ( ! is_readable( $this->theme_root . '/' . $theme_file ) ) { 262 $this->headers['Name'] = $this->stylesheet; 263 $this->errors = new WP_Error( 'theme_stylesheet_not_readable', __( 'Stylesheet is not readable.' ) ); 264 $this->template = $this->stylesheet; 265 $this->cache_add( 266 'theme', 267 array( 268 'headers' => $this->headers, 269 'errors' => $this->errors, 270 'stylesheet' => $this->stylesheet, 271 'template' => $this->template, 272 ) 273 ); 274 return; 275 } else { 276 $this->headers = get_file_data( $this->theme_root . '/' . $theme_file, self::$file_headers, 'theme' ); 277 // Default themes always trump their pretenders. 278 // Properly identify default themes that are inside a directory within wp-content/themes. 279 $default_theme_slug = array_search( $this->headers['Name'], self::$default_themes, true ); 280 if ( $default_theme_slug ) { 281 if ( basename( $this->stylesheet ) != $default_theme_slug ) { 282 $this->headers['Name'] .= '/' . $this->stylesheet; 283 } 284 } 285 } 286 287 if ( ! $this->template && $this->stylesheet === $this->headers['Template'] ) { 288 $this->errors = new WP_Error( 289 'theme_child_invalid', 290 sprintf( 291 /* translators: %s: Template. */ 292 __( 'The theme defines itself as its parent theme. Please check the %s header.' ), 293 '<code>Template</code>' 294 ) 295 ); 296 $this->cache_add( 297 'theme', 298 array( 299 'headers' => $this->headers, 300 'errors' => $this->errors, 301 'stylesheet' => $this->stylesheet, 302 ) 303 ); 304 305 return; 306 } 307 308 // (If template is set from cache [and there are no errors], we know it's good.) 309 if ( ! $this->template ) { 310 $this->template = $this->headers['Template']; 311 } 312 313 if ( ! $this->template ) { 314 $this->template = $this->stylesheet; 315 if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet . '/index.php' ) ) { 316 $error_message = sprintf( 317 /* translators: 1: index.php, 2: Documentation URL, 3: style.css */ 318 __( 'Template is missing. Standalone themes need to have a %1$s template file. <a href="%2$s">Child themes</a> need to have a Template header in the %3$s stylesheet.' ), 319 '<code>index.php</code>', 320 __( 'https://developer.wordpress.org/themes/advanced-topics/child-themes/' ), 321 '<code>style.css</code>' 322 ); 323 $this->errors = new WP_Error( 'theme_no_index', $error_message ); 324 $this->cache_add( 325 'theme', 326 array( 327 'headers' => $this->headers, 328 'errors' => $this->errors, 329 'stylesheet' => $this->stylesheet, 330 'template' => $this->template, 331 ) 332 ); 333 return; 334 } 335 } 336 337 // If we got our data from cache, we can assume that 'template' is pointing to the right place. 338 if ( ! is_array( $cache ) && $this->template != $this->stylesheet && ! file_exists( $this->theme_root . '/' . $this->template . '/index.php' ) ) { 339 // If we're in a directory of themes inside /themes, look for the parent nearby. 340 // wp-content/themes/directory-of-themes/* 341 $parent_dir = dirname( $this->stylesheet ); 342 $directories = search_theme_directories(); 343 344 if ( '.' !== $parent_dir && file_exists( $this->theme_root . '/' . $parent_dir . '/' . $this->template . '/index.php' ) ) { 345 $this->template = $parent_dir . '/' . $this->template; 346 } elseif ( $directories && isset( $directories[ $this->template ] ) ) { 347 // Look for the template in the search_theme_directories() results, in case it is in another theme root. 348 // We don't look into directories of themes, just the theme root. 349 $theme_root_template = $directories[ $this->template ]['theme_root']; 350 } else { 351 // Parent theme is missing. 352 $this->errors = new WP_Error( 353 'theme_no_parent', 354 sprintf( 355 /* translators: %s: Theme directory name. */ 356 __( 'The parent theme is missing. Please install the "%s" parent theme.' ), 357 esc_html( $this->template ) 358 ) 359 ); 360 $this->cache_add( 361 'theme', 362 array( 363 'headers' => $this->headers, 364 'errors' => $this->errors, 365 'stylesheet' => $this->stylesheet, 366 'template' => $this->template, 367 ) 368 ); 369 $this->parent = new WP_Theme( $this->template, $this->theme_root, $this ); 370 return; 371 } 372 } 373 374 // Set the parent, if we're a child theme. 375 if ( $this->template != $this->stylesheet ) { 376 // If we are a parent, then there is a problem. Only two generations allowed! Cancel things out. 377 if ( $_child instanceof WP_Theme && $_child->template == $this->stylesheet ) { 378 $_child->parent = null; 379 $_child->errors = new WP_Error( 380 'theme_parent_invalid', 381 sprintf( 382 /* translators: %s: Theme directory name. */ 383 __( 'The "%s" theme is not a valid parent theme.' ), 384 esc_html( $_child->template ) 385 ) 386 ); 387 $_child->cache_add( 388 'theme', 389 array( 390 'headers' => $_child->headers, 391 'errors' => $_child->errors, 392 'stylesheet' => $_child->stylesheet, 393 'template' => $_child->template, 394 ) 395 ); 396 // The two themes actually reference each other with the Template header. 397 if ( $_child->stylesheet == $this->template ) { 398 $this->errors = new WP_Error( 399 'theme_parent_invalid', 400 sprintf( 401 /* translators: %s: Theme directory name. */ 402 __( 'The "%s" theme is not a valid parent theme.' ), 403 esc_html( $this->template ) 404 ) 405 ); 406 $this->cache_add( 407 'theme', 408 array( 409 'headers' => $this->headers, 410 'errors' => $this->errors, 411 'stylesheet' => $this->stylesheet, 412 'template' => $this->template, 413 ) 414 ); 415 } 416 return; 417 } 418 // Set the parent. Pass the current instance so we can do the crazy checks above and assess errors. 419 $this->parent = new WP_Theme( $this->template, isset( $theme_root_template ) ? $theme_root_template : $this->theme_root, $this ); 420 } 421 422 if ( wp_paused_themes()->get( $this->stylesheet ) && ( ! is_wp_error( $this->errors ) || ! isset( $this->errors->errors['theme_paused'] ) ) ) { 423 $this->errors = new WP_Error( 'theme_paused', __( 'This theme failed to load properly and was paused within the admin backend.' ) ); 424 } 425 426 // We're good. If we didn't retrieve from cache, set it. 427 if ( ! is_array( $cache ) ) { 428 $cache = array( 429 'headers' => $this->headers, 430 'errors' => $this->errors, 431 'stylesheet' => $this->stylesheet, 432 'template' => $this->template, 433 ); 434 // If the parent theme is in another root, we'll want to cache this. Avoids an entire branch of filesystem calls above. 435 if ( isset( $theme_root_template ) ) { 436 $cache['theme_root_template'] = $theme_root_template; 437 } 438 $this->cache_add( 'theme', $cache ); 439 } 440 } 441 442 /** 443 * When converting the object to a string, the theme name is returned. 444 * 445 * @since 3.4.0 446 * 447 * @return string Theme name, ready for display (translated) 448 */ 449 public function __toString() { 450 return (string) $this->display( 'Name' ); 451 } 452 453 /** 454 * __isset() magic method for properties formerly returned by current_theme_info() 455 * 456 * @since 3.4.0 457 * 458 * @param string $offset Property to check if set. 459 * @return bool Whether the given property is set. 460 */ 461 public function __isset( $offset ) { 462 static $properties = array( 463 'name', 464 'title', 465 'version', 466 'parent_theme', 467 'template_dir', 468 'stylesheet_dir', 469 'template', 470 'stylesheet', 471 'screenshot', 472 'description', 473 'author', 474 'tags', 475 'theme_root', 476 'theme_root_uri', 477 ); 478 479 return in_array( $offset, $properties, true ); 480 } 481 482 /** 483 * __get() magic method for properties formerly returned by current_theme_info() 484 * 485 * @since 3.4.0 486 * 487 * @param string $offset Property to get. 488 * @return mixed Property value. 489 */ 490 public function __get( $offset ) { 491 switch ( $offset ) { 492 case 'name': 493 case 'title': 494 return $this->get( 'Name' ); 495 case 'version': 496 return $this->get( 'Version' ); 497 case 'parent_theme': 498 return $this->parent() ? $this->parent()->get( 'Name' ) : ''; 499 case 'template_dir': 500 return $this->get_template_directory(); 501 case 'stylesheet_dir': 502 return $this->get_stylesheet_directory(); 503 case 'template': 504 return $this->get_template(); 505 case 'stylesheet': 506 return $this->get_stylesheet(); 507 case 'screenshot': 508 return $this->get_screenshot( 'relative' ); 509 // 'author' and 'description' did not previously return translated data. 510 case 'description': 511 return $this->display( 'Description' ); 512 case 'author': 513 return $this->display( 'Author' ); 514 case 'tags': 515 return $this->get( 'Tags' ); 516 case 'theme_root': 517 return $this->get_theme_root(); 518 case 'theme_root_uri': 519 return $this->get_theme_root_uri(); 520 // For cases where the array was converted to an object. 521 default: 522 return $this->offsetGet( $offset ); 523 } 524 } 525 526 /** 527 * Method to implement ArrayAccess for keys formerly returned by get_themes() 528 * 529 * @since 3.4.0 530 * 531 * @param mixed $offset 532 * @param mixed $value 533 */ 534 public function offsetSet( $offset, $value ) {} 535 536 /** 537 * Method to implement ArrayAccess for keys formerly returned by get_themes() 538 * 539 * @since 3.4.0 540 * 541 * @param mixed $offset 542 */ 543 public function offsetUnset( $offset ) {} 544 545 /** 546 * Method to implement ArrayAccess for keys formerly returned by get_themes() 547 * 548 * @since 3.4.0 549 * 550 * @param mixed $offset 551 * @return bool 552 */ 553 public function offsetExists( $offset ) { 554 static $keys = array( 555 'Name', 556 'Version', 557 'Status', 558 'Title', 559 'Author', 560 'Author Name', 561 'Author URI', 562 'Description', 563 'Template', 564 'Stylesheet', 565 'Template Files', 566 'Stylesheet Files', 567 'Template Dir', 568 'Stylesheet Dir', 569 'Screenshot', 570 'Tags', 571 'Theme Root', 572 'Theme Root URI', 573 'Parent Theme', 574 ); 575 576 return in_array( $offset, $keys, true ); 577 } 578 579 /** 580 * Method to implement ArrayAccess for keys formerly returned by get_themes(). 581 * 582 * Author, Author Name, Author URI, and Description did not previously return 583 * translated data. We are doing so now as it is safe to do. However, as 584 * Name and Title could have been used as the key for get_themes(), both remain 585 * untranslated for back compatibility. This means that ['Name'] is not ideal, 586 * and care should be taken to use `$theme::display( 'Name' )` to get a properly 587 * translated header. 588 * 589 * @since 3.4.0 590 * 591 * @param mixed $offset 592 * @return mixed 593 */ 594 public function offsetGet( $offset ) { 595 switch ( $offset ) { 596 case 'Name': 597 case 'Title': 598 /* 599 * See note above about using translated data. get() is not ideal. 600 * It is only for backward compatibility. Use display(). 601 */ 602 return $this->get( 'Name' ); 603 case 'Author': 604 return $this->display( 'Author' ); 605 case 'Author Name': 606 return $this->display( 'Author', false ); 607 case 'Author URI': 608 return $this->display( 'AuthorURI' ); 609 case 'Description': 610 return $this->display( 'Description' ); 611 case 'Version': 612 case 'Status': 613 return $this->get( $offset ); 614 case 'Template': 615 return $this->get_template(); 616 case 'Stylesheet': 617 return $this->get_stylesheet(); 618 case 'Template Files': 619 return $this->get_files( 'php', 1, true ); 620 case 'Stylesheet Files': 621 return $this->get_files( 'css', 0, false ); 622 case 'Template Dir': 623 return $this->get_template_directory(); 624 case 'Stylesheet Dir': 625 return $this->get_stylesheet_directory(); 626 case 'Screenshot': 627 return $this->get_screenshot( 'relative' ); 628 case 'Tags': 629 return $this->get( 'Tags' ); 630 case 'Theme Root': 631 return $this->get_theme_root(); 632 case 'Theme Root URI': 633 return $this->get_theme_root_uri(); 634 case 'Parent Theme': 635 return $this->parent() ? $this->parent()->get( 'Name' ) : ''; 636 default: 637 return null; 638 } 639 } 640 641 /** 642 * Returns errors property. 643 * 644 * @since 3.4.0 645 * 646 * @return WP_Error|false WP_Error if there are errors, or false. 647 */ 648 public function errors() { 649 return is_wp_error( $this->errors ) ? $this->errors : false; 650 } 651 652 /** 653 * Whether the theme exists. 654 * 655 * A theme with errors exists. A theme with the error of 'theme_not_found', 656 * meaning that the theme's directory was not found, does not exist. 657 * 658 * @since 3.4.0 659 * 660 * @return bool Whether the theme exists. 661 */ 662 public function exists() { 663 return ! ( $this->errors() && in_array( 'theme_not_found', $this->errors()->get_error_codes(), true ) ); 664 } 665 666 /** 667 * Returns reference to the parent theme. 668 * 669 * @since 3.4.0 670 * 671 * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme. 672 */ 673 public function parent() { 674 return isset( $this->parent ) ? $this->parent : false; 675 } 676 677 /** 678 * Adds theme data to cache. 679 * 680 * Cache entries keyed by the theme and the type of data. 681 * 682 * @since 3.4.0 683 * 684 * @param string $key Type of data to store (theme, screenshot, headers, post_templates) 685 * @param array|string $data Data to store 686 * @return bool Return value from wp_cache_add() 687 */ 688 private function cache_add( $key, $data ) { 689 return wp_cache_add( $key . '-' . $this->cache_hash, $data, 'themes', self::$cache_expiration ); 690 } 691 692 /** 693 * Gets theme data from cache. 694 * 695 * Cache entries are keyed by the theme and the type of data. 696 * 697 * @since 3.4.0 698 * 699 * @param string $key Type of data to retrieve (theme, screenshot, headers, post_templates) 700 * @return mixed Retrieved data 701 */ 702 private function cache_get( $key ) { 703 return wp_cache_get( $key . '-' . $this->cache_hash, 'themes' ); 704 } 705 706 /** 707 * Clears the cache for the theme. 708 * 709 * @since 3.4.0 710 */ 711 public function cache_delete() { 712 foreach ( array( 'theme', 'screenshot', 'headers', 'post_templates' ) as $key ) { 713 wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' ); 714 } 715 $this->template = null; 716 $this->textdomain_loaded = null; 717 $this->theme_root_uri = null; 718 $this->parent = null; 719 $this->errors = null; 720 $this->headers_sanitized = null; 721 $this->name_translated = null; 722 $this->headers = array(); 723 $this->__construct( $this->stylesheet, $this->theme_root ); 724 } 725 726 /** 727 * Get a raw, unformatted theme header. 728 * 729 * The header is sanitized, but is not translated, and is not marked up for display. 730 * To get a theme header for display, use the display() method. 731 * 732 * Use the get_template() method, not the 'Template' header, for finding the template. 733 * The 'Template' header is only good for what was written in the style.css, while 734 * get_template() takes into account where WordPress actually located the theme and 735 * whether it is actually valid. 736 * 737 * @since 3.4.0 738 * 739 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. 740 * @return string|array|false String or array (for Tags header) on success, false on failure. 741 */ 742 public function get( $header ) { 743 if ( ! isset( $this->headers[ $header ] ) ) { 744 return false; 745 } 746 747 if ( ! isset( $this->headers_sanitized ) ) { 748 $this->headers_sanitized = $this->cache_get( 'headers' ); 749 if ( ! is_array( $this->headers_sanitized ) ) { 750 $this->headers_sanitized = array(); 751 } 752 } 753 754 if ( isset( $this->headers_sanitized[ $header ] ) ) { 755 return $this->headers_sanitized[ $header ]; 756 } 757 758 // If themes are a persistent group, sanitize everything and cache it. One cache add is better than many cache sets. 759 if ( self::$persistently_cache ) { 760 foreach ( array_keys( $this->headers ) as $_header ) { 761 $this->headers_sanitized[ $_header ] = $this->sanitize_header( $_header, $this->headers[ $_header ] ); 762 } 763 $this->cache_add( 'headers', $this->headers_sanitized ); 764 } else { 765 $this->headers_sanitized[ $header ] = $this->sanitize_header( $header, $this->headers[ $header ] ); 766 } 767 768 return $this->headers_sanitized[ $header ]; 769 } 770 771 /** 772 * Gets a theme header, formatted and translated for display. 773 * 774 * @since 3.4.0 775 * 776 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. 777 * @param bool $markup Optional. Whether to mark up the header. Defaults to true. 778 * @param bool $translate Optional. Whether to translate the header. Defaults to true. 779 * @return string|array|false Processed header. An array for Tags if `$markup` is false, string otherwise. 780 * False on failure. 781 */ 782 public function display( $header, $markup = true, $translate = true ) { 783 $value = $this->get( $header ); 784 if ( false === $value ) { 785 return false; 786 } 787 788 if ( $translate && ( empty( $value ) || ! $this->load_textdomain() ) ) { 789 $translate = false; 790 } 791 792 if ( $translate ) { 793 $value = $this->translate_header( $header, $value ); 794 } 795 796 if ( $markup ) { 797 $value = $this->markup_header( $header, $value, $translate ); 798 } 799 800 return $value; 801 } 802 803 /** 804 * Sanitize a theme header. 805 * 806 * @since 3.4.0 807 * @since 5.4.0 Added support for `Requires at least` and `Requires PHP` headers. 808 * 809 * @param string $header Theme header. Accepts 'Name', 'Description', 'Author', 'Version', 810 * 'ThemeURI', 'AuthorURI', 'Status', 'Tags', 'RequiresWP', 'RequiresPHP'. 811 * @param string $value Value to sanitize. 812 * @return string|array An array for Tags header, string otherwise. 813 */ 814 private function sanitize_header( $header, $value ) { 815 switch ( $header ) { 816 case 'Status': 817 if ( ! $value ) { 818 $value = 'publish'; 819 break; 820 } 821 // Fall through otherwise. 822 case 'Name': 823 static $header_tags = array( 824 'abbr' => array( 'title' => true ), 825 'acronym' => array( 'title' => true ), 826 'code' => true, 827 'em' => true, 828 'strong' => true, 829 ); 830 831 $value = wp_kses( $value, $header_tags ); 832 break; 833 case 'Author': 834 // There shouldn't be anchor tags in Author, but some themes like to be challenging. 835 case 'Description': 836 static $header_tags_with_a = array( 837 'a' => array( 838 'href' => true, 839 'title' => true, 840 ), 841 'abbr' => array( 'title' => true ), 842 'acronym' => array( 'title' => true ), 843 'code' => true, 844 'em' => true, 845 'strong' => true, 846 ); 847 848 $value = wp_kses( $value, $header_tags_with_a ); 849 break; 850 case 'ThemeURI': 851 case 'AuthorURI': 852 $value = esc_url_raw( $value ); 853 break; 854 case 'Tags': 855 $value = array_filter( array_map( 'trim', explode( ',', strip_tags( $value ) ) ) ); 856 break; 857 case 'Version': 858 case 'RequiresWP': 859 case 'RequiresPHP': 860 $value = strip_tags( $value ); 861 break; 862 } 863 864 return $value; 865 } 866 867 /** 868 * Mark up a theme header. 869 * 870 * @since 3.4.0 871 * 872 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. 873 * @param string|array $value Value to mark up. An array for Tags header, string otherwise. 874 * @param string $translate Whether the header has been translated. 875 * @return string Value, marked up. 876 */ 877 private function markup_header( $header, $value, $translate ) { 878 switch ( $header ) { 879 case 'Name': 880 if ( empty( $value ) ) { 881 $value = esc_html( $this->get_stylesheet() ); 882 } 883 break; 884 case 'Description': 885 $value = wptexturize( $value ); 886 break; 887 case 'Author': 888 if ( $this->get( 'AuthorURI' ) ) { 889 $value = sprintf( '<a href="%1$s">%2$s</a>', $this->display( 'AuthorURI', true, $translate ), $value ); 890 } elseif ( ! $value ) { 891 $value = __( 'Anonymous' ); 892 } 893 break; 894 case 'Tags': 895 static $comma = null; 896 if ( ! isset( $comma ) ) { 897 /* translators: Used between list items, there is a space after the comma. */ 898 $comma = __( ', ' ); 899 } 900 $value = implode( $comma, $value ); 901 break; 902 case 'ThemeURI': 903 case 'AuthorURI': 904 $value = esc_url( $value ); 905 break; 906 } 907 908 return $value; 909 } 910 911 /** 912 * Translate a theme header. 913 * 914 * @since 3.4.0 915 * 916 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. 917 * @param string|array $value Value to translate. An array for Tags header, string otherwise. 918 * @return string|array Translated value. An array for Tags header, string otherwise. 919 */ 920 private function translate_header( $header, $value ) { 921 switch ( $header ) { 922 case 'Name': 923 // Cached for sorting reasons. 924 if ( isset( $this->name_translated ) ) { 925 return $this->name_translated; 926 } 927 928 // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain 929 $this->name_translated = translate( $value, $this->get( 'TextDomain' ) ); 930 931 return $this->name_translated; 932 case 'Tags': 933 if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) ) { 934 return $value; 935 } 936 937 static $tags_list; 938 if ( ! isset( $tags_list ) ) { 939 $tags_list = array( 940 // As of 4.6, deprecated tags which are only used to provide translation for older themes. 941 'black' => __( 'Black' ), 942 'blue' => __( 'Blue' ), 943 'brown' => __( 'Brown' ), 944 'gray' => __( 'Gray' ), 945 'green' => __( 'Green' ), 946 'orange' => __( 'Orange' ), 947 'pink' => __( 'Pink' ), 948 'purple' => __( 'Purple' ), 949 'red' => __( 'Red' ), 950 'silver' => __( 'Silver' ), 951 'tan' => __( 'Tan' ), 952 'white' => __( 'White' ), 953 'yellow' => __( 'Yellow' ), 954 'dark' => __( 'Dark' ), 955 'light' => __( 'Light' ), 956 'fixed-layout' => __( 'Fixed Layout' ), 957 'fluid-layout' => __( 'Fluid Layout' ), 958 'responsive-layout' => __( 'Responsive Layout' ), 959 'blavatar' => __( 'Blavatar' ), 960 'photoblogging' => __( 'Photoblogging' ), 961 'seasonal' => __( 'Seasonal' ), 962 ); 963 964 $feature_list = get_theme_feature_list( false ); // No API. 965 966 foreach ( $feature_list as $tags ) { 967 $tags_list += $tags; 968 } 969 } 970 971 foreach ( $value as &$tag ) { 972 if ( isset( $tags_list[ $tag ] ) ) { 973 $tag = $tags_list[ $tag ]; 974 } elseif ( isset( self::$tag_map[ $tag ] ) ) { 975 $tag = $tags_list[ self::$tag_map[ $tag ] ]; 976 } 977 } 978 979 return $value; 980 981 default: 982 // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain 983 $value = translate( $value, $this->get( 'TextDomain' ) ); 984 } 985 return $value; 986 } 987 988 /** 989 * The directory name of the theme's "stylesheet" files, inside the theme root. 990 * 991 * In the case of a child theme, this is directory name of the child theme. 992 * Otherwise, get_stylesheet() is the same as get_template(). 993 * 994 * @since 3.4.0 995 * 996 * @return string Stylesheet 997 */ 998 public function get_stylesheet() { 999 return $this->stylesheet; 1000 } 1001 1002 /** 1003 * The directory name of the theme's "template" files, inside the theme root. 1004 * 1005 * In the case of a child theme, this is the directory name of the parent theme. 1006 * Otherwise, the get_template() is the same as get_stylesheet(). 1007 * 1008 * @since 3.4.0 1009 * 1010 * @return string Template 1011 */ 1012 public function get_template() { 1013 return $this->template; 1014 } 1015 1016 /** 1017 * Returns the absolute path to the directory of a theme's "stylesheet" files. 1018 * 1019 * In the case of a child theme, this is the absolute path to the directory 1020 * of the child theme's files. 1021 * 1022 * @since 3.4.0 1023 * 1024 * @return string Absolute path of the stylesheet directory. 1025 */ 1026 public function get_stylesheet_directory() { 1027 if ( $this->errors() && in_array( 'theme_root_missing', $this->errors()->get_error_codes(), true ) ) { 1028 return ''; 1029 } 1030 1031 return $this->theme_root . '/' . $this->stylesheet; 1032 } 1033 1034 /** 1035 * Returns the absolute path to the directory of a theme's "template" files. 1036 * 1037 * In the case of a child theme, this is the absolute path to the directory 1038 * of the parent theme's files. 1039 * 1040 * @since 3.4.0 1041 * 1042 * @return string Absolute path of the template directory. 1043 */ 1044 public function get_template_directory() { 1045 if ( $this->parent() ) { 1046 $theme_root = $this->parent()->theme_root; 1047 } else { 1048 $theme_root = $this->theme_root; 1049 } 1050 1051 return $theme_root . '/' . $this->template; 1052 } 1053 1054 /** 1055 * Returns the URL to the directory of a theme's "stylesheet" files. 1056 * 1057 * In the case of a child theme, this is the URL to the directory of the 1058 * child theme's files. 1059 * 1060 * @since 3.4.0 1061 * 1062 * @return string URL to the stylesheet directory. 1063 */ 1064 public function get_stylesheet_directory_uri() { 1065 return $this->get_theme_root_uri() . '/' . str_replace( '%2F', '/', rawurlencode( $this->stylesheet ) ); 1066 } 1067 1068 /** 1069 * Returns the URL to the directory of a theme's "template" files. 1070 * 1071 * In the case of a child theme, this is the URL to the directory of the 1072 * parent theme's files. 1073 * 1074 * @since 3.4.0 1075 * 1076 * @return string URL to the template directory. 1077 */ 1078 public function get_template_directory_uri() { 1079 if ( $this->parent() ) { 1080 $theme_root_uri = $this->parent()->get_theme_root_uri(); 1081 } else { 1082 $theme_root_uri = $this->get_theme_root_uri(); 1083 } 1084 1085 return $theme_root_uri . '/' . str_replace( '%2F', '/', rawurlencode( $this->template ) ); 1086 } 1087 1088 /** 1089 * The absolute path to the directory of the theme root. 1090 * 1091 * This is typically the absolute path to wp-content/themes. 1092 * 1093 * @since 3.4.0 1094 * 1095 * @return string Theme root. 1096 */ 1097 public function get_theme_root() { 1098 return $this->theme_root; 1099 } 1100 1101 /** 1102 * Returns the URL to the directory of the theme root. 1103 * 1104 * This is typically the absolute URL to wp-content/themes. This forms the basis 1105 * for all other URLs returned by WP_Theme, so we pass it to the public function 1106 * get_theme_root_uri() and allow it to run the {@see 'theme_root_uri'} filter. 1107 * 1108 * @since 3.4.0 1109 * 1110 * @return string Theme root URI. 1111 */ 1112 public function get_theme_root_uri() { 1113 if ( ! isset( $this->theme_root_uri ) ) { 1114 $this->theme_root_uri = get_theme_root_uri( $this->stylesheet, $this->theme_root ); 1115 } 1116 return $this->theme_root_uri; 1117 } 1118 1119 /** 1120 * Returns the main screenshot file for the theme. 1121 * 1122 * The main screenshot is called screenshot.png. gif and jpg extensions are also allowed. 1123 * 1124 * Screenshots for a theme must be in the stylesheet directory. (In the case of child 1125 * themes, parent theme screenshots are not inherited.) 1126 * 1127 * @since 3.4.0 1128 * 1129 * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI. 1130 * @return string|false Screenshot file. False if the theme does not have a screenshot. 1131 */ 1132 public function get_screenshot( $uri = 'uri' ) { 1133 $screenshot = $this->cache_get( 'screenshot' ); 1134 if ( $screenshot ) { 1135 if ( 'relative' === $uri ) { 1136 return $screenshot; 1137 } 1138 return $this->get_stylesheet_directory_uri() . '/' . $screenshot; 1139 } elseif ( 0 === $screenshot ) { 1140 return false; 1141 } 1142 1143 foreach ( array( 'png', 'gif', 'jpg', 'jpeg' ) as $ext ) { 1144 if ( file_exists( $this->get_stylesheet_directory() . "/screenshot.$ext" ) ) { 1145 $this->cache_add( 'screenshot', 'screenshot.' . $ext ); 1146 if ( 'relative' === $uri ) { 1147 return 'screenshot.' . $ext; 1148 } 1149 return $this->get_stylesheet_directory_uri() . '/' . 'screenshot.' . $ext; 1150 } 1151 } 1152 1153 $this->cache_add( 'screenshot', 0 ); 1154 return false; 1155 } 1156 1157 /** 1158 * Return files in the theme's directory. 1159 * 1160 * @since 3.4.0 1161 * 1162 * @param string[]|string $type Optional. Array of extensions to find, string of a single extension, 1163 * or null for all extensions. Default null. 1164 * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). 1165 * -1 depth is infinite. 1166 * @param bool $search_parent Optional. Whether to return parent files. Default false. 1167 * @return string[] Array of files, keyed by the path to the file relative to the theme's directory, with the values 1168 * being absolute paths. 1169 */ 1170 public function get_files( $type = null, $depth = 0, $search_parent = false ) { 1171 $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth ); 1172 1173 if ( $search_parent && $this->parent() ) { 1174 $files += (array) self::scandir( $this->get_template_directory(), $type, $depth ); 1175 } 1176 1177 return $files; 1178 } 1179 1180 /** 1181 * Returns the theme's post templates. 1182 * 1183 * @since 4.7.0 1184 * 1185 * @return string[] Array of page templates, keyed by filename and post type, 1186 * with the value of the translated header name. 1187 */ 1188 public function get_post_templates() { 1189 // If you screw up your current theme and we invalidate your parent, most things still work. Let it slide. 1190 if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) ) { 1191 return array(); 1192 } 1193 1194 $post_templates = $this->cache_get( 'post_templates' ); 1195 1196 if ( ! is_array( $post_templates ) ) { 1197 $post_templates = array(); 1198 1199 $files = (array) $this->get_files( 'php', 1, true ); 1200 1201 foreach ( $files as $file => $full_path ) { 1202 if ( ! preg_match( '|Template Name:(.*)$|mi', file_get_contents( $full_path ), $header ) ) { 1203 continue; 1204 } 1205 1206 $types = array( 'page' ); 1207 if ( preg_match( '|Template Post Type:(.*)$|mi', file_get_contents( $full_path ), $type ) ) { 1208 $types = explode( ',', _cleanup_header_comment( $type[1] ) ); 1209 } 1210 1211 foreach ( $types as $type ) { 1212 $type = sanitize_key( $type ); 1213 if ( ! isset( $post_templates[ $type ] ) ) { 1214 $post_templates[ $type ] = array(); 1215 } 1216 1217 $post_templates[ $type ][ $file ] = _cleanup_header_comment( $header[1] ); 1218 } 1219 } 1220 1221 $this->cache_add( 'post_templates', $post_templates ); 1222 } 1223 1224 if ( $this->load_textdomain() ) { 1225 foreach ( $post_templates as &$post_type ) { 1226 foreach ( $post_type as &$post_template ) { 1227 $post_template = $this->translate_header( 'Template Name', $post_template ); 1228 } 1229 } 1230 } 1231 1232 return $post_templates; 1233 } 1234 1235 /** 1236 * Returns the theme's post templates for a given post type. 1237 * 1238 * @since 3.4.0 1239 * @since 4.7.0 Added the `$post_type` parameter. 1240 * 1241 * @param WP_Post|null $post Optional. The post being edited, provided for context. 1242 * @param string $post_type Optional. Post type to get the templates for. Default 'page'. 1243 * If a post is provided, its post type is used. 1244 * @return string[] Array of template header names keyed by the template file name. 1245 */ 1246 public function get_page_templates( $post = null, $post_type = 'page' ) { 1247 if ( $post ) { 1248 $post_type = get_post_type( $post ); 1249 } 1250 1251 $post_templates = $this->get_post_templates(); 1252 $post_templates = isset( $post_templates[ $post_type ] ) ? $post_templates[ $post_type ] : array(); 1253 1254 /** 1255 * Filters list of page templates for a theme. 1256 * 1257 * @since 4.9.6 1258 * 1259 * @param string[] $post_templates Array of template header names keyed by the template file name. 1260 * @param WP_Theme $this The theme object. 1261 * @param WP_Post|null $post The post being edited, provided for context, or null. 1262 * @param string $post_type Post type to get the templates for. 1263 */ 1264 $post_templates = (array) apply_filters( 'theme_templates', $post_templates, $this, $post, $post_type ); 1265 1266 /** 1267 * Filters list of page templates for a theme. 1268 * 1269 * The dynamic portion of the hook name, `$post_type`, refers to the post type. 1270 * 1271 * @since 3.9.0 1272 * @since 4.4.0 Converted to allow complete control over the `$page_templates` array. 1273 * @since 4.7.0 Added the `$post_type` parameter. 1274 * 1275 * @param string[] $post_templates Array of template header names keyed by the template file name. 1276 * @param WP_Theme $this The theme object. 1277 * @param WP_Post|null $post The post being edited, provided for context, or null. 1278 * @param string $post_type Post type to get the templates for. 1279 */ 1280 $post_templates = (array) apply_filters( "theme_{$post_type}_templates", $post_templates, $this, $post, $post_type ); 1281 1282 return $post_templates; 1283 } 1284 1285 /** 1286 * Scans a directory for files of a certain extension. 1287 * 1288 * @since 3.4.0 1289 * 1290 * @param string $path Absolute path to search. 1291 * @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension, 1292 * or null for all extensions. Default null. 1293 * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or 1294 * -1 (infinite depth). Default 0. 1295 * @param string $relative_path Optional. The basename of the absolute path. Used to control the 1296 * returned path for the found files, particularly when this function 1297 * recurses to lower depths. Default empty. 1298 * @return string[]|false Array of files, keyed by the path to the file relative to the `$path` directory prepended 1299 * with `$relative_path`, with the values being absolute paths. False otherwise. 1300 */ 1301 private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) { 1302 if ( ! is_dir( $path ) ) { 1303 return false; 1304 } 1305 1306 if ( $extensions ) { 1307 $extensions = (array) $extensions; 1308 $_extensions = implode( '|', $extensions ); 1309 } 1310 1311 $relative_path = trailingslashit( $relative_path ); 1312 if ( '/' === $relative_path ) { 1313 $relative_path = ''; 1314 } 1315 1316 $results = scandir( $path ); 1317 $files = array(); 1318 1319 /** 1320 * Filters the array of excluded directories and files while scanning theme folder. 1321 * 1322 * @since 4.7.4 1323 * 1324 * @param string[] $exclusions Array of excluded directories and files. 1325 */ 1326 $exclusions = (array) apply_filters( 'theme_scandir_exclusions', array( 'CVS', 'node_modules', 'vendor', 'bower_components' ) ); 1327 1328 foreach ( $results as $result ) { 1329 if ( '.' === $result[0] || in_array( $result, $exclusions, true ) ) { 1330 continue; 1331 } 1332 if ( is_dir( $path . '/' . $result ) ) { 1333 if ( ! $depth ) { 1334 continue; 1335 } 1336 $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1, $relative_path . $result ); 1337 $files = array_merge_recursive( $files, $found ); 1338 } elseif ( ! $extensions || preg_match( '~\.(' . $_extensions . ')$~', $result ) ) { 1339 $files[ $relative_path . $result ] = $path . '/' . $result; 1340 } 1341 } 1342 1343 return $files; 1344 } 1345 1346 /** 1347 * Loads the theme's textdomain. 1348 * 1349 * Translation files are not inherited from the parent theme. TODO: If this fails for the 1350 * child theme, it should probably try to load the parent theme's translations. 1351 * 1352 * @since 3.4.0 1353 * 1354 * @return bool True if the textdomain was successfully loaded or has already been loaded. 1355 * False if no textdomain was specified in the file headers, or if the domain could not be loaded. 1356 */ 1357 public function load_textdomain() { 1358 if ( isset( $this->textdomain_loaded ) ) { 1359 return $this->textdomain_loaded; 1360 } 1361 1362 $textdomain = $this->get( 'TextDomain' ); 1363 if ( ! $textdomain ) { 1364 $this->textdomain_loaded = false; 1365 return false; 1366 } 1367 1368 if ( is_textdomain_loaded( $textdomain ) ) { 1369 $this->textdomain_loaded = true; 1370 return true; 1371 } 1372 1373 $path = $this->get_stylesheet_directory(); 1374 $domainpath = $this->get( 'DomainPath' ); 1375 if ( $domainpath ) { 1376 $path .= $domainpath; 1377 } else { 1378 $path .= '/languages'; 1379 } 1380 1381 $this->textdomain_loaded = load_theme_textdomain( $textdomain, $path ); 1382 return $this->textdomain_loaded; 1383 } 1384 1385 /** 1386 * Whether the theme is allowed (multisite only). 1387 * 1388 * @since 3.4.0 1389 * 1390 * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site' 1391 * settings, or 'both'. Defaults to 'both'. 1392 * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current site. 1393 * @return bool Whether the theme is allowed for the network. Returns true in single-site. 1394 */ 1395 public function is_allowed( $check = 'both', $blog_id = null ) { 1396 if ( ! is_multisite() ) { 1397 return true; 1398 } 1399 1400 if ( 'both' === $check || 'network' === $check ) { 1401 $allowed = self::get_allowed_on_network(); 1402 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) ) { 1403 return true; 1404 } 1405 } 1406 1407 if ( 'both' === $check || 'site' === $check ) { 1408 $allowed = self::get_allowed_on_site( $blog_id ); 1409 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) ) { 1410 return true; 1411 } 1412 } 1413 1414 return false; 1415 } 1416 1417 /** 1418 * Determines the latest WordPress default theme that is installed. 1419 * 1420 * This hits the filesystem. 1421 * 1422 * @since 4.4.0 1423 * 1424 * @return WP_Theme|false Object, or false if no theme is installed, which would be bad. 1425 */ 1426 public static function get_core_default_theme() { 1427 foreach ( array_reverse( self::$default_themes ) as $slug => $name ) { 1428 $theme = wp_get_theme( $slug ); 1429 if ( $theme->exists() ) { 1430 return $theme; 1431 } 1432 } 1433 return false; 1434 } 1435 1436 /** 1437 * Returns array of stylesheet names of themes allowed on the site or network. 1438 * 1439 * @since 3.4.0 1440 * 1441 * @param int $blog_id Optional. ID of the site. Defaults to the current site. 1442 * @return string[] Array of stylesheet names. 1443 */ 1444 public static function get_allowed( $blog_id = null ) { 1445 /** 1446 * Filters the array of themes allowed on the network. 1447 * 1448 * Site is provided as context so that a list of network allowed themes can 1449 * be filtered further. 1450 * 1451 * @since 4.5.0 1452 * 1453 * @param string[] $allowed_themes An array of theme stylesheet names. 1454 * @param int $blog_id ID of the site. 1455 */ 1456 $network = (array) apply_filters( 'network_allowed_themes', self::get_allowed_on_network(), $blog_id ); 1457 return $network + self::get_allowed_on_site( $blog_id ); 1458 } 1459 1460 /** 1461 * Returns array of stylesheet names of themes allowed on the network. 1462 * 1463 * @since 3.4.0 1464 * 1465 * @return string[] Array of stylesheet names. 1466 */ 1467 public static function get_allowed_on_network() { 1468 static $allowed_themes; 1469 if ( ! isset( $allowed_themes ) ) { 1470 $allowed_themes = (array) get_site_option( 'allowedthemes' ); 1471 } 1472 1473 /** 1474 * Filters the array of themes allowed on the network. 1475 * 1476 * @since MU (3.0.0) 1477 * 1478 * @param string[] $allowed_themes An array of theme stylesheet names. 1479 */ 1480 $allowed_themes = apply_filters( 'allowed_themes', $allowed_themes ); 1481 1482 return $allowed_themes; 1483 } 1484 1485 /** 1486 * Returns array of stylesheet names of themes allowed on the site. 1487 * 1488 * @since 3.4.0 1489 * 1490 * @param int $blog_id Optional. ID of the site. Defaults to the current site. 1491 * @return string[] Array of stylesheet names. 1492 */ 1493 public static function get_allowed_on_site( $blog_id = null ) { 1494 static $allowed_themes = array(); 1495 1496 if ( ! $blog_id || ! is_multisite() ) { 1497 $blog_id = get_current_blog_id(); 1498 } 1499 1500 if ( isset( $allowed_themes[ $blog_id ] ) ) { 1501 /** 1502 * Filters the array of themes allowed on the site. 1503 * 1504 * @since 4.5.0 1505 * 1506 * @param string[] $allowed_themes An array of theme stylesheet names. 1507 * @param int $blog_id ID of the site. Defaults to current site. 1508 */ 1509 return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id ); 1510 } 1511 1512 $current = get_current_blog_id() == $blog_id; 1513 1514 if ( $current ) { 1515 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' ); 1516 } else { 1517 switch_to_blog( $blog_id ); 1518 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' ); 1519 restore_current_blog(); 1520 } 1521 1522 // This is all super old MU back compat joy. 1523 // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name. 1524 if ( false === $allowed_themes[ $blog_id ] ) { 1525 if ( $current ) { 1526 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' ); 1527 } else { 1528 switch_to_blog( $blog_id ); 1529 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' ); 1530 restore_current_blog(); 1531 } 1532 1533 if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) { 1534 $allowed_themes[ $blog_id ] = array(); 1535 } else { 1536 $converted = array(); 1537 $themes = wp_get_themes(); 1538 foreach ( $themes as $stylesheet => $theme_data ) { 1539 if ( isset( $allowed_themes[ $blog_id ][ $theme_data->get( 'Name' ) ] ) ) { 1540 $converted[ $stylesheet ] = true; 1541 } 1542 } 1543 $allowed_themes[ $blog_id ] = $converted; 1544 } 1545 // Set the option so we never have to go through this pain again. 1546 if ( is_admin() && $allowed_themes[ $blog_id ] ) { 1547 if ( $current ) { 1548 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] ); 1549 delete_option( 'allowed_themes' ); 1550 } else { 1551 switch_to_blog( $blog_id ); 1552 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] ); 1553 delete_option( 'allowed_themes' ); 1554 restore_current_blog(); 1555 } 1556 } 1557 } 1558 1559 /** This filter is documented in wp-includes/class-wp-theme.php */ 1560 return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id ); 1561 } 1562 1563 /** 1564 * Enables a theme for all sites on the current network. 1565 * 1566 * @since 4.6.0 1567 * 1568 * @param string|string[] $stylesheets Stylesheet name or array of stylesheet names. 1569 */ 1570 public static function network_enable_theme( $stylesheets ) { 1571 if ( ! is_multisite() ) { 1572 return; 1573 } 1574 1575 if ( ! is_array( $stylesheets ) ) { 1576 $stylesheets = array( $stylesheets ); 1577 } 1578 1579 $allowed_themes = get_site_option( 'allowedthemes' ); 1580 foreach ( $stylesheets as $stylesheet ) { 1581 $allowed_themes[ $stylesheet ] = true; 1582 } 1583 1584 update_site_option( 'allowedthemes', $allowed_themes ); 1585 } 1586 1587 /** 1588 * Disables a theme for all sites on the current network. 1589 * 1590 * @since 4.6.0 1591 * 1592 * @param string|string[] $stylesheets Stylesheet name or array of stylesheet names. 1593 */ 1594 public static function network_disable_theme( $stylesheets ) { 1595 if ( ! is_multisite() ) { 1596 return; 1597 } 1598 1599 if ( ! is_array( $stylesheets ) ) { 1600 $stylesheets = array( $stylesheets ); 1601 } 1602 1603 $allowed_themes = get_site_option( 'allowedthemes' ); 1604 foreach ( $stylesheets as $stylesheet ) { 1605 if ( isset( $allowed_themes[ $stylesheet ] ) ) { 1606 unset( $allowed_themes[ $stylesheet ] ); 1607 } 1608 } 1609 1610 update_site_option( 'allowedthemes', $allowed_themes ); 1611 } 1612 1613 /** 1614 * Sorts themes by name. 1615 * 1616 * @since 3.4.0 1617 * 1618 * @param WP_Theme[] $themes Array of theme objects to sort (passed by reference). 1619 */ 1620 public static function sort_by_name( &$themes ) { 1621 if ( 0 === strpos( get_user_locale(), 'en_' ) ) { 1622 uasort( $themes, array( 'WP_Theme', '_name_sort' ) ); 1623 } else { 1624 foreach ( $themes as $key => $theme ) { 1625 $theme->translate_header( 'Name', $theme->headers['Name'] ); 1626 } 1627 uasort( $themes, array( 'WP_Theme', '_name_sort_i18n' ) ); 1628 } 1629 } 1630 1631 /** 1632 * Callback function for usort() to naturally sort themes by name. 1633 * 1634 * Accesses the Name header directly from the class for maximum speed. 1635 * Would choke on HTML but we don't care enough to slow it down with strip_tags(). 1636 * 1637 * @since 3.4.0 1638 * 1639 * @param WP_Theme $a First theme. 1640 * @param WP_Theme $b Second theme. 1641 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally. 1642 * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort(). 1643 */ 1644 private static function _name_sort( $a, $b ) { 1645 return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] ); 1646 } 1647 1648 /** 1649 * Callback function for usort() to naturally sort themes by translated name. 1650 * 1651 * @since 3.4.0 1652 * 1653 * @param WP_Theme $a First theme. 1654 * @param WP_Theme $b Second theme. 1655 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally. 1656 * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort(). 1657 */ 1658 private static function _name_sort_i18n( $a, $b ) { 1659 return strnatcasecmp( $a->name_translated, $b->name_translated ); 1660 } 1661 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Wed Aug 5 01:00:03 2020 | Cross-referenced by PHPXref 0.7.1 |