9 final class WP_Theme implements ArrayAccess {
12 * Headers for style.css files.
18 private static $file_headers = array(
19 'Name' => 'Theme Name',
20 'ThemeURI' => 'Theme URI',
21 'Description' => 'Description',
23 'AuthorURI' => 'Author URI',
24 'Version' => 'Version',
25 'Template' => 'Template',
28 'TextDomain' => 'Text Domain',
29 'DomainPath' => 'Domain Path',
39 private static $default_themes = array(
40 'classic' => 'WordPress Classic',
41 'default' => 'WordPress Default',
42 'twentyten' => 'Twenty Ten',
43 'twentyeleven' => 'Twenty Eleven',
44 'twentytwelve' => 'Twenty Twelve',
45 'twentythirteen' => 'Twenty Thirteen',
46 'twentyfourteen' => 'Twenty Fourteen',
47 'twentyfifteen' => 'Twenty Fifteen',
57 private static $tag_map = array(
58 'fixed-width' => 'fixed-layout',
59 'flexible-width' => 'fluid-layout',
63 * Absolute path to the theme root, usually wp-content/themes
71 * Header data from the theme's style.css file.
76 private $headers = array();
79 * Header data from the theme's style.css file after being sanitized.
84 private $headers_sanitized;
87 * Header name from the theme's style.css after being translated.
89 * Cached due to sorting functions running over the translated name.
94 private $name_translated;
97 * Errors encountered when initializing the theme.
105 * The directory name of the theme's files, inside the theme root.
107 * In the case of a child theme, this is directory name of the child theme.
108 * Otherwise, 'stylesheet' is the same as 'template'.
116 * The directory name of the theme's files, inside the theme root.
118 * In the case of a child theme, this is the directory name of the parent theme.
119 * Otherwise, 'template' is the same as 'stylesheet'.
127 * A reference to the parent theme, in the case of a child theme.
135 * URL to the theme root, usually an absolute URL to wp-content/themes
140 private $theme_root_uri;
143 * Flag for whether the theme's textdomain is loaded.
148 private $textdomain_loaded;
151 * Stores an md5 hash of the theme root, to function as the cache key.
159 * Flag for whether the themes cache bucket should be persistently cached.
161 * Default is false. Can be set with the wp_cache_themes_persistently filter.
167 private static $persistently_cache;
170 * Expiration time for the themes cache bucket.
172 * By default the bucket is not cached, so this value is useless.
178 private static $cache_expiration = 1800;
181 * Constructor for WP_Theme.
183 * @global array $wp_theme_directories
185 * @param string $theme_dir Directory of the theme within the theme_root.
186 * @param string $theme_root Theme root.
187 * @param WP_Error|void $_child If this theme is a parent theme, the child may be passed for validation purposes.
189 public function __construct( $theme_dir, $theme_root, $_child = null ) {
190 global $wp_theme_directories;
192 // Initialize caching on first run.
193 if ( ! isset( self::$persistently_cache ) ) {
194 /** This action is documented in wp-includes/theme.php */
195 self::$persistently_cache = apply_filters( 'wp_cache_themes_persistently', false, 'WP_Theme' );
196 if ( self::$persistently_cache ) {
197 wp_cache_add_global_groups( 'themes' );
198 if ( is_int( self::$persistently_cache ) )
199 self::$cache_expiration = self::$persistently_cache;
201 wp_cache_add_non_persistent_groups( 'themes' );
205 $this->theme_root = $theme_root;
206 $this->stylesheet = $theme_dir;
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 ) && in_array( dirname( $theme_root ), (array) $wp_theme_directories ) ) {
210 $this->stylesheet = basename( $this->theme_root ) . '/' . $this->stylesheet;
211 $this->theme_root = dirname( $theme_root );
214 $this->cache_hash = md5( $this->theme_root . '/' . $this->stylesheet );
215 $theme_file = $this->stylesheet . '/style.css';
217 $cache = $this->cache_get( 'theme' );
219 if ( is_array( $cache ) ) {
220 foreach ( array( 'errors', 'headers', 'template' ) as $key ) {
221 if ( isset( $cache[ $key ] ) )
222 $this->$key = $cache[ $key ];
226 if ( isset( $cache['theme_root_template'] ) )
227 $theme_root_template = $cache['theme_root_template'];
228 } elseif ( ! file_exists( $this->theme_root . '/' . $theme_file ) ) {
229 $this->headers['Name'] = $this->stylesheet;
230 if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet ) )
231 $this->errors = new WP_Error( 'theme_not_found', sprintf( __( 'The theme directory "%s" does not exist.' ), $this->stylesheet ) );
233 $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) );
234 $this->template = $this->stylesheet;
235 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
236 if ( ! file_exists( $this->theme_root ) ) // Don't cache this one.
237 $this->errors->add( 'theme_root_missing', __( 'ERROR: The themes directory is either empty or doesn’t exist. Please check your installation.' ) );
239 } elseif ( ! is_readable( $this->theme_root . '/' . $theme_file ) ) {
240 $this->headers['Name'] = $this->stylesheet;
241 $this->errors = new WP_Error( 'theme_stylesheet_not_readable', __( 'Stylesheet is not readable.' ) );
242 $this->template = $this->stylesheet;
243 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
246 $this->headers = get_file_data( $this->theme_root . '/' . $theme_file, self::$file_headers, 'theme' );
247 // Default themes always trump their pretenders.
248 // Properly identify default themes that are inside a directory within wp-content/themes.
249 if ( $default_theme_slug = array_search( $this->headers['Name'], self::$default_themes ) ) {
250 if ( basename( $this->stylesheet ) != $default_theme_slug )
251 $this->headers['Name'] .= '/' . $this->stylesheet;
255 // (If template is set from cache [and there are no errors], we know it's good.)
256 if ( ! $this->template && ! ( $this->template = $this->headers['Template'] ) ) {
257 $this->template = $this->stylesheet;
258 if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet . '/index.php' ) ) {
259 $this->errors = new WP_Error( 'theme_no_index', __( 'Template is missing.' ) );
260 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
265 // If we got our data from cache, we can assume that 'template' is pointing to the right place.
266 if ( ! is_array( $cache ) && $this->template != $this->stylesheet && ! file_exists( $this->theme_root . '/' . $this->template . '/index.php' ) ) {
267 // If we're in a directory of themes inside /themes, look for the parent nearby.
268 // wp-content/themes/directory-of-themes/*
269 $parent_dir = dirname( $this->stylesheet );
270 if ( '.' != $parent_dir && file_exists( $this->theme_root . '/' . $parent_dir . '/' . $this->template . '/index.php' ) ) {
271 $this->template = $parent_dir . '/' . $this->template;
272 } elseif ( ( $directories = search_theme_directories() ) && isset( $directories[ $this->template ] ) ) {
273 // Look for the template in the search_theme_directories() results, in case it is in another theme root.
274 // We don't look into directories of themes, just the theme root.
275 $theme_root_template = $directories[ $this->template ]['theme_root'];
277 // Parent theme is missing.
278 $this->errors = new WP_Error( 'theme_no_parent', sprintf( __( 'The parent theme is missing. Please install the "%s" parent theme.' ), $this->template ) );
279 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
280 $this->parent = new WP_Theme( $this->template, $this->theme_root, $this );
285 // Set the parent, if we're a child theme.
286 if ( $this->template != $this->stylesheet ) {
287 // If we are a parent, then there is a problem. Only two generations allowed! Cancel things out.
288 if ( $_child instanceof WP_Theme && $_child->template == $this->stylesheet ) {
289 $_child->parent = null;
290 $_child->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), $_child->template ) );
291 $_child->cache_add( 'theme', array( 'headers' => $_child->headers, 'errors' => $_child->errors, 'stylesheet' => $_child->stylesheet, 'template' => $_child->template ) );
292 // The two themes actually reference each other with the Template header.
293 if ( $_child->stylesheet == $this->template ) {
294 $this->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), $this->template ) );
295 $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
299 // Set the parent. Pass the current instance so we can do the crazy checks above and assess errors.
300 $this->parent = new WP_Theme( $this->template, isset( $theme_root_template ) ? $theme_root_template : $this->theme_root, $this );
303 // We're good. If we didn't retrieve from cache, set it.
304 if ( ! is_array( $cache ) ) {
305 $cache = array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template );
306 // If the parent theme is in another root, we'll want to cache this. Avoids an entire branch of filesystem calls above.
307 if ( isset( $theme_root_template ) )
308 $cache['theme_root_template'] = $theme_root_template;
309 $this->cache_add( 'theme', $cache );
314 * When converting the object to a string, the theme name is returned.
316 * @return string Theme name, ready for display (translated)
318 public function __toString() {
319 return (string) $this->display('Name');
323 * __isset() magic method for properties formerly returned by current_theme_info()
325 * @staticvar array $properties
329 public function __isset( $offset ) {
330 static $properties = array(
331 'name', 'title', 'version', 'parent_theme', 'template_dir', 'stylesheet_dir', 'template', 'stylesheet',
332 'screenshot', 'description', 'author', 'tags', 'theme_root', 'theme_root_uri',
335 return in_array( $offset, $properties );
339 * __get() magic method for properties formerly returned by current_theme_info()
343 public function __get( $offset ) {
347 return $this->get('Name');
349 return $this->get('Version');
350 case 'parent_theme' :
351 return $this->parent() ? $this->parent()->get('Name') : '';
352 case 'template_dir' :
353 return $this->get_template_directory();
354 case 'stylesheet_dir' :
355 return $this->get_stylesheet_directory();
357 return $this->get_template();
359 return $this->get_stylesheet();
361 return $this->get_screenshot( 'relative' );
362 // 'author' and 'description' did not previously return translated data.
364 return $this->display('Description');
366 return $this->display('Author');
368 return $this->get( 'Tags' );
370 return $this->get_theme_root();
371 case 'theme_root_uri' :
372 return $this->get_theme_root_uri();
373 // For cases where the array was converted to an object.
375 return $this->offsetGet( $offset );
380 * Method to implement ArrayAccess for keys formerly returned by get_themes()
382 * @param mixed $offset
383 * @param mixed $value
385 public function offsetSet( $offset, $value ) {}
388 * Method to implement ArrayAccess for keys formerly returned by get_themes()
390 * @param mixed $offset
392 public function offsetUnset( $offset ) {}
395 * Method to implement ArrayAccess for keys formerly returned by get_themes()
397 * @staticvar array $keys
399 * @param mixed $offset
402 public function offsetExists( $offset ) {
403 static $keys = array(
404 'Name', 'Version', 'Status', 'Title', 'Author', 'Author Name', 'Author URI', 'Description',
405 'Template', 'Stylesheet', 'Template Files', 'Stylesheet Files', 'Template Dir', 'Stylesheet Dir',
406 'Screenshot', 'Tags', 'Theme Root', 'Theme Root URI', 'Parent Theme',
409 return in_array( $offset, $keys );
413 * Method to implement ArrayAccess for keys formerly returned by get_themes().
415 * Author, Author Name, Author URI, and Description did not previously return
416 * translated data. We are doing so now as it is safe to do. However, as
417 * Name and Title could have been used as the key for get_themes(), both remain
418 * untranslated for back compatibility. This means that ['Name'] is not ideal,
419 * and care should be taken to use $theme->display('Name') to get a properly
422 * @param mixed $offset
425 public function offsetGet( $offset ) {
429 // See note above about using translated data. get() is not ideal.
430 // It is only for backwards compatibility. Use display().
431 return $this->get('Name');
433 return $this->display( 'Author');
435 return $this->display( 'Author', false);
437 return $this->display('AuthorURI');
439 return $this->display( 'Description');
442 return $this->get( $offset );
444 return $this->get_template();
446 return $this->get_stylesheet();
447 case 'Template Files' :
448 return $this->get_files( 'php', 1, true );
449 case 'Stylesheet Files' :
450 return $this->get_files( 'css', 0, false );
451 case 'Template Dir' :
452 return $this->get_template_directory();
453 case 'Stylesheet Dir' :
454 return $this->get_stylesheet_directory();
456 return $this->get_screenshot( 'relative' );
458 return $this->get('Tags');
460 return $this->get_theme_root();
461 case 'Theme Root URI' :
462 return $this->get_theme_root_uri();
463 case 'Parent Theme' :
464 return $this->parent() ? $this->parent()->get('Name') : '';
471 * Returns errors property.
476 * @return WP_Error|false WP_Error if there are errors, or false.
478 public function errors() {
479 return is_wp_error( $this->errors ) ? $this->errors : false;
483 * Whether the theme exists.
485 * A theme with errors exists. A theme with the error of 'theme_not_found',
486 * meaning that the theme's directory was not found, does not exist.
491 * @return bool Whether the theme exists.
493 public function exists() {
494 return ! ( $this->errors() && in_array( 'theme_not_found', $this->errors()->get_error_codes() ) );
498 * Returns reference to the parent theme.
503 * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
505 public function parent() {
506 return isset( $this->parent ) ? $this->parent : false;
510 * Adds theme data to cache.
512 * Cache entries keyed by the theme and the type of data.
517 * @param string $key Type of data to store (theme, screenshot, headers, page_templates)
518 * @param string $data Data to store
519 * @return bool Return value from wp_cache_add()
521 private function cache_add( $key, $data ) {
522 return wp_cache_add( $key . '-' . $this->cache_hash, $data, 'themes', self::$cache_expiration );
526 * Gets theme data from cache.
528 * Cache entries are keyed by the theme and the type of data.
533 * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates)
534 * @return mixed Retrieved data
536 private function cache_get( $key ) {
537 return wp_cache_get( $key . '-' . $this->cache_hash, 'themes' );
541 * Clears the cache for the theme.
546 public function cache_delete() {
547 foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key )
548 wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' );
549 $this->template = $this->textdomain_loaded = $this->theme_root_uri = $this->parent = $this->errors = $this->headers_sanitized = $this->name_translated = null;
550 $this->headers = array();
551 $this->__construct( $this->stylesheet, $this->theme_root );
555 * Get a raw, unformatted theme header.
557 * The header is sanitized, but is not translated, and is not marked up for display.
558 * To get a theme header for display, use the display() method.
560 * Use the get_template() method, not the 'Template' header, for finding the template.
561 * The 'Template' header is only good for what was written in the style.css, while
562 * get_template() takes into account where WordPress actually located the theme and
563 * whether it is actually valid.
568 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
569 * @return string|false String on success, false on failure.
571 public function get( $header ) {
572 if ( ! isset( $this->headers[ $header ] ) )
575 if ( ! isset( $this->headers_sanitized ) ) {
576 $this->headers_sanitized = $this->cache_get( 'headers' );
577 if ( ! is_array( $this->headers_sanitized ) )
578 $this->headers_sanitized = array();
581 if ( isset( $this->headers_sanitized[ $header ] ) )
582 return $this->headers_sanitized[ $header ];
584 // If themes are a persistent group, sanitize everything and cache it. One cache add is better than many cache sets.
585 if ( self::$persistently_cache ) {
586 foreach ( array_keys( $this->headers ) as $_header )
587 $this->headers_sanitized[ $_header ] = $this->sanitize_header( $_header, $this->headers[ $_header ] );
588 $this->cache_add( 'headers', $this->headers_sanitized );
590 $this->headers_sanitized[ $header ] = $this->sanitize_header( $header, $this->headers[ $header ] );
593 return $this->headers_sanitized[ $header ];
597 * Gets a theme header, formatted and translated for display.
602 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
603 * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
604 * @param bool $translate Optional. Whether to translate the header. Defaults to true.
605 * @return string|false Processed header, false on failure.
607 public function display( $header, $markup = true, $translate = true ) {
608 $value = $this->get( $header );
609 if ( false === $value ) {
613 if ( $translate && ( empty( $value ) || ! $this->load_textdomain() ) )
617 $value = $this->translate_header( $header, $value );
620 $value = $this->markup_header( $header, $value, $translate );
626 * Sanitize a theme header.
631 * @staticvar array $header_tags
632 * @staticvar array $header_tags_with_a
634 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
635 * @param string $value Value to sanitize.
638 private function sanitize_header( $header, $value ) {
645 // Fall through otherwise.
647 static $header_tags = array(
648 'abbr' => array( 'title' => true ),
649 'acronym' => array( 'title' => true ),
654 $value = wp_kses( $value, $header_tags );
657 // There shouldn't be anchor tags in Author, but some themes like to be challenging.
659 static $header_tags_with_a = array(
660 'a' => array( 'href' => true, 'title' => true ),
661 'abbr' => array( 'title' => true ),
662 'acronym' => array( 'title' => true ),
667 $value = wp_kses( $value, $header_tags_with_a );
671 $value = esc_url_raw( $value );
674 $value = array_filter( array_map( 'trim', explode( ',', strip_tags( $value ) ) ) );
677 $value = strip_tags( $value );
685 * Mark up a theme header.
690 * @staticvar string $comma
692 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
693 * @param string $value Value to mark up.
694 * @param string $translate Whether the header has been translated.
695 * @return string Value, marked up.
697 private function markup_header( $header, $value, $translate ) {
700 if ( empty( $value ) )
701 $value = $this->get_stylesheet();
704 $value = wptexturize( $value );
707 if ( $this->get('AuthorURI') ) {
708 $value = sprintf( '<a href="%1$s">%2$s</a>', $this->display( 'AuthorURI', true, $translate ), $value );
709 } elseif ( ! $value ) {
710 $value = __( 'Anonymous' );
714 static $comma = null;
715 if ( ! isset( $comma ) ) {
716 /* translators: used between list items, there is a space after the comma */
719 $value = implode( $comma, $value );
723 $value = esc_url( $value );
731 * Translate a theme header.
736 * @staticvar array $tags_list
738 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
739 * @param string $value Value to translate.
740 * @return string Translated value.
742 private function translate_header( $header, $value ) {
745 // Cached for sorting reasons.
746 if ( isset( $this->name_translated ) )
747 return $this->name_translated;
748 $this->name_translated = translate( $value, $this->get('TextDomain' ) );
749 return $this->name_translated;
751 if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) )
755 if ( ! isset( $tags_list ) ) {
756 $tags_list = array();
757 $feature_list = get_theme_feature_list( false ); // No API
758 foreach ( $feature_list as $tags )
762 foreach ( $value as &$tag ) {
763 if ( isset( $tags_list[ $tag ] ) ) {
764 $tag = $tags_list[ $tag ];
765 } elseif ( isset( self::$tag_map[ $tag ] ) ) {
766 $tag = $tags_list[ self::$tag_map[ $tag ] ];
773 $value = translate( $value, $this->get('TextDomain') );
779 * The directory name of the theme's "stylesheet" files, inside the theme root.
781 * In the case of a child theme, this is directory name of the child theme.
782 * Otherwise, get_stylesheet() is the same as get_template().
787 * @return string Stylesheet
789 public function get_stylesheet() {
790 return $this->stylesheet;
794 * The directory name of the theme's "template" files, inside the theme root.
796 * In the case of a child theme, this is the directory name of the parent theme.
797 * Otherwise, the get_template() is the same as get_stylesheet().
802 * @return string Template
804 public function get_template() {
805 return $this->template;
809 * Returns the absolute path to the directory of a theme's "stylesheet" files.
811 * In the case of a child theme, this is the absolute path to the directory
812 * of the child theme's files.
817 * @return string Absolute path of the stylesheet directory.
819 public function get_stylesheet_directory() {
820 if ( $this->errors() && in_array( 'theme_root_missing', $this->errors()->get_error_codes() ) )
823 return $this->theme_root . '/' . $this->stylesheet;
827 * Returns the absolute path to the directory of a theme's "template" files.
829 * In the case of a child theme, this is the absolute path to the directory
830 * of the parent theme's files.
835 * @return string Absolute path of the template directory.
837 public function get_template_directory() {
838 if ( $this->parent() )
839 $theme_root = $this->parent()->theme_root;
841 $theme_root = $this->theme_root;
843 return $theme_root . '/' . $this->template;
847 * Returns the URL to the directory of a theme's "stylesheet" files.
849 * In the case of a child theme, this is the URL to the directory of the
850 * child theme's files.
855 * @return string URL to the stylesheet directory.
857 public function get_stylesheet_directory_uri() {
858 return $this->get_theme_root_uri() . '/' . str_replace( '%2F', '/', rawurlencode( $this->stylesheet ) );
862 * Returns the URL to the directory of a theme's "template" files.
864 * In the case of a child theme, this is the URL to the directory of the
865 * parent theme's files.
870 * @return string URL to the template directory.
872 public function get_template_directory_uri() {
873 if ( $this->parent() )
874 $theme_root_uri = $this->parent()->get_theme_root_uri();
876 $theme_root_uri = $this->get_theme_root_uri();
878 return $theme_root_uri . '/' . str_replace( '%2F', '/', rawurlencode( $this->template ) );
882 * The absolute path to the directory of the theme root.
884 * This is typically the absolute path to wp-content/themes.
889 * @return string Theme root.
891 public function get_theme_root() {
892 return $this->theme_root;
896 * Returns the URL to the directory of the theme root.
898 * This is typically the absolute URL to wp-content/themes. This forms the basis
899 * for all other URLs returned by WP_Theme, so we pass it to the public function
900 * get_theme_root_uri() and allow it to run the theme_root_uri filter.
905 * @return string Theme root URI.
907 public function get_theme_root_uri() {
908 if ( ! isset( $this->theme_root_uri ) )
909 $this->theme_root_uri = get_theme_root_uri( $this->stylesheet, $this->theme_root );
910 return $this->theme_root_uri;
914 * Returns the main screenshot file for the theme.
916 * The main screenshot is called screenshot.png. gif and jpg extensions are also allowed.
918 * Screenshots for a theme must be in the stylesheet directory. (In the case of child
919 * themes, parent theme screenshots are not inherited.)
924 * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
925 * @return string|false Screenshot file. False if the theme does not have a screenshot.
927 public function get_screenshot( $uri = 'uri' ) {
928 $screenshot = $this->cache_get( 'screenshot' );
930 if ( 'relative' == $uri )
932 return $this->get_stylesheet_directory_uri() . '/' . $screenshot;
933 } elseif ( 0 === $screenshot ) {
937 foreach ( array( 'png', 'gif', 'jpg', 'jpeg' ) as $ext ) {
938 if ( file_exists( $this->get_stylesheet_directory() . "/screenshot.$ext" ) ) {
939 $this->cache_add( 'screenshot', 'screenshot.' . $ext );
940 if ( 'relative' == $uri )
941 return 'screenshot.' . $ext;
942 return $this->get_stylesheet_directory_uri() . '/' . 'screenshot.' . $ext;
946 $this->cache_add( 'screenshot', 0 );
951 * Return files in the theme's directory.
956 * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
957 * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
958 * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
959 * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
960 * being absolute paths.
962 public function get_files( $type = null, $depth = 0, $search_parent = false ) {
963 $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
965 if ( $search_parent && $this->parent() )
966 $files += (array) self::scandir( $this->get_template_directory(), $type, $depth );
972 * Returns the theme's page templates.
977 * @param WP_Post|null $post Optional. The post being edited, provided for context.
978 * @return array Array of page templates, keyed by filename, with the value of the translated header name.
980 public function get_page_templates( $post = null ) {
981 // If you screw up your current theme and we invalidate your parent, most things still work. Let it slide.
982 if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) )
985 $page_templates = $this->cache_get( 'page_templates' );
987 if ( ! is_array( $page_templates ) ) {
988 $page_templates = array();
990 $files = (array) $this->get_files( 'php', 1 );
992 foreach ( $files as $file => $full_path ) {
993 if ( ! preg_match( '|Template Name:(.*)$|mi', file_get_contents( $full_path ), $header ) )
995 $page_templates[ $file ] = _cleanup_header_comment( $header[1] );
998 $this->cache_add( 'page_templates', $page_templates );
1001 if ( $this->load_textdomain() ) {
1002 foreach ( $page_templates as &$page_template ) {
1003 $page_template = $this->translate_header( 'Template Name', $page_template );
1007 if ( $this->parent() )
1008 $page_templates += $this->parent()->get_page_templates( $post );
1011 * Filter list of page templates for a theme.
1013 * This filter does not currently allow for page templates to be added.
1017 * @param array $page_templates Array of page templates. Keys are filenames,
1018 * values are translated names.
1019 * @param WP_Theme $this The theme object.
1020 * @param WP_Post|null $post The post being edited, provided for context, or null.
1022 $return = apply_filters( 'theme_page_templates', $page_templates, $this, $post );
1024 return array_intersect_assoc( $return, $page_templates );
1028 * Scans a directory for files of a certain extension.
1035 * @param string $path Absolute path to search.
1036 * @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension,
1037 * or null for all extensions. Default null.
1038 * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or
1039 * -1 (infinite depth). Default 0.
1040 * @param string $relative_path Optional. The basename of the absolute path. Used to control the
1041 * returned path for the found files, particularly when this function
1042 * recurses to lower depths. Default empty.
1043 * @return array|false Array of files, keyed by the path to the file relative to the `$path` directory prepended
1044 * with `$relative_path`, with the values being absolute paths. False otherwise.
1046 private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
1047 if ( ! is_dir( $path ) )
1050 if ( $extensions ) {
1051 $extensions = (array) $extensions;
1052 $_extensions = implode( '|', $extensions );
1055 $relative_path = trailingslashit( $relative_path );
1056 if ( '/' == $relative_path )
1057 $relative_path = '';
1059 $results = scandir( $path );
1062 foreach ( $results as $result ) {
1063 if ( '.' == $result[0] )
1065 if ( is_dir( $path . '/' . $result ) ) {
1066 if ( ! $depth || 'CVS' == $result )
1068 $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1 , $relative_path . $result );
1069 $files = array_merge_recursive( $files, $found );
1070 } elseif ( ! $extensions || preg_match( '~\.(' . $_extensions . ')$~', $result ) ) {
1071 $files[ $relative_path . $result ] = $path . '/' . $result;
1079 * Loads the theme's textdomain.
1081 * Translation files are not inherited from the parent theme. Todo: if this fails for the
1082 * child theme, it should probably try to load the parent theme's translations.
1087 * @return bool True if the textdomain was successfully loaded or has already been loaded.
1088 * False if no textdomain was specified in the file headers, or if the domain could not be loaded.
1090 public function load_textdomain() {
1091 if ( isset( $this->textdomain_loaded ) )
1092 return $this->textdomain_loaded;
1094 $textdomain = $this->get('TextDomain');
1095 if ( ! $textdomain ) {
1096 $this->textdomain_loaded = false;
1100 if ( is_textdomain_loaded( $textdomain ) ) {
1101 $this->textdomain_loaded = true;
1105 $path = $this->get_stylesheet_directory();
1106 if ( $domainpath = $this->get('DomainPath') )
1107 $path .= $domainpath;
1109 $path .= '/languages';
1111 $this->textdomain_loaded = load_theme_textdomain( $textdomain, $path );
1112 return $this->textdomain_loaded;
1116 * Whether the theme is allowed (multisite only).
1121 * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site'
1122 * settings, or 'both'. Defaults to 'both'.
1123 * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current blog.
1124 * @return bool Whether the theme is allowed for the network. Returns true in single-site.
1126 public function is_allowed( $check = 'both', $blog_id = null ) {
1127 if ( ! is_multisite() )
1130 if ( 'both' == $check || 'network' == $check ) {
1131 $allowed = self::get_allowed_on_network();
1132 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) )
1136 if ( 'both' == $check || 'site' == $check ) {
1137 $allowed = self::get_allowed_on_site( $blog_id );
1138 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) )
1146 * Returns array of stylesheet names of themes allowed on the site or network.
1153 * @param int $blog_id Optional. Defaults to current blog.
1154 * @return array Array of stylesheet names.
1156 public static function get_allowed( $blog_id = null ) {
1158 * Filter the array of themes allowed on the site or network.
1162 * @param array $allowed_themes An array of theme stylesheet names.
1164 $network = (array) apply_filters( 'allowed_themes', self::get_allowed_on_network() );
1165 return $network + self::get_allowed_on_site( $blog_id );
1169 * Returns array of stylesheet names of themes allowed on the network.
1176 * @staticvar array $allowed_themes
1178 * @return array Array of stylesheet names.
1180 public static function get_allowed_on_network() {
1181 static $allowed_themes;
1182 if ( ! isset( $allowed_themes ) )
1183 $allowed_themes = (array) get_site_option( 'allowedthemes' );
1184 return $allowed_themes;
1188 * Returns array of stylesheet names of themes allowed on the site.
1195 * @staticvar array $allowed_themes
1197 * @param int $blog_id Optional. Defaults to current blog.
1198 * @return array Array of stylesheet names.
1200 public static function get_allowed_on_site( $blog_id = null ) {
1201 static $allowed_themes = array();
1203 if ( ! $blog_id || ! is_multisite() )
1204 $blog_id = get_current_blog_id();
1206 if ( isset( $allowed_themes[ $blog_id ] ) )
1207 return $allowed_themes[ $blog_id ];
1209 $current = $blog_id == get_current_blog_id();
1212 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
1214 switch_to_blog( $blog_id );
1215 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
1216 restore_current_blog();
1219 // This is all super old MU back compat joy.
1220 // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name.
1221 if ( false === $allowed_themes[ $blog_id ] ) {
1223 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
1225 switch_to_blog( $blog_id );
1226 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
1227 restore_current_blog();
1230 if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) {
1231 $allowed_themes[ $blog_id ] = array();
1233 $converted = array();
1234 $themes = wp_get_themes();
1235 foreach ( $themes as $stylesheet => $theme_data ) {
1236 if ( isset( $allowed_themes[ $blog_id ][ $theme_data->get('Name') ] ) )
1237 $converted[ $stylesheet ] = true;
1239 $allowed_themes[ $blog_id ] = $converted;
1241 // Set the option so we never have to go through this pain again.
1242 if ( is_admin() && $allowed_themes[ $blog_id ] ) {
1244 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
1245 delete_option( 'allowed_themes' );
1247 switch_to_blog( $blog_id );
1248 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
1249 delete_option( 'allowed_themes' );
1250 restore_current_blog();
1255 return (array) $allowed_themes[ $blog_id ];
1259 * Sort themes by name.
1266 public static function sort_by_name( &$themes ) {
1267 if ( 0 === strpos( get_locale(), 'en_' ) ) {
1268 uasort( $themes, array( 'WP_Theme', '_name_sort' ) );
1270 uasort( $themes, array( 'WP_Theme', '_name_sort_i18n' ) );
1275 * Callback function for usort() to naturally sort themes by name.
1277 * Accesses the Name header directly from the class for maximum speed.
1278 * Would choke on HTML but we don't care enough to slow it down with strip_tags().
1287 private static function _name_sort( $a, $b ) {
1288 return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] );
1292 * Name sort (with translation).
1301 private static function _name_sort_i18n( $a, $b ) {
1302 // Don't mark up; Do translate.
1303 return strnatcasecmp( $a->display( 'Name', false, true ), $b->display( 'Name', false, true ) );