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 {@see '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 ) {
451 * See note above about using translated data. get() is not ideal.
452 * It is only for backward compatibility. Use display().
454 return $this->get('Name');
456 return $this->display( 'Author');
458 return $this->display( 'Author', false);
460 return $this->display('AuthorURI');
462 return $this->display( 'Description');
465 return $this->get( $offset );
467 return $this->get_template();
469 return $this->get_stylesheet();
470 case 'Template Files' :
471 return $this->get_files( 'php', 1, true );
472 case 'Stylesheet Files' :
473 return $this->get_files( 'css', 0, false );
474 case 'Template Dir' :
475 return $this->get_template_directory();
476 case 'Stylesheet Dir' :
477 return $this->get_stylesheet_directory();
479 return $this->get_screenshot( 'relative' );
481 return $this->get('Tags');
483 return $this->get_theme_root();
484 case 'Theme Root URI' :
485 return $this->get_theme_root_uri();
486 case 'Parent Theme' :
487 return $this->parent() ? $this->parent()->get('Name') : '';
494 * Returns errors property.
499 * @return WP_Error|false WP_Error if there are errors, or false.
501 public function errors() {
502 return is_wp_error( $this->errors ) ? $this->errors : false;
506 * Whether the theme exists.
508 * A theme with errors exists. A theme with the error of 'theme_not_found',
509 * meaning that the theme's directory was not found, does not exist.
514 * @return bool Whether the theme exists.
516 public function exists() {
517 return ! ( $this->errors() && in_array( 'theme_not_found', $this->errors()->get_error_codes() ) );
521 * Returns reference to the parent theme.
526 * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
528 public function parent() {
529 return isset( $this->parent ) ? $this->parent : false;
533 * Adds theme data to cache.
535 * Cache entries keyed by the theme and the type of data.
540 * @param string $key Type of data to store (theme, screenshot, headers, page_templates)
541 * @param string $data Data to store
542 * @return bool Return value from wp_cache_add()
544 private function cache_add( $key, $data ) {
545 return wp_cache_add( $key . '-' . $this->cache_hash, $data, 'themes', self::$cache_expiration );
549 * Gets theme data from cache.
551 * Cache entries are keyed by the theme and the type of data.
556 * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates)
557 * @return mixed Retrieved data
559 private function cache_get( $key ) {
560 return wp_cache_get( $key . '-' . $this->cache_hash, 'themes' );
564 * Clears the cache for the theme.
569 public function cache_delete() {
570 foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key )
571 wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' );
572 $this->template = $this->textdomain_loaded = $this->theme_root_uri = $this->parent = $this->errors = $this->headers_sanitized = $this->name_translated = null;
573 $this->headers = array();
574 $this->__construct( $this->stylesheet, $this->theme_root );
578 * Get a raw, unformatted theme header.
580 * The header is sanitized, but is not translated, and is not marked up for display.
581 * To get a theme header for display, use the display() method.
583 * Use the get_template() method, not the 'Template' header, for finding the template.
584 * The 'Template' header is only good for what was written in the style.css, while
585 * get_template() takes into account where WordPress actually located the theme and
586 * whether it is actually valid.
591 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
592 * @return string|false String on success, false on failure.
594 public function get( $header ) {
595 if ( ! isset( $this->headers[ $header ] ) )
598 if ( ! isset( $this->headers_sanitized ) ) {
599 $this->headers_sanitized = $this->cache_get( 'headers' );
600 if ( ! is_array( $this->headers_sanitized ) )
601 $this->headers_sanitized = array();
604 if ( isset( $this->headers_sanitized[ $header ] ) )
605 return $this->headers_sanitized[ $header ];
607 // If themes are a persistent group, sanitize everything and cache it. One cache add is better than many cache sets.
608 if ( self::$persistently_cache ) {
609 foreach ( array_keys( $this->headers ) as $_header )
610 $this->headers_sanitized[ $_header ] = $this->sanitize_header( $_header, $this->headers[ $_header ] );
611 $this->cache_add( 'headers', $this->headers_sanitized );
613 $this->headers_sanitized[ $header ] = $this->sanitize_header( $header, $this->headers[ $header ] );
616 return $this->headers_sanitized[ $header ];
620 * Gets a theme header, formatted and translated for display.
625 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
626 * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
627 * @param bool $translate Optional. Whether to translate the header. Defaults to true.
628 * @return string|false Processed header, false on failure.
630 public function display( $header, $markup = true, $translate = true ) {
631 $value = $this->get( $header );
632 if ( false === $value ) {
636 if ( $translate && ( empty( $value ) || ! $this->load_textdomain() ) )
640 $value = $this->translate_header( $header, $value );
643 $value = $this->markup_header( $header, $value, $translate );
649 * Sanitize a theme header.
654 * @staticvar array $header_tags
655 * @staticvar array $header_tags_with_a
657 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
658 * @param string $value Value to sanitize.
661 private function sanitize_header( $header, $value ) {
668 // Fall through otherwise.
670 static $header_tags = array(
671 'abbr' => array( 'title' => true ),
672 'acronym' => array( 'title' => true ),
677 $value = wp_kses( $value, $header_tags );
680 // There shouldn't be anchor tags in Author, but some themes like to be challenging.
682 static $header_tags_with_a = array(
683 'a' => array( 'href' => true, 'title' => true ),
684 'abbr' => array( 'title' => true ),
685 'acronym' => array( 'title' => true ),
690 $value = wp_kses( $value, $header_tags_with_a );
694 $value = esc_url_raw( $value );
697 $value = array_filter( array_map( 'trim', explode( ',', strip_tags( $value ) ) ) );
700 $value = strip_tags( $value );
708 * Mark up a theme header.
713 * @staticvar string $comma
715 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
716 * @param string $value Value to mark up.
717 * @param string $translate Whether the header has been translated.
718 * @return string Value, marked up.
720 private function markup_header( $header, $value, $translate ) {
723 if ( empty( $value ) )
724 $value = $this->get_stylesheet();
727 $value = wptexturize( $value );
730 if ( $this->get('AuthorURI') ) {
731 $value = sprintf( '<a href="%1$s">%2$s</a>', $this->display( 'AuthorURI', true, $translate ), $value );
732 } elseif ( ! $value ) {
733 $value = __( 'Anonymous' );
737 static $comma = null;
738 if ( ! isset( $comma ) ) {
739 /* translators: used between list items, there is a space after the comma */
742 $value = implode( $comma, $value );
746 $value = esc_url( $value );
754 * Translate a theme header.
759 * @staticvar array $tags_list
761 * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
762 * @param string $value Value to translate.
763 * @return string Translated value.
765 private function translate_header( $header, $value ) {
768 // Cached for sorting reasons.
769 if ( isset( $this->name_translated ) )
770 return $this->name_translated;
771 $this->name_translated = translate( $value, $this->get('TextDomain' ) );
772 return $this->name_translated;
774 if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) ) {
779 if ( ! isset( $tags_list ) ) {
781 // As of 4.6, deprecated tags which are only used to provide translation for older themes.
782 'black' => __( 'Black' ), 'blue' => __( 'Blue' ), 'brown' => __( 'Brown' ),
783 'gray' => __( 'Gray' ), 'green' => __( 'Green' ), 'orange' => __( 'Orange' ),
784 'pink' => __( 'Pink' ), 'purple' => __( 'Purple' ), 'red' => __( 'Red' ),
785 'silver' => __( 'Silver' ), 'tan' => __( 'Tan' ), 'white' => __( 'White' ),
786 'yellow' => __( 'Yellow' ), 'dark' => __( 'Dark' ), 'light' => __( 'Light' ),
787 'fixed-layout' => __( 'Fixed Layout' ), 'fluid-layout' => __( 'Fluid Layout' ),
788 'responsive-layout' => __( 'Responsive Layout' ), 'blavatar' => __( 'Blavatar' ),
789 'photoblogging' => __( 'Photoblogging' ), 'seasonal' => __( 'Seasonal' ),
792 $feature_list = get_theme_feature_list( false ); // No API
793 foreach ( $feature_list as $tags ) {
798 foreach ( $value as &$tag ) {
799 if ( isset( $tags_list[ $tag ] ) ) {
800 $tag = $tags_list[ $tag ];
801 } elseif ( isset( self::$tag_map[ $tag ] ) ) {
802 $tag = $tags_list[ self::$tag_map[ $tag ] ];
809 $value = translate( $value, $this->get('TextDomain') );
815 * The directory name of the theme's "stylesheet" files, inside the theme root.
817 * In the case of a child theme, this is directory name of the child theme.
818 * Otherwise, get_stylesheet() is the same as get_template().
823 * @return string Stylesheet
825 public function get_stylesheet() {
826 return $this->stylesheet;
830 * The directory name of the theme's "template" files, inside the theme root.
832 * In the case of a child theme, this is the directory name of the parent theme.
833 * Otherwise, the get_template() is the same as get_stylesheet().
838 * @return string Template
840 public function get_template() {
841 return $this->template;
845 * Returns the absolute path to the directory of a theme's "stylesheet" files.
847 * In the case of a child theme, this is the absolute path to the directory
848 * of the child theme's files.
853 * @return string Absolute path of the stylesheet directory.
855 public function get_stylesheet_directory() {
856 if ( $this->errors() && in_array( 'theme_root_missing', $this->errors()->get_error_codes() ) )
859 return $this->theme_root . '/' . $this->stylesheet;
863 * Returns the absolute path to the directory of a theme's "template" files.
865 * In the case of a child theme, this is the absolute path to the directory
866 * of the parent theme's files.
871 * @return string Absolute path of the template directory.
873 public function get_template_directory() {
874 if ( $this->parent() )
875 $theme_root = $this->parent()->theme_root;
877 $theme_root = $this->theme_root;
879 return $theme_root . '/' . $this->template;
883 * Returns the URL to the directory of a theme's "stylesheet" files.
885 * In the case of a child theme, this is the URL to the directory of the
886 * child theme's files.
891 * @return string URL to the stylesheet directory.
893 public function get_stylesheet_directory_uri() {
894 return $this->get_theme_root_uri() . '/' . str_replace( '%2F', '/', rawurlencode( $this->stylesheet ) );
898 * Returns the URL to the directory of a theme's "template" files.
900 * In the case of a child theme, this is the URL to the directory of the
901 * parent theme's files.
906 * @return string URL to the template directory.
908 public function get_template_directory_uri() {
909 if ( $this->parent() )
910 $theme_root_uri = $this->parent()->get_theme_root_uri();
912 $theme_root_uri = $this->get_theme_root_uri();
914 return $theme_root_uri . '/' . str_replace( '%2F', '/', rawurlencode( $this->template ) );
918 * The absolute path to the directory of the theme root.
920 * This is typically the absolute path to wp-content/themes.
925 * @return string Theme root.
927 public function get_theme_root() {
928 return $this->theme_root;
932 * Returns the URL to the directory of the theme root.
934 * This is typically the absolute URL to wp-content/themes. This forms the basis
935 * for all other URLs returned by WP_Theme, so we pass it to the public function
936 * get_theme_root_uri() and allow it to run the {@see 'theme_root_uri'} filter.
941 * @return string Theme root URI.
943 public function get_theme_root_uri() {
944 if ( ! isset( $this->theme_root_uri ) )
945 $this->theme_root_uri = get_theme_root_uri( $this->stylesheet, $this->theme_root );
946 return $this->theme_root_uri;
950 * Returns the main screenshot file for the theme.
952 * The main screenshot is called screenshot.png. gif and jpg extensions are also allowed.
954 * Screenshots for a theme must be in the stylesheet directory. (In the case of child
955 * themes, parent theme screenshots are not inherited.)
960 * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
961 * @return string|false Screenshot file. False if the theme does not have a screenshot.
963 public function get_screenshot( $uri = 'uri' ) {
964 $screenshot = $this->cache_get( 'screenshot' );
966 if ( 'relative' == $uri )
968 return $this->get_stylesheet_directory_uri() . '/' . $screenshot;
969 } elseif ( 0 === $screenshot ) {
973 foreach ( array( 'png', 'gif', 'jpg', 'jpeg' ) as $ext ) {
974 if ( file_exists( $this->get_stylesheet_directory() . "/screenshot.$ext" ) ) {
975 $this->cache_add( 'screenshot', 'screenshot.' . $ext );
976 if ( 'relative' == $uri )
977 return 'screenshot.' . $ext;
978 return $this->get_stylesheet_directory_uri() . '/' . 'screenshot.' . $ext;
982 $this->cache_add( 'screenshot', 0 );
987 * Return files in the theme's directory.
992 * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
993 * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
994 * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
995 * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
996 * being absolute paths.
998 public function get_files( $type = null, $depth = 0, $search_parent = false ) {
999 $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
1001 if ( $search_parent && $this->parent() )
1002 $files += (array) self::scandir( $this->get_template_directory(), $type, $depth );
1008 * Returns the theme's page templates.
1013 * @param WP_Post|null $post Optional. The post being edited, provided for context.
1014 * @return array Array of page templates, keyed by filename, with the value of the translated header name.
1016 public function get_page_templates( $post = null ) {
1017 // If you screw up your current theme and we invalidate your parent, most things still work. Let it slide.
1018 if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) )
1021 $page_templates = $this->cache_get( 'page_templates' );
1023 if ( ! is_array( $page_templates ) ) {
1024 $page_templates = array();
1026 $files = (array) $this->get_files( 'php', 1 );
1028 foreach ( $files as $file => $full_path ) {
1029 if ( ! preg_match( '|Template Name:(.*)$|mi', file_get_contents( $full_path ), $header ) )
1031 $page_templates[ $file ] = _cleanup_header_comment( $header[1] );
1034 $this->cache_add( 'page_templates', $page_templates );
1037 if ( $this->load_textdomain() ) {
1038 foreach ( $page_templates as &$page_template ) {
1039 $page_template = $this->translate_header( 'Template Name', $page_template );
1043 if ( $this->parent() )
1044 $page_templates += $this->parent()->get_page_templates( $post );
1047 * Filters list of page templates for a theme.
1050 * @since 4.4.0 Converted to allow complete control over the `$page_templates` array.
1052 * @param array $page_templates Array of page templates. Keys are filenames,
1053 * values are translated names.
1054 * @param WP_Theme $this The theme object.
1055 * @param WP_Post|null $post The post being edited, provided for context, or null.
1057 return (array) apply_filters( 'theme_page_templates', $page_templates, $this, $post );
1061 * Scans a directory for files of a certain extension.
1068 * @param string $path Absolute path to search.
1069 * @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension,
1070 * or null for all extensions. Default null.
1071 * @param int $depth Optional. How many levels deep to search for files. Accepts 0, 1+, or
1072 * -1 (infinite depth). Default 0.
1073 * @param string $relative_path Optional. The basename of the absolute path. Used to control the
1074 * returned path for the found files, particularly when this function
1075 * recurses to lower depths. Default empty.
1076 * @return array|false Array of files, keyed by the path to the file relative to the `$path` directory prepended
1077 * with `$relative_path`, with the values being absolute paths. False otherwise.
1079 private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
1080 if ( ! is_dir( $path ) )
1083 if ( $extensions ) {
1084 $extensions = (array) $extensions;
1085 $_extensions = implode( '|', $extensions );
1088 $relative_path = trailingslashit( $relative_path );
1089 if ( '/' == $relative_path )
1090 $relative_path = '';
1092 $results = scandir( $path );
1095 foreach ( $results as $result ) {
1096 if ( '.' == $result[0] )
1098 if ( is_dir( $path . '/' . $result ) ) {
1099 if ( ! $depth || 'CVS' == $result )
1101 $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1 , $relative_path . $result );
1102 $files = array_merge_recursive( $files, $found );
1103 } elseif ( ! $extensions || preg_match( '~\.(' . $_extensions . ')$~', $result ) ) {
1104 $files[ $relative_path . $result ] = $path . '/' . $result;
1112 * Loads the theme's textdomain.
1114 * Translation files are not inherited from the parent theme. Todo: if this fails for the
1115 * child theme, it should probably try to load the parent theme's translations.
1120 * @return bool True if the textdomain was successfully loaded or has already been loaded.
1121 * False if no textdomain was specified in the file headers, or if the domain could not be loaded.
1123 public function load_textdomain() {
1124 if ( isset( $this->textdomain_loaded ) )
1125 return $this->textdomain_loaded;
1127 $textdomain = $this->get('TextDomain');
1128 if ( ! $textdomain ) {
1129 $this->textdomain_loaded = false;
1133 if ( is_textdomain_loaded( $textdomain ) ) {
1134 $this->textdomain_loaded = true;
1138 $path = $this->get_stylesheet_directory();
1139 if ( $domainpath = $this->get('DomainPath') )
1140 $path .= $domainpath;
1142 $path .= '/languages';
1144 $this->textdomain_loaded = load_theme_textdomain( $textdomain, $path );
1145 return $this->textdomain_loaded;
1149 * Whether the theme is allowed (multisite only).
1154 * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site'
1155 * settings, or 'both'. Defaults to 'both'.
1156 * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current site.
1157 * @return bool Whether the theme is allowed for the network. Returns true in single-site.
1159 public function is_allowed( $check = 'both', $blog_id = null ) {
1160 if ( ! is_multisite() )
1163 if ( 'both' == $check || 'network' == $check ) {
1164 $allowed = self::get_allowed_on_network();
1165 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) )
1169 if ( 'both' == $check || 'site' == $check ) {
1170 $allowed = self::get_allowed_on_site( $blog_id );
1171 if ( ! empty( $allowed[ $this->get_stylesheet() ] ) )
1179 * Determines the latest WordPress default theme that is installed.
1181 * This hits the filesystem.
1183 * @return WP_Theme|false Object, or false if no theme is installed, which would be bad.
1185 public static function get_core_default_theme() {
1186 foreach ( array_reverse( self::$default_themes ) as $slug => $name ) {
1187 $theme = wp_get_theme( $slug );
1188 if ( $theme->exists() ) {
1196 * Returns array of stylesheet names of themes allowed on the site or network.
1203 * @param int $blog_id Optional. ID of the site. Defaults to the current site.
1204 * @return array Array of stylesheet names.
1206 public static function get_allowed( $blog_id = null ) {
1208 * Filters the array of themes allowed on the network.
1210 * Site is provided as context so that a list of network allowed themes can
1211 * be filtered further.
1215 * @param array $allowed_themes An array of theme stylesheet names.
1216 * @param int $blog_id ID of the site.
1218 $network = (array) apply_filters( 'network_allowed_themes', self::get_allowed_on_network(), $blog_id );
1219 return $network + self::get_allowed_on_site( $blog_id );
1223 * Returns array of stylesheet names of themes allowed on the network.
1230 * @staticvar array $allowed_themes
1232 * @return array Array of stylesheet names.
1234 public static function get_allowed_on_network() {
1235 static $allowed_themes;
1236 if ( ! isset( $allowed_themes ) ) {
1237 $allowed_themes = (array) get_site_option( 'allowedthemes' );
1241 * Filters the array of themes allowed on the network.
1245 * @param array $allowed_themes An array of theme stylesheet names.
1247 $allowed_themes = apply_filters( 'allowed_themes', $allowed_themes );
1249 return $allowed_themes;
1253 * Returns array of stylesheet names of themes allowed on the site.
1260 * @staticvar array $allowed_themes
1262 * @param int $blog_id Optional. ID of the site. Defaults to the current site.
1263 * @return array Array of stylesheet names.
1265 public static function get_allowed_on_site( $blog_id = null ) {
1266 static $allowed_themes = array();
1268 if ( ! $blog_id || ! is_multisite() )
1269 $blog_id = get_current_blog_id();
1271 if ( isset( $allowed_themes[ $blog_id ] ) ) {
1273 * Filters the array of themes allowed on the site.
1277 * @param array $allowed_themes An array of theme stylesheet names.
1278 * @param int $blog_id ID of the site. Defaults to current site.
1280 return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );
1283 $current = $blog_id == get_current_blog_id();
1286 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
1288 switch_to_blog( $blog_id );
1289 $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
1290 restore_current_blog();
1293 // This is all super old MU back compat joy.
1294 // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name.
1295 if ( false === $allowed_themes[ $blog_id ] ) {
1297 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
1299 switch_to_blog( $blog_id );
1300 $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
1301 restore_current_blog();
1304 if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) {
1305 $allowed_themes[ $blog_id ] = array();
1307 $converted = array();
1308 $themes = wp_get_themes();
1309 foreach ( $themes as $stylesheet => $theme_data ) {
1310 if ( isset( $allowed_themes[ $blog_id ][ $theme_data->get('Name') ] ) )
1311 $converted[ $stylesheet ] = true;
1313 $allowed_themes[ $blog_id ] = $converted;
1315 // Set the option so we never have to go through this pain again.
1316 if ( is_admin() && $allowed_themes[ $blog_id ] ) {
1318 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
1319 delete_option( 'allowed_themes' );
1321 switch_to_blog( $blog_id );
1322 update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
1323 delete_option( 'allowed_themes' );
1324 restore_current_blog();
1329 /** This filter is documented in wp-includes/class-wp-theme.php */
1330 return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );
1334 * Enables a theme for all sites on the current network.
1340 * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
1342 public static function network_enable_theme( $stylesheets ) {
1343 if ( ! is_multisite() ) {
1347 if ( ! is_array( $stylesheets ) ) {
1348 $stylesheets = array( $stylesheets );
1351 $allowed_themes = get_site_option( 'allowedthemes' );
1352 foreach ( $stylesheets as $stylesheet ) {
1353 $allowed_themes[ $stylesheet ] = true;
1356 update_site_option( 'allowedthemes', $allowed_themes );
1360 * Disables a theme for all sites on the current network.
1366 * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
1368 public static function network_disable_theme( $stylesheets ) {
1369 if ( ! is_multisite() ) {
1373 if ( ! is_array( $stylesheets ) ) {
1374 $stylesheets = array( $stylesheets );
1377 $allowed_themes = get_site_option( 'allowedthemes' );
1378 foreach ( $stylesheets as $stylesheet ) {
1379 if ( isset( $allowed_themes[ $stylesheet ] ) ) {
1380 unset( $allowed_themes[ $stylesheet ] );
1384 update_site_option( 'allowedthemes', $allowed_themes );
1388 * Sorts themes by name.
1395 * @param array $themes Array of themes to sort, passed by reference.
1397 public static function sort_by_name( &$themes ) {
1398 if ( 0 === strpos( get_locale(), 'en_' ) ) {
1399 uasort( $themes, array( 'WP_Theme', '_name_sort' ) );
1401 uasort( $themes, array( 'WP_Theme', '_name_sort_i18n' ) );
1406 * Callback function for usort() to naturally sort themes by name.
1408 * Accesses the Name header directly from the class for maximum speed.
1409 * Would choke on HTML but we don't care enough to slow it down with strip_tags().
1416 * @param string $a First name.
1417 * @param string $b Second name.
1418 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
1419 * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
1421 private static function _name_sort( $a, $b ) {
1422 return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] );
1426 * Name sort (with translation).
1433 * @param string $a First name.
1434 * @param string $b Second name.
1435 * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally.
1436 * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort().
1438 private static function _name_sort_i18n( $a, $b ) {
1439 // Don't mark up; Do translate.
1440 return strnatcasecmp( $a->display( 'Name', false, true ), $b->display( 'Name', false, true ) );