9 final class WP_Theme implements ArrayAccess {
12 * Whether the theme has been marked as updateable.
18 * @see WP_MS_Themes_List_Table
20 public $update = false;
23 * Headers for style.css files.
29 private static $file_headers = array(
30 'Name' => 'Theme Name',
31 'ThemeURI' => 'Theme URI',
32 'Description' => 'Description',
34 'AuthorURI' => 'Author URI',
35 'Version' => 'Version',
36 'Template' => 'Template',
39 'TextDomain' => 'Text Domain',
40 'DomainPath' => 'Domain Path',
50 private static $default_themes = array(
51 'classic' => 'WordPress Classic',
52 'default' => 'WordPress Default',
53 'twentyten' => 'Twenty Ten',
54 'twentyeleven' => 'Twenty Eleven',
55 'twentytwelve' => 'Twenty Twelve',
56 'twentythirteen' => 'Twenty Thirteen',
57 'twentyfourteen' => 'Twenty Fourteen',
58 'twentyfifteen' => 'Twenty Fifteen',
59 'twentysixteen' => 'Twenty Sixteen',
69 private static $tag_map = array(
70 'fixed-width' => 'fixed-layout',
71 'flexible-width' => 'fluid-layout',
75 * Absolute path to the theme root, usually wp-content/themes
83 * Header data from the theme's style.css file.
88 private $headers = array();
91 * Header data from the theme's style.css file after being sanitized.
96 private $headers_sanitized;
99 * Header name from the theme's style.css after being translated.
101 * Cached due to sorting functions running over the translated name.
106 private $name_translated;
109 * Errors encountered when initializing the theme.
117 * The directory name of the theme's files, inside the theme root.
119 * In the case of a child theme, this is directory name of the child theme.
120 * Otherwise, 'stylesheet' is the same as 'template'.
128 * The directory name of the theme's files, inside the theme root.
130 * In the case of a child theme, this is the directory name of the parent theme.
131 * Otherwise, 'template' is the same as 'stylesheet'.
139 * A reference to the parent theme, in the case of a child theme.
147 * URL to the theme root, usually an absolute URL to wp-content/themes
152 private $theme_root_uri;
155 * Flag for whether the theme's textdomain is loaded.
160 private $textdomain_loaded;
163 * Stores an md5 hash of the theme root, to function as the cache key.
171 * Flag for whether the themes cache bucket should be persistently cached.
173 * Default is false. Can be set with the wp_cache_themes_persistently filter.
179 private static $persistently_cache;
182 * Expiration time for the themes cache bucket.
184 * By default the bucket is not cached, so this value is useless.
190 private static $cache_expiration = 1800;
193 * Constructor for WP_Theme.
195 * @global array $wp_theme_directories
197 * @param string $theme_dir Directory of the theme within the theme_root.
198 * @param string $theme_root Theme root.
199 * @param WP_Error|void $_child If this theme is a parent theme, the child may be passed for validation purposes.
201 public function __construct( $theme_dir, $theme_root, $_child = null ) {
202 global $wp_theme_directories;
204 // Initialize caching on first run.
205 if ( ! isset( self::$persistently_cache ) ) {
206 /** This action is documented in wp-includes/theme.php */
207 self::$persistently_cache = apply_filters( 'wp_cache_themes_persistently', false, 'WP_Theme' );
208 if ( self::$persistently_cache ) {
209 wp_cache_add_global_groups( 'themes' );
210 if ( is_int( self::$persistently_cache ) )
211 self::$cache_expiration = self::$persistently_cache;
213 wp_cache_add_non_persistent_groups( 'themes' );
217 $this->theme_root = $theme_root;
218 $this->stylesheet = $theme_dir;
220 // Correct a situation where the theme is 'some-directory/some-theme' but 'some-directory' was passed in as part of the theme root instead.
221 if ( ! in_array( $theme_root, (array) $wp_theme_directories ) && in_array( dirname( $theme_root ), (array) $wp_theme_directories ) ) {
222 $this->stylesheet = basename( $this->theme_root ) . '/' . $this->stylesheet;
223 $this->theme_root = dirname( $theme_root );
226 $this->cache_hash = md5( $this->theme_root . '/' . $this->stylesheet );
227 $theme_file = $this->stylesheet . '/style.css';
229 $cache = $this->cache_get( 'theme' );
231 if ( is_array( $cache ) ) {
232 foreach ( array( 'errors', 'headers', 'template' ) as $key ) {
233 if ( isset( $cache[ $key ] ) )
234 $this->$key = $cache[ $key ];
238 if ( isset( $cache['theme_root_template'] ) )
239 $theme_root_template = $cache['theme_root_template'];
240 } elseif ( ! file_exists( $this->theme_root . '/' . $theme_file ) ) {
241 $this->headers['Name'] = $this->stylesheet;
242 if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet ) )
243 $this->errors = new WP_Error( 'theme_not_found', sprintf( __( 'The theme directory "%s" does not exist.' ), esc_html( $this->stylesheet ) ) );
245 $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) );
246 $this->template = $this->stylesheet;
247 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
248 if ( ! file_exists( $this->theme_root ) ) // Don't cache this one.
249 $this->errors->add( 'theme_root_missing', __( 'ERROR: The themes directory is either empty or doesn’t exist. Please check your installation.' ) );
251 } elseif ( ! is_readable( $this->theme_root . '/' . $theme_file ) ) {
252 $this->headers['Name'] = $this->stylesheet;
253 $this->errors = new WP_Error( 'theme_stylesheet_not_readable', __( 'Stylesheet is not readable.' ) );
254 $this->template = $this->stylesheet;
255 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
258 $this->headers = get_file_data( $this->theme_root . '/' . $theme_file, self::$file_headers, 'theme' );
259 // Default themes always trump their pretenders.
260 // Properly identify default themes that are inside a directory within wp-content/themes.
261 if ( $default_theme_slug = array_search( $this->headers['Name'], self::$default_themes ) ) {
262 if ( basename( $this->stylesheet ) != $default_theme_slug )
263 $this->headers['Name'] .= '/' . $this->stylesheet;
267 // (If template is set from cache [and there are no errors], we know it's good.)
268 if ( ! $this->template && ! ( $this->template = $this->headers['Template'] ) ) {
269 $this->template = $this->stylesheet;
270 if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet . '/index.php' ) ) {
271 $error_message = sprintf(
272 /* translators: 1: index.php, 2: Codex URL, 3: style.css */
273 __( '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.' ),
274 '<code>index.php</code>',
275 __( 'https://codex.wordpress.org/Child_Themes' ),
276 '<code>style.css</code>'
278 $this->errors = new WP_Error( 'theme_no_index', $error_message );
279 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
284 // If we got our data from cache, we can assume that 'template' is pointing to the right place.
285 if ( ! is_array( $cache ) && $this->template != $this->stylesheet && ! file_exists( $this->theme_root . '/' . $this->template . '/index.php' ) ) {
286 // If we're in a directory of themes inside /themes, look for the parent nearby.
287 // wp-content/themes/directory-of-themes/*
288 $parent_dir = dirname( $this->stylesheet );
289 if ( '.' != $parent_dir && file_exists( $this->theme_root . '/' . $parent_dir . '/' . $this->template . '/index.php' ) ) {
290 $this->template = $parent_dir . '/' . $this->template;
291 } elseif ( ( $directories = search_theme_directories() ) && isset( $directories[ $this->template ] ) ) {
292 // Look for the template in the search_theme_directories() results, in case it is in another theme root.
293 // We don't look into directories of themes, just the theme root.
294 $theme_root_template = $directories[ $this->template ]['theme_root'];
296 // Parent theme is missing.
297 $this->errors = new WP_Error( 'theme_no_parent', sprintf( __( 'The parent theme is missing. Please install the "%s" parent theme.' ), esc_html( $this->template ) ) );
298 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
299 $this->parent = new WP_Theme( $this->template, $this->theme_root, $this );
304 // Set the parent, if we're a child theme.
305 if ( $this->template != $this->stylesheet ) {
306 // If we are a parent, then there is a problem. Only two generations allowed! Cancel things out.
307 if ( $_child instanceof WP_Theme && $_child->template == $this->stylesheet ) {
308 $_child->parent = null;
309 $_child->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), esc_html( $_child->template ) ) );
310 $_child->cache_add( 'theme', array( 'headers' => $_child->headers, 'errors' => $_child->errors, 'stylesheet' => $_child->stylesheet, 'template' => $_child->template ) );
311 // The two themes actually reference each other with the Template header.
312 if ( $_child->stylesheet == $this->template ) {
313 $this->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), esc_html( $this->template ) ) );
314 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
318 // Set the parent. Pass the current instance so we can do the crazy checks above and assess errors.
319 $this->parent = new WP_Theme( $this->template, isset( $theme_root_template ) ? $theme_root_template : $this->theme_root, $this );
322 // We're good. If we didn't retrieve from cache, set it.
323 if ( ! is_array( $cache ) ) {
324 $cache = array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template );
325 // If the parent theme is in another root, we'll want to cache this. Avoids an entire branch of filesystem calls above.
326 if ( isset( $theme_root_template ) )
327 $cache['theme_root_template'] = $theme_root_template;
328 $this->cache_add( 'theme', $cache );
333 * When converting the object to a string, the theme name is returned.
335 * @return string Theme name, ready for display (translated)
337 public function __toString() {
338 return (string) $this->display('Name');
342 * __isset() magic method for properties formerly returned by current_theme_info()
344 * @staticvar array $properties
346 * @param string $offset Property to check if set.
347 * @return bool Whether the given property is set.
349 public function __isset( $offset ) {
350 static $properties = array(
351 'name', 'title', 'version', 'parent_theme', 'template_dir', 'stylesheet_dir', 'template', 'stylesheet',
352 'screenshot', 'description', 'author', 'tags', 'theme_root', 'theme_root_uri',
355 return in_array( $offset, $properties );
359 * __get() magic method for properties formerly returned by current_theme_info()
361 * @param string $offset Property to get.
362 * @return mixed Property value.
364 public function __get( $offset ) {
368 return $this->get('Name');
370 return $this->get('Version');
371 case 'parent_theme' :
372 return $this->parent() ? $this->parent()->get('Name') : '';
373 case 'template_dir' :
374 return $this->get_template_directory();
375 case 'stylesheet_dir' :
376 return $this->get_stylesheet_directory();
378 return $this->get_template();
380 return $this->get_stylesheet();
382 return $this->get_screenshot( 'relative' );
383 // 'author' and 'description' did not previously return translated data.
385 return $this->display('Description');
387 return $this->display('Author');
389 return $this->get( 'Tags' );
391 return $this->get_theme_root();
392 case 'theme_root_uri' :
393 return $this->get_theme_root_uri();
394 // For cases where the array was converted to an object.
396 return $this->offsetGet( $offset );
401 * Method to implement ArrayAccess for keys formerly returned by get_themes()
403 * @param mixed $offset
404 * @param mixed $value
406 public function offsetSet( $offset, $value ) {}
409 * Method to implement ArrayAccess for keys formerly returned by get_themes()
411 * @param mixed $offset
413 public function offsetUnset( $offset ) {}
416 * Method to implement ArrayAccess for keys formerly returned by get_themes()
418 * @staticvar array $keys
420 * @param mixed $offset
423 public function offsetExists( $offset ) {
424 static $keys = array(
425 'Name', 'Version', 'Status', 'Title', 'Author', 'Author Name', 'Author URI', 'Description',
426 'Template', 'Stylesheet', 'Template Files', 'Stylesheet Files', 'Template Dir', 'Stylesheet Dir',
427 'Screenshot', 'Tags', 'Theme Root', 'Theme Root URI', 'Parent Theme',
430 return in_array( $offset, $keys );
434 * Method to implement ArrayAccess for keys formerly returned by get_themes().
436 * Author, Author Name, Author URI, and Description did not previously return
437 * translated data. We are doing so now as it is safe to do. However, as
438 * Name and Title could have been used as the key for get_themes(), both remain
439 * untranslated for back compatibility. This means that ['Name'] is not ideal,
440 * and care should be taken to use $theme->display('Name') to get a properly
443 * @param mixed $offset
446 public function offsetGet( $offset ) {
450 // See note above about using translated data. get() is not ideal.
451 // It is only for backwards compatibility. Use display().
452 return $this->get('Name');
454 return $this->display( 'Author');
456 return $this->display( 'Author', false);
458 return $this->display('AuthorURI');
460 return $this->display( 'Description');
463 return $this->get( $offset );
465 return $this->get_template();
467 return $this->get_stylesheet();
468 case 'Template Files' :
469 return $this->get_files( 'php', 1, true );
470 case 'Stylesheet Files' :
471 return $this->get_files( 'css', 0, false );
472 case 'Template Dir' :
473 return $this->get_template_directory();
474 case 'Stylesheet Dir' :
475 return $this->get_stylesheet_directory();
477 return $this->get_screenshot( 'relative' );
479 return $this->get('Tags');
481 return $this->get_theme_root();
482 case 'Theme Root URI' :
483 return $this->get_theme_root_uri();
484 case 'Parent Theme' :
485 return $this->parent() ? $this->parent()->get('Name') : '';
492 * Returns errors property.
497 * @return WP_Error|false WP_Error if there are errors, or false.
499 public function errors() {
500 return is_wp_error( $this->errors ) ? $this->errors : false;
504 * Whether the theme exists.
506 * A theme with errors exists. A theme with the error of 'theme_not_found',
507 * meaning that the theme's directory was not found, does not exist.
512 * @return bool Whether the theme exists.
514 public function exists() {
515 return ! ( $this->errors() && in_array( 'theme_not_found', $this->errors()->get_error_codes() ) );
519 * Returns reference to the parent theme.
524 * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
526 public function parent() {
527 return isset( $this->parent ) ? $this->parent : false;
531 * Adds theme data to cache.
533 * Cache entries keyed by the theme and the type of data.
538 * @param string $key Type of data to store (theme, screenshot, headers, page_templates)
539 * @param string $data Data to store
540 * @return bool Return value from wp_cache_add()
542 private function cache_add( $key, $data ) {
543 return wp_cache_add( $key . '-' . $this->cache_hash, $data, 'themes', self::$cache_expiration );
547 * Gets theme data from cache.
549 * Cache entries are keyed by the theme and the type of data.
554 * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates)
555 * @return mixed Retrieved data
557 private function cache_get( $key ) {
558 return wp_cache_get( $key . '-' . $this->cache_hash, 'themes' );
562 * Clears the cache for the theme.
567 public function cache_delete() {
568 foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key )
569 wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' );
570 $this->template = $this->textdomain_loaded = $this->theme_root_uri = $this->parent = $this->errors = $this->headers_sanitized = $this->name_translated = null;
571 $this->headers = array();
572 $this->__construct( $this->stylesheet, $this->theme_root );
576 * Get a raw, unformatted theme header.
578 * The header is sanitized, but is not translated, and is not marked up for display.
579 * To get a theme header for display, use the display() method.
581 * Use the get_template() method, not the 'Template' header, for finding the template.
582 * The 'Template' header is only good for what was written in the style.css, while
583 * get_template() takes into account where WordPress actually located the theme and
584 * whether it is actually valid.
589 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
590 * @return string|false String on success, false on failure.
592 public function get( $header ) {
593 if ( ! isset( $this->headers[ $header ] ) )
596 if ( ! isset( $this->headers_sanitized ) ) {
597 $this->headers_sanitized = $this->cache_get( 'headers' );
598 if ( ! is_array( $this->headers_sanitized ) )
599 $this->headers_sanitized = array();
602 if ( isset( $this->headers_sanitized[ $header ] ) )
603 return $this->headers_sanitized[ $header ];
605 // If themes are a persistent group, sanitize everything and cache it. One cache add is better than many cache sets.
606 if ( self::$persistently_cache ) {
607 foreach ( array_keys( $this->headers ) as $_header )
608 $this->headers_sanitized[ $_header ] = $this->sanitize_header( $_header, $this->headers[ $_header ] );
609 $this->cache_add( 'headers', $this->headers_sanitized );
611 $this->headers_sanitized[ $header ] = $this->sanitize_header( $header, $this->headers[ $header ] );
614 return $this->headers_sanitized[ $header ];
618 * Gets a theme header, formatted and translated for display.
623 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
624 * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
625 * @param bool $translate Optional. Whether to translate the header. Defaults to true.
626 * @return string|false Processed header, false on failure.
628 public function display( $header, $markup = true, $translate = true ) {
629 $value = $this->get( $header );
630 if ( false === $value ) {
634 if ( $translate && ( empty( $value ) || ! $this->load_textdomain() ) )
638 $value = $this->translate_header( $header, $value );
641 $value = $this->markup_header( $header, $value, $translate );
647 * Sanitize a theme header.
652 * @staticvar array $header_tags
653 * @staticvar array $header_tags_with_a
655 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
656 * @param string $value Value to sanitize.
659 private function sanitize_header( $header, $value ) {
666 // Fall through otherwise.
668 static $header_tags = array(
669 'abbr' => array( 'title' => true ),
670 'acronym' => array( 'title' => true ),
675 $value = wp_kses( $value, $header_tags );
678 // There shouldn't be anchor tags in Author, but some themes like to be challenging.
680 static $header_tags_with_a = array(
681 'a' => array( 'href' => true, 'title' => true ),
682 'abbr' => array( 'title' => true ),
683 'acronym' => array( 'title' => true ),
688 $value = wp_kses( $value, $header_tags_with_a );
692 $value = esc_url_raw( $value );
695 $value = array_filter( array_map( 'trim', explode( ',', strip_tags( $value ) ) ) );
698 $value = strip_tags( $value );
706 * Mark up a theme header.
711 * @staticvar string $comma
713 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
714 * @param string $value Value to mark up.
715 * @param string $translate Whether the header has been translated.
716 * @return string Value, marked up.
718 private function markup_header( $header, $value, $translate ) {
721 if ( empty( $value ) )
722 $value = $this->get_stylesheet();
725 $value = wptexturize( $value );
728 if ( $this->get('AuthorURI') ) {
729 $value = sprintf( '<a href="%1$s">%2$s</a>', $this->display( 'AuthorURI', true, $translate ), $value );
730 } elseif ( ! $value ) {
731 $value = __( 'Anonymous' );
735 static $comma = null;
736 if ( ! isset( $comma ) ) {
737 /* translators: used between list items, there is a space after the comma */
740 $value = implode( $comma, $value );
744 $value = esc_url( $value );
752 * Translate a theme header.
757 * @staticvar array $tags_list
759 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
760 * @param string $value Value to translate.
761 * @return string Translated value.
763 private function translate_header( $header, $value ) {
766 // Cached for sorting reasons.
767 if ( isset( $this->name_translated ) )
768 return $this->name_translated;
769 $this->name_translated = translate( $value, $this->get('TextDomain' ) );
770 return $this->name_translated;
772 if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) )
776 if ( ! isset( $tags_list ) ) {
777 $tags_list = array();
778 $feature_list = get_theme_feature_list( false ); // No API
779 foreach ( $feature_list as $tags )
783 foreach ( $value as &$tag ) {
784 if ( isset( $tags_list[ $tag ] ) ) {
785 $tag = $tags_list[ $tag ];
786 } elseif ( isset( self::$tag_map[ $tag ] ) ) {
787 $tag = $tags_list[ self::$tag_map[ $tag ] ];
794 $value = translate( $value, $this->get('TextDomain') );
800 * The directory name of the theme's "stylesheet" files, inside the theme root.
802 * In the case of a child theme, this is directory name of the child theme.
803 * Otherwise, get_stylesheet() is the same as get_template().
808 * @return string Stylesheet
810 public function get_stylesheet() {
811 return $this->stylesheet;
815 * The directory name of the theme's "template" files, inside the theme root.
817 * In the case of a child theme, this is the directory name of the parent theme.
818 * Otherwise, the get_template() is the same as get_stylesheet().
823 * @return string Template
825 public function get_template() {
826 return $this->template;
830 * Returns the absolute path to the directory of a theme's "stylesheet" files.
832 * In the case of a child theme, this is the absolute path to the directory
833 * of the child theme's files.
838 * @return string Absolute path of the stylesheet directory.
840 public function get_stylesheet_directory() {
841 if ( $this->errors() && in_array( 'theme_root_missing', $this->errors()->get_error_codes() ) )
844 return $this->theme_root . '/' . $this->stylesheet;
848 * Returns the absolute path to the directory of a theme's "template" files.
850 * In the case of a child theme, this is the absolute path to the directory
851 * of the parent theme's files.
856 * @return string Absolute path of the template directory.
858 public function get_template_directory() {
859 if ( $this->parent() )
860 $theme_root = $this->parent()->theme_root;
862 $theme_root = $this->theme_root;
864 return $theme_root . '/' . $this->template;
868 * Returns the URL to the directory of a theme's "stylesheet" files.
870 * In the case of a child theme, this is the URL to the directory of the
871 * child theme's files.
876 * @return string URL to the stylesheet directory.
878 public function get_stylesheet_directory_uri() {
879 return $this->get_theme_root_uri() . '/' . str_replace( '%2F', '/', rawurlencode( $this->stylesheet ) );
883 * Returns the URL to the directory of a theme's "template" files.
885 * In the case of a child theme, this is the URL to the directory of the
886 * parent theme's files.
891 * @return string URL to the template directory.
893 public function get_template_directory_uri() {
894 if ( $this->parent() )
895 $theme_root_uri = $this->parent()->get_theme_root_uri();
897 $theme_root_uri = $this->get_theme_root_uri();
899 return $theme_root_uri . '/' . str_replace( '%2F', '/', rawurlencode( $this->template ) );
903 * The absolute path to the directory of the theme root.
905 * This is typically the absolute path to wp-content/themes.
910 * @return string Theme root.
912 public function get_theme_root() {
913 return $this->theme_root;
917 * Returns the URL to the directory of the theme root.
919 * This is typically the absolute URL to wp-content/themes. This forms the basis
920 * for all other URLs returned by WP_Theme, so we pass it to the public function
921 * get_theme_root_uri() and allow it to run the theme_root_uri filter.
926 * @return string Theme root URI.
928 public function get_theme_root_uri() {
929 if ( ! isset( $this->theme_root_uri ) )
930 $this->theme_root_uri = get_theme_root_uri( $this->stylesheet, $this->theme_root );
931 return $this->theme_root_uri;
935 * Returns the main screenshot file for the theme.
937 * The main screenshot is called screenshot.png. gif and jpg extensions are also allowed.
939 * Screenshots for a theme must be in the stylesheet directory. (In the case of child
940 * themes, parent theme screenshots are not inherited.)
945 * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
946 * @return string|false Screenshot file. False if the theme does not have a screenshot.
948 public function get_screenshot( $uri = 'uri' ) {
949 $screenshot = $this->cache_get( 'screenshot' );
951 if ( 'relative' == $uri )
953 return $this->get_stylesheet_directory_uri() . '/' . $screenshot;
954 } elseif ( 0 === $screenshot ) {
958 foreach ( array( 'png', 'gif', 'jpg', 'jpeg' ) as $ext ) {
959 if ( file_exists( $this->get_stylesheet_directory() . "/screenshot.$ext" ) ) {
960 $this->cache_add( 'screenshot', 'screenshot.' . $ext );
961 if ( 'relative' == $uri )
962 return 'screenshot.' . $ext;
963 return $this->get_stylesheet_directory_uri() . '/' . 'screenshot.' . $ext;
967 $this->cache_add( 'screenshot', 0 );
972 * Return files in the theme's directory.
977 * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
978 * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
979 * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
980 * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
981 * being absolute paths.
983 public function get_files( $type = null, $depth = 0, $search_parent = false ) {
984 $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
986 if ( $search_parent && $this->parent() )
987 $files += (array) self::scandir( $this->get_template_directory(), $type, $depth );
993 * Returns the theme's page templates.
998 * @param WP_Post|null $post Optional. The post being edited, provided for context.
999 * @return array Array of page templates, keyed by filename, with the value of the translated header name.
1001 public function get_page_templates( $post = null ) {
1002 // If you screw up your current theme and we invalidate your parent, most things still work. Let it slide.
1003 if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) )
1006 $page_templates = $this->cache_get( 'page_templates' );
1008 if ( ! is_array( $page_templates ) ) {
1009 $page_templates = array();
1011 $files = (array) $this->get_files( 'php', 1 );
1013 foreach ( $files as $file => $full_path ) {
1014 if ( ! preg_match( '|Template Name:(.*)$|mi', file_get_contents( $full_path ), $header ) )
1016 $page_templates[ $file ] = _cleanup_header_comment( $header[1] );
1019 $this->cache_add( 'page_templates', $page_templates );
1022 if ( $this->load_textdomain() ) {
1023 foreach ( $page_templates as &$page_template ) {
1024 $page_template = $this->translate_header( 'Template Name', $page_template );
1028 if ( $this->parent() )
1029 $page_templates += $this->parent()->get_page_templates( $post );
1032 * Filter list of page templates for a theme.
1035 * @since 4.4.0 Converted to allow complete control over the `$page_templates` array.
1037 * @param array $page_templates Array of page templates. Keys are filenames,
1038 * values are translated names.
1039 * @param WP_Theme $this The theme object.
1040 * @param WP_Post|null $post The post being edited, provided for context, or null.
1042 return (array) apply_filters( 'theme_page_templates', $page_templates, $this, $post );
1046 * Scans a directory for files of a certain extension.
1053 * @param string $path Absolute path to search.
1054 * @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension,
1055 * or null for all extensions. Default null.
1056 * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or
1057 * -1 (infinite depth). Default 0.
1058 * @param string $relative_path Optional. The basename of the absolute path. Used to control the
1059 * returned path for the found files, particularly when this function
1060 * recurses to lower depths. Default empty.
1061 * @return array|false Array of files, keyed by the path to the file relative to the `$path` directory prepended
1062 * with `$relative_path`, with the values being absolute paths. False otherwise.
1064 private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
1065 if ( ! is_dir( $path ) )
1068 if ( $extensions ) {
1069 $extensions = (array) $extensions;
1070 $_extensions = implode( '|', $extensions );
1073 $relative_path = trailingslashit( $relative_path );
1074 if ( '/' == $relative_path )
1075 $relative_path = '';
1077 $results = scandir( $path );
1080 foreach ( $results as $result ) {
1081 if ( '.' == $result[0] )
1083 if ( is_dir( $path . '/' . $result ) ) {
1084 if ( ! $depth || 'CVS' == $result )
1086 $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1 , $relative_path . $result );
1087 $files = array_merge_recursive( $files, $found );
1088 } elseif ( ! $extensions || preg_match( '~\.(' . $_extensions . ')$~', $result ) ) {
1089 $files[ $relative_path . $result ] = $path . '/' . $result;
1097 * Loads the theme's textdomain.
1099 * Translation files are not inherited from the parent theme. Todo: if this fails for the
1100 * child theme, it should probably try to load the parent theme's translations.
1105 * @return bool True if the textdomain was successfully loaded or has already been loaded.
1106 * False if no textdomain was specified in the file headers, or if the domain could not be loaded.
1108 public function load_textdomain() {
1109 if ( isset( $this->textdomain_loaded ) )
1110 return $this->textdomain_loaded;
1112 $textdomain = $this->get('TextDomain');
1113 if ( ! $textdomain ) {
1114 $this->textdomain_loaded = false;
1118 if ( is_textdomain_loaded( $textdomain ) ) {
1119 $this->textdomain_loaded = true;
1123 $path = $this->get_stylesheet_directory();
1124 if ( $domainpath = $this->get('DomainPath') )
1125 $path .= $domainpath;
1127 $path .= '/languages';
1129 $this->textdomain_loaded = load_theme_textdomain( $textdomain, $path );
1130 return $this->textdomain_loaded;
1134 * Whether the theme is allowed (multisite only).
1139 * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site'
1140 * settings, or 'both'. Defaults to 'both'.
1141 * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current site.
1142 * @return bool Whether the theme is allowed for the network. Returns true in single-site.
1144 public function is_allowed( $check = 'both', $blog_id = null ) {
1145 if ( ! is_multisite() )
1148 if ( 'both' == $check || 'network' == $check ) {
1149 $allowed = self::get_allowed_on_network();
1150 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) )
1154 if ( 'both' == $check || 'site' == $check ) {
1155 $allowed = self::get_allowed_on_site( $blog_id );
1156 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) )
1164 * Determines the latest WordPress default theme that is installed.
1166 * This hits the filesystem.
1168 * @return WP_Theme|false Object, or false if no theme is installed, which would be bad.
1170 public static function get_core_default_theme() {
1171 foreach ( array_reverse( self::$default_themes ) as $slug => $name ) {
1172 $theme = wp_get_theme( $slug );
1173 if ( $theme->exists() ) {
1181 * Returns array of stylesheet names of themes allowed on the site or network.
1188 * @param int $blog_id Optional. ID of the site. Defaults to the current site.
1189 * @return array Array of stylesheet names.
1191 public static function get_allowed( $blog_id = null ) {
1193 * Filter the array of themes allowed on the network.
1195 * Site is provided as context so that a list of network allowed themes can
1196 * be filtered further.
1200 * @param array $allowed_themes An array of theme stylesheet names.
1201 * @param int $blog_id ID of the site.
1203 $network = (array) apply_filters( 'network_allowed_themes', self::get_allowed_on_network(), $blog_id );
1204 return $network + self::get_allowed_on_site( $blog_id );
1208 * Returns array of stylesheet names of themes allowed on the network.
1215 * @staticvar array $allowed_themes
1217 * @return array Array of stylesheet names.
1219 public static function get_allowed_on_network() {
1220 static $allowed_themes;
1221 if ( ! isset( $allowed_themes ) ) {
1222 $allowed_themes = (array) get_site_option( 'allowedthemes' );
1226 * Filter the array of themes allowed on the network.
1230 * @param array $allowed_themes An array of theme stylesheet names.
1232 $allowed_themes = apply_filters( 'allowed_themes', $allowed_themes );
1234 return $allowed_themes;
1238 * Returns array of stylesheet names of themes allowed on the site.
1245 * @staticvar array $allowed_themes
1247 * @param int $blog_id Optional. ID of the site. Defaults to the current site.
1248 * @return array Array of stylesheet names.
1250 public static function get_allowed_on_site( $blog_id = null ) {
1251 static $allowed_themes = array();
1253 if ( ! $blog_id || ! is_multisite() )
1254 $blog_id = get_current_blog_id();
1256 if ( isset( $allowed_themes[ $blog_id ] ) ) {
1258 * Filter the array of themes allowed on the site.
1262 * @param array $allowed_themes An array of theme stylesheet names.
1263 * @param int $blog_id ID of the site. Defaults to current site.
1265 return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );
1268 $current = $blog_id == get_current_blog_id();
1271 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
1273 switch_to_blog( $blog_id );
1274 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
1275 restore_current_blog();
1278 // This is all super old MU back compat joy.
1279 // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name.
1280 if ( false === $allowed_themes[ $blog_id ] ) {
1282 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
1284 switch_to_blog( $blog_id );
1285 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
1286 restore_current_blog();
1289 if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) {
1290 $allowed_themes[ $blog_id ] = array();
1292 $converted = array();
1293 $themes = wp_get_themes();
1294 foreach ( $themes as $stylesheet => $theme_data ) {
1295 if ( isset( $allowed_themes[ $blog_id ][ $theme_data->get('Name') ] ) )
1296 $converted[ $stylesheet ] = true;
1298 $allowed_themes[ $blog_id ] = $converted;
1300 // Set the option so we never have to go through this pain again.
1301 if ( is_admin() && $allowed_themes[ $blog_id ] ) {
1303 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
1304 delete_option( 'allowed_themes' );
1306 switch_to_blog( $blog_id );
1307 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
1308 delete_option( 'allowed_themes' );
1309 restore_current_blog();
1314 /** This filter is documented in wp-includes/class-wp-theme.php */
1315 return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );
1319 * Sorts themes by name.
1326 * @param array $themes Array of themes to sort, passed by reference.
1328 public static function sort_by_name( &$themes ) {
1329 if ( 0 === strpos( get_locale(), 'en_' ) ) {
1330 uasort( $themes, array( 'WP_Theme', '_name_sort' ) );
1332 uasort( $themes, array( 'WP_Theme', '_name_sort_i18n' ) );
1337 * Callback function for usort() to naturally sort themes by name.
1339 * Accesses the Name header directly from the class for maximum speed.
1340 * Would choke on HTML but we don't care enough to slow it down with strip_tags().
1347 * @param string $a First name.
1348 * @param string $b Second name.
1349 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
1350 * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
1352 private static function _name_sort( $a, $b ) {
1353 return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] );
1357 * Name sort (with translation).
1364 * @param string $a First name.
1365 * @param string $b Second name.
1366 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
1367 * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
1369 private static function _name_sort_i18n( $a, $b ) {
1370 // Don't mark up; Do translate.
1371 return strnatcasecmp( $a->display( 'Name', false, true ), $b->display( 'Name', false, true ) );