]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class-wp-theme.php
WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / class-wp-theme.php
index c45bf78c96a972a88d79d927a1fba5ade6b197b1..ad70a4bf9e38f789819e2ac40b933c1401df1d9b 100644 (file)
@@ -37,10 +37,26 @@ final class WP_Theme implements ArrayAccess {
         * @var array
         */
        private static $default_themes = array(
-               'classic'      => 'WordPress Classic',
-               'default'      => 'WordPress Default',
-               'twentyten'    => 'Twenty Ten',
-               'twentyeleven' => 'Twenty Eleven',
+               'classic'        => 'WordPress Classic',
+               'default'        => 'WordPress Default',
+               'twentyten'      => 'Twenty Ten',
+               'twentyeleven'   => 'Twenty Eleven',
+               'twentytwelve'   => 'Twenty Twelve',
+               'twentythirteen' => 'Twenty Thirteen',
+               'twentyfourteen' => 'Twenty Fourteen',
+               'twentyfifteen'  => 'Twenty Fifteen',
+       );
+
+       /**
+        * Renamed theme tags.
+        *
+        * @static
+        * @access private
+        * @var array
+        */
+       private static $tag_map = array(
+               'fixed-width'    => 'fixed-layout',
+               'flexible-width' => 'fluid-layout',
        );
 
        /**
@@ -71,6 +87,9 @@ final class WP_Theme implements ArrayAccess {
         * Header name from the theme's style.css after being translated.
         *
         * Cached due to sorting functions running over the translated name.
+        *
+        * @access private
+        * @var string
         */
        private $name_translated;
 
@@ -85,7 +104,7 @@ final class WP_Theme implements ArrayAccess {
        /**
         * The directory name of the theme's files, inside the theme root.
         *
-        * In the case of a child theme, this is directory name of the the child theme.
+        * In the case of a child theme, this is directory name of the child theme.
         * Otherwise, 'stylesheet' is the same as 'template'.
         *
         * @access private
@@ -141,6 +160,7 @@ final class WP_Theme implements ArrayAccess {
         *
         * Default is false. Can be set with the wp_cache_themes_persistently filter.
         *
+        * @static
         * @access private
         * @var bool
         */
@@ -151,6 +171,7 @@ final class WP_Theme implements ArrayAccess {
         *
         * By default the bucket is not cached, so this value is useless.
         *
+        * @static
         * @access private
         * @var bool
         */
@@ -159,15 +180,18 @@ final class WP_Theme implements ArrayAccess {
        /**
         * Constructor for WP_Theme.
         *
+        * @global array $wp_theme_directories
+        *
         * @param string $theme_dir Directory of the theme within the theme_root.
         * @param string $theme_root Theme root.
-        * @param WP_Error|null $_child If this theme is a parent theme, the child may be passed for validation purposes.
+        * @param WP_Error|void $_child If this theme is a parent theme, the child may be passed for validation purposes.
         */
        public function __construct( $theme_dir, $theme_root, $_child = null ) {
                global $wp_theme_directories;
 
                // Initialize caching on first run.
                if ( ! isset( self::$persistently_cache ) ) {
+                       /** This action is documented in wp-includes/theme.php */
                        self::$persistently_cache = apply_filters( 'wp_cache_themes_persistently', false, 'WP_Theme' );
                        if ( self::$persistently_cache ) {
                                wp_cache_add_global_groups( 'themes' );
@@ -204,7 +228,7 @@ final class WP_Theme implements ArrayAccess {
                } elseif ( ! file_exists( $this->theme_root . '/' . $theme_file ) ) {
                        $this->headers['Name'] = $this->stylesheet;
                        if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet ) )
-                               $this->errors = new WP_Error( 'theme_not_found', __( 'The theme directory does not exist.' ) );
+                               $this->errors = new WP_Error( 'theme_not_found', sprintf( __( 'The theme directory "%s" does not exist.' ), $this->stylesheet ) );
                        else
                                $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) );
                        $this->template = $this->stylesheet;
@@ -253,6 +277,7 @@ final class WP_Theme implements ArrayAccess {
                                // Parent theme is missing.
                                $this->errors = new WP_Error( 'theme_no_parent', sprintf( __( 'The parent theme is missing. Please install the "%s" parent theme.' ), $this->template ) );
                                $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) );
+                               $this->parent = new WP_Theme( $this->template, $this->theme_root, $this );
                                return;
                        }
                }
@@ -260,7 +285,7 @@ final class WP_Theme implements ArrayAccess {
                // Set the parent, if we're a child theme.
                if ( $this->template != $this->stylesheet ) {
                        // If we are a parent, then there is a problem. Only two generations allowed! Cancel things out.
-                       if ( is_a( $_child, 'WP_Theme' ) && $_child->template == $this->stylesheet ) {
+                       if ( $_child instanceof WP_Theme && $_child->template == $this->stylesheet ) {
                                $_child->parent = null;
                                $_child->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), $_child->template ) );
                                $_child->cache_add( 'theme', array( 'headers' => $_child->headers, 'errors' => $_child->errors, 'stylesheet' => $_child->stylesheet, 'template' => $_child->template ) );
@@ -296,6 +321,10 @@ final class WP_Theme implements ArrayAccess {
 
        /**
         * __isset() magic method for properties formerly returned by current_theme_info()
+        *
+        * @staticvar array $properties
+        *
+        * @return bool
         */
        public function __isset( $offset ) {
                static $properties = array(
@@ -308,6 +337,8 @@ final class WP_Theme implements ArrayAccess {
 
        /**
         * __get() magic method for properties formerly returned by current_theme_info()
+        *
+        * @return mixed
         */
        public function __get( $offset ) {
                switch ( $offset ) {
@@ -347,22 +378,32 @@ final class WP_Theme implements ArrayAccess {
 
        /**
         * Method to implement ArrayAccess for keys formerly returned by get_themes()
+        *
+        * @param mixed $offset
+        * @param mixed $value
         */
        public function offsetSet( $offset, $value ) {}
 
        /**
         * Method to implement ArrayAccess for keys formerly returned by get_themes()
+        *
+        * @param mixed $offset
         */
        public function offsetUnset( $offset ) {}
 
        /**
         * Method to implement ArrayAccess for keys formerly returned by get_themes()
+        *
+        * @staticvar array $keys
+        *
+        * @param mixed $offset
+        * @return bool
         */
        public function offsetExists( $offset ) {
                static $keys = array(
                        'Name', 'Version', 'Status', 'Title', 'Author', 'Author Name', 'Author URI', 'Description',
                        'Template', 'Stylesheet', 'Template Files', 'Stylesheet Files', 'Template Dir', 'Stylesheet Dir',
-                        'Screenshot', 'Tags', 'Theme Root', 'Theme Root URI', 'Parent Theme',
+                       'Screenshot', 'Tags', 'Theme Root', 'Theme Root URI', 'Parent Theme',
                );
 
                return in_array( $offset, $keys );
@@ -377,6 +418,9 @@ final class WP_Theme implements ArrayAccess {
         * untranslated for back compatibility. This means that ['Name'] is not ideal,
         * and care should be taken to use $theme->display('Name') to get a properly
         * translated header.
+        *
+        * @param mixed $offset
+        * @return mixed
         */
        public function offsetGet( $offset ) {
                switch ( $offset ) {
@@ -429,7 +473,7 @@ final class WP_Theme implements ArrayAccess {
         * @since 3.4.0
         * @access public
         *
-        * @return WP_Error|bool WP_Error if there are errors, or false.
+        * @return WP_Error|false WP_Error if there are errors, or false.
         */
        public function errors() {
                return is_wp_error( $this->errors ) ? $this->errors : false;
@@ -456,7 +500,7 @@ final class WP_Theme implements ArrayAccess {
         * @since 3.4.0
         * @access public
         *
-        * @return WP_Theme|bool Parent theme, or false if the current theme is not a child theme.
+        * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
         */
        public function parent() {
                return isset( $this->parent ) ? $this->parent : false;
@@ -467,8 +511,8 @@ final class WP_Theme implements ArrayAccess {
         *
         * Cache entries keyed by the theme and the type of data.
         *
-        * @access private
         * @since 3.4.0
+        * @access private
         *
         * @param string $key Type of data to store (theme, screenshot, headers, page_templates)
         * @param string $data Data to store
@@ -483,8 +527,8 @@ final class WP_Theme implements ArrayAccess {
         *
         * Cache entries are keyed by the theme and the type of data.
         *
-        * @access private
         * @since 3.4.0
+        * @access private
         *
         * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates)
         * @return mixed Retrieved data
@@ -496,8 +540,8 @@ final class WP_Theme implements ArrayAccess {
        /**
         * Clears the cache for the theme.
         *
-        * @access public
         * @since 3.4.0
+        * @access public
         */
        public function cache_delete() {
                foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key )
@@ -518,11 +562,11 @@ final class WP_Theme implements ArrayAccess {
         * get_template() takes into account where WordPress actually located the theme and
         * whether it is actually valid.
         *
-        * @access public
         * @since 3.4.0
+        * @access public
         *
         * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
-        * @return string String on success, false on failure.
+        * @return string|false String on success, false on failure.
         */
        public function get( $header ) {
                if ( ! isset( $this->headers[ $header ] ) )
@@ -552,16 +596,19 @@ final class WP_Theme implements ArrayAccess {
        /**
         * Gets a theme header, formatted and translated for display.
         *
-        * @access public
         * @since 3.4.0
+        * @access public
         *
         * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
         * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
         * @param bool $translate Optional. Whether to translate the header. Defaults to true.
-        * @return string Processed header, false on failure.
+        * @return string|false Processed header, false on failure.
         */
        public function display( $header, $markup = true, $translate = true ) {
                $value = $this->get( $header );
+               if ( false === $value ) {
+                       return false;
+               }
 
                if ( $translate && ( empty( $value ) || ! $this->load_textdomain() ) )
                        $translate = false;
@@ -578,8 +625,15 @@ final class WP_Theme implements ArrayAccess {
        /**
         * Sanitize a theme header.
         *
+        * @since 3.4.0
+        * @access private
+        *
+        * @staticvar array $header_tags
+        * @staticvar array $header_tags_with_a
+        *
         * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
         * @param string $value Value to sanitize.
+        * @return mixed
         */
        private function sanitize_header( $header, $value ) {
                switch ( $header ) {
@@ -619,6 +673,9 @@ final class WP_Theme implements ArrayAccess {
                        case 'Tags' :
                                $value = array_filter( array_map( 'trim', explode( ',', strip_tags( $value ) ) ) );
                                break;
+                       case 'Version' :
+                               $value = strip_tags( $value );
+                               break;
                }
 
                return $value;
@@ -627,8 +684,10 @@ final class WP_Theme implements ArrayAccess {
        /**
         * Mark up a theme header.
         *
+     * @since 3.4.0
         * @access private
-        * @since 3.4.0
+        *
+        * @staticvar string $comma
         *
         * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
         * @param string $value Value to mark up.
@@ -646,10 +705,7 @@ final class WP_Theme implements ArrayAccess {
                                break;
                        case 'Author' :
                                if ( $this->get('AuthorURI') ) {
-                                       static $attr = null;
-                                       if ( ! isset( $attr ) )
-                                               $attr = esc_attr__( 'Visit author homepage' );
-                                       $value = sprintf( '<a href="%1$s" title="%2$s">%3$s</a>', $this->display( 'AuthorURI', true, $translate ), $attr, $value );
+                                       $value = sprintf( '<a href="%1$s">%2$s</a>', $this->display( 'AuthorURI', true, $translate ), $value );
                                } elseif ( ! $value ) {
                                        $value = __( 'Anonymous' );
                                }
@@ -674,8 +730,10 @@ final class WP_Theme implements ArrayAccess {
        /**
         * Translate a theme header.
         *
-        * @access private
         * @since 3.4.0
+        * @access private
+        *
+        * @staticvar array $tags_list
         *
         * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
         * @param string $value Value to translate.
@@ -702,12 +760,15 @@ final class WP_Theme implements ArrayAccess {
                                }
 
                                foreach ( $value as &$tag ) {
-                                       if ( isset( $tags_list[ $tag ] ) )
+                                       if ( isset( $tags_list[ $tag ] ) ) {
                                                $tag = $tags_list[ $tag ];
+                                       } elseif ( isset( self::$tag_map[ $tag ] ) ) {
+                                               $tag = $tags_list[ self::$tag_map[ $tag ] ];
+                                       }
                                }
 
                                return $value;
-                               break;
+
                        default :
                                $value = translate( $value, $this->get('TextDomain') );
                }
@@ -717,7 +778,7 @@ final class WP_Theme implements ArrayAccess {
        /**
         * The directory name of the theme's "stylesheet" files, inside the theme root.
         *
-        * In the case of a child theme, this is directory name of the the child theme.
+        * In the case of a child theme, this is directory name of the child theme.
         * Otherwise, get_stylesheet() is the same as get_template().
         *
         * @since 3.4.0
@@ -838,8 +899,6 @@ final class WP_Theme implements ArrayAccess {
         * for all other URLs returned by WP_Theme, so we pass it to the public function
         * get_theme_root_uri() and allow it to run the theme_root_uri filter.
         *
-        * @uses get_theme_root_uri()
-        *
         * @since 3.4.0
         * @access public
         *
@@ -863,7 +922,7 @@ final class WP_Theme implements ArrayAccess {
         * @access public
         *
         * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
-        * @return mixed Screenshot file. False if the theme does not have a screenshot.
+        * @return string|false Screenshot file. False if the theme does not have a screenshot.
         */
        public function get_screenshot( $uri = 'uri' ) {
                $screenshot = $this->cache_get( 'screenshot' );
@@ -898,7 +957,7 @@ final class WP_Theme implements ArrayAccess {
         * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
         * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
         * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
-        *      being absolute paths.
+        *                   being absolute paths.
         */
        public function get_files( $type = null, $depth = 0, $search_parent = false ) {
                $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
@@ -915,9 +974,10 @@ final class WP_Theme implements ArrayAccess {
         * @since 3.4.0
         * @access public
         *
+        * @param WP_Post|null $post Optional. The post being edited, provided for context.
         * @return array Array of page templates, keyed by filename, with the value of the translated header name.
         */
-       public function get_page_templates() {
+       public function get_page_templates( $post = null ) {
                // If you screw up your current theme and we invalidate your parent, most things still work. Let it slide.
                if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) )
                        return array();
@@ -945,22 +1005,43 @@ final class WP_Theme implements ArrayAccess {
                }
 
                if ( $this->parent() )
-                       $page_templates += $this->parent()->get_page_templates();
-
-               return $page_templates;
+                       $page_templates += $this->parent()->get_page_templates( $post );
+
+               /**
+                * Filter list of page templates for a theme.
+                *
+                * This filter does not currently allow for page templates to be added.
+                *
+                * @since 3.9.0
+                *
+                * @param array        $page_templates Array of page templates. Keys are filenames,
+                *                                     values are translated names.
+                * @param WP_Theme     $this           The theme object.
+                * @param WP_Post|null $post           The post being edited, provided for context, or null.
+                */
+               $return = apply_filters( 'theme_page_templates', $page_templates, $this, $post );
+
+               return array_intersect_assoc( $return, $page_templates );
        }
 
        /**
         * Scans a directory for files of a certain extension.
         *
         * @since 3.4.0
+        *
+        * @static
         * @access private
         *
-        * @param string $path Absolute path to search.
-        * @param mixed  Array of extensions to find, string of a single extension, or null for all extensions.
-        * @param int $depth How deep to search for files. Optional, defaults to a flat scan (0 depth). -1 depth is infinite.
-        * @param string $relative_path The basename of the absolute path. Used to control the returned path
-        *      for the found files, particularly when this function recurses to lower depths.
+        * @param string            $path          Absolute path to search.
+        * @param array|string|null $extensions    Optional. Array of extensions to find, string of a single extension,
+        *                                         or null for all extensions. Default null.
+        * @param int               $depth         Optional. How many levels deep to search for files. Accepts 0, 1+, or
+        *                                         -1 (infinite depth). Default 0.
+        * @param string            $relative_path Optional. The basename of the absolute path. Used to control the
+        *                                         returned path for the found files, particularly when this function
+        *                                         recurses to lower depths. Default empty.
+        * @return array|false Array of files, keyed by the path to the file relative to the `$path` directory prepended
+        *                     with `$relative_path`, with the values being absolute paths. False otherwise.
         */
        private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
                if ( ! is_dir( $path ) )
@@ -1003,8 +1084,8 @@ final class WP_Theme implements ArrayAccess {
         * @since 3.4.0
         * @access public
         *
-        * @return True if the textdomain was successfully loaded or has already been loaded. False if
-        *      no textdomain was specified in the file headers, or if the domain could not be loaded.
+        * @return bool True if the textdomain was successfully loaded or has already been loaded.
+        *      False if no textdomain was specified in the file headers, or if the domain could not be loaded.
         */
        public function load_textdomain() {
                if ( isset( $this->textdomain_loaded ) )
@@ -1065,12 +1146,21 @@ final class WP_Theme implements ArrayAccess {
         * Returns array of stylesheet names of themes allowed on the site or network.
         *
         * @since 3.4.0
+        *
+        * @static
         * @access public
         *
         * @param int $blog_id Optional. Defaults to current blog.
         * @return array Array of stylesheet names.
         */
        public static function get_allowed( $blog_id = null ) {
+               /**
+                * Filter the array of themes allowed on the site or network.
+                *
+                * @since MU
+                *
+                * @param array $allowed_themes An array of theme stylesheet names.
+                */
                $network = (array) apply_filters( 'allowed_themes', self::get_allowed_on_network() );
                return $network + self::get_allowed_on_site( $blog_id );
        }
@@ -1079,8 +1169,12 @@ final class WP_Theme implements ArrayAccess {
         * Returns array of stylesheet names of themes allowed on the network.
         *
         * @since 3.4.0
+        *
+        * @static
         * @access public
         *
+        * @staticvar array $allowed_themes
+        *
         * @return array Array of stylesheet names.
         */
        public static function get_allowed_on_network() {
@@ -1094,15 +1188,19 @@ final class WP_Theme implements ArrayAccess {
         * Returns array of stylesheet names of themes allowed on the site.
         *
         * @since 3.4.0
+        *
+        * @static
         * @access public
         *
+        * @staticvar array $allowed_themes
+        *
         * @param int $blog_id Optional. Defaults to current blog.
         * @return array Array of stylesheet names.
         */
        public static function get_allowed_on_site( $blog_id = null ) {
                static $allowed_themes = array();
 
-               if ( ! $blog_id )
+               if ( ! $blog_id || ! is_multisite() )
                        $blog_id = get_current_blog_id();
 
                if ( isset( $allowed_themes[ $blog_id ] ) )
@@ -1110,18 +1208,24 @@ final class WP_Theme implements ArrayAccess {
 
                $current = $blog_id == get_current_blog_id();
 
-               if ( $current )
+               if ( $current ) {
                        $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
-               else
-                       $allowed_themes[ $blog_id ] = get_blog_option( $blog_id, 'allowedthemes' );
+               } else {
+                       switch_to_blog( $blog_id );
+                       $allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );
+                       restore_current_blog();
+               }
 
                // This is all super old MU back compat joy.
                // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name.
                if ( false === $allowed_themes[ $blog_id ] ) {
-                       if ( $current )
+                       if ( $current ) {
                                $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
-                       else
-                               $allowed_themes[ $blog_id ] = get_blog_option( $blog_id, 'allowed_themes' );
+                       } else {
+                               switch_to_blog( $blog_id );
+                               $allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );
+                               restore_current_blog();
+                       }
 
                        if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) {
                                $allowed_themes[ $blog_id ] = array();
@@ -1140,8 +1244,10 @@ final class WP_Theme implements ArrayAccess {
                                        update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
                                        delete_option( 'allowed_themes' );
                                } else {
-                                       update_blog_option( $blog_id, 'allowedthemes', $allowed_themes[ $blog_id ] );
-                                       delete_blog_option( $blog_id, 'allowed_themes' );
+                                       switch_to_blog( $blog_id );
+                                       update_option( 'allowedthemes', $allowed_themes[ $blog_id ] );
+                                       delete_option( 'allowed_themes' );
+                                       restore_current_blog();
                                }
                        }
                }
@@ -1153,6 +1259,8 @@ final class WP_Theme implements ArrayAccess {
         * Sort themes by name.
         *
         * @since 3.4.0
+        *
+        * @static
         * @access public
         */
        public static function sort_by_name( &$themes ) {
@@ -1170,7 +1278,11 @@ final class WP_Theme implements ArrayAccess {
         * Would choke on HTML but we don't care enough to slow it down with strip_tags().
         *
         * @since 3.4.0
+        *
+        * @static
         * @access private
+        *
+        * @return int
         */
        private static function _name_sort( $a, $b ) {
                return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] );
@@ -1180,7 +1292,11 @@ final class WP_Theme implements ArrayAccess {
         * Name sort (with translation).
         *
         * @since 3.4.0
+        *
+        * @static
         * @access private
+        *
+        * @return int
         */
        private static function _name_sort_i18n( $a, $b ) {
                // Don't mark up; Do translate.