X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/53f4633144ed68c8b8fb5861f992b5489894a940..d3947bc013df7edd54b46deed8230d2eeafc5ecb:/wp-includes/class-wp-theme.php diff --git a/wp-includes/class-wp-theme.php b/wp-includes/class-wp-theme.php index ad70a4bf..d98fb314 100644 --- a/wp-includes/class-wp-theme.php +++ b/wp-includes/class-wp-theme.php @@ -4,10 +4,21 @@ * * @package WordPress * @subpackage Theme + * @since 3.4.0 */ - final class WP_Theme implements ArrayAccess { + /** + * Whether the theme has been marked as updateable. + * + * @since 4.4.0 + * @access public + * @var bool + * + * @see WP_MS_Themes_List_Table + */ + public $update = false; + /** * Headers for style.css files. * @@ -45,6 +56,7 @@ final class WP_Theme implements ArrayAccess { 'twentythirteen' => 'Twenty Thirteen', 'twentyfourteen' => 'Twenty Fourteen', 'twentyfifteen' => 'Twenty Fifteen', + 'twentysixteen' => 'Twenty Sixteen', ); /** @@ -228,7 +240,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', sprintf( __( 'The theme directory "%s" does not exist.' ), $this->stylesheet ) ); + $this->errors = new WP_Error( 'theme_not_found', sprintf( __( 'The theme directory "%s" does not exist.' ), esc_html( $this->stylesheet ) ) ); else $this->errors = new WP_Error( 'theme_no_stylesheet', __( 'Stylesheet is missing.' ) ); $this->template = $this->stylesheet; @@ -256,7 +268,14 @@ final class WP_Theme implements ArrayAccess { if ( ! $this->template && ! ( $this->template = $this->headers['Template'] ) ) { $this->template = $this->stylesheet; if ( ! file_exists( $this->theme_root . '/' . $this->stylesheet . '/index.php' ) ) { - $this->errors = new WP_Error( 'theme_no_index', __( 'Template is missing.' ) ); + $error_message = sprintf( + /* translators: 1: index.php, 2: Codex URL, 3: style.css */ + __( 'Template is missing. Standalone themes need to have a %1$s template file. Child themes need to have a Template header in the %3$s stylesheet.' ), + 'index.php', + __( 'https://codex.wordpress.org/Child_Themes' ), + 'style.css' + ); + $this->errors = new WP_Error( 'theme_no_index', $error_message ); $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); return; } @@ -275,7 +294,7 @@ final class WP_Theme implements ArrayAccess { $theme_root_template = $directories[ $this->template ]['theme_root']; } else { // 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->errors = new WP_Error( 'theme_no_parent', sprintf( __( 'The parent theme is missing. Please install the "%s" parent theme.' ), esc_html( $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; @@ -287,11 +306,11 @@ final class WP_Theme implements ArrayAccess { // If we are a parent, then there is a problem. Only two generations allowed! Cancel things out. 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->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), esc_html( $_child->template ) ) ); $_child->cache_add( 'theme', array( 'headers' => $_child->headers, 'errors' => $_child->errors, 'stylesheet' => $_child->stylesheet, 'template' => $_child->template ) ); // The two themes actually reference each other with the Template header. if ( $_child->stylesheet == $this->template ) { - $this->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), $this->template ) ); + $this->errors = new WP_Error( 'theme_parent_invalid', sprintf( __( 'The "%s" theme is not a valid parent theme.' ), esc_html( $this->template ) ) ); $this->cache_add( 'theme', array( 'headers' => $this->headers, 'errors' => $this->errors, 'stylesheet' => $this->stylesheet, 'template' => $this->template ) ); } return; @@ -324,7 +343,8 @@ final class WP_Theme implements ArrayAccess { * * @staticvar array $properties * - * @return bool + * @param string $offset Property to check if set. + * @return bool Whether the given property is set. */ public function __isset( $offset ) { static $properties = array( @@ -338,7 +358,8 @@ final class WP_Theme implements ArrayAccess { /** * __get() magic method for properties formerly returned by current_theme_info() * - * @return mixed + * @param string $offset Property to get. + * @return mixed Property value. */ public function __get( $offset ) { switch ( $offset ) { @@ -1010,18 +1031,15 @@ final class WP_Theme implements ArrayAccess { /** * Filter list of page templates for a theme. * - * This filter does not currently allow for page templates to be added. - * * @since 3.9.0 + * @since 4.4.0 Converted to allow complete control over the `$page_templates` array. * * @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 ); + return (array) apply_filters( 'theme_page_templates', $page_templates, $this, $post ); } /** @@ -1120,7 +1138,7 @@ final class WP_Theme implements ArrayAccess { * * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site' * settings, or 'both'. Defaults to 'both'. - * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current blog. + * @param int $blog_id Optional. Ignored if only network-wide settings are checked. Defaults to current site. * @return bool Whether the theme is allowed for the network. Returns true in single-site. */ public function is_allowed( $check = 'both', $blog_id = null ) { @@ -1142,6 +1160,23 @@ final class WP_Theme implements ArrayAccess { return false; } + /** + * Determines the latest WordPress default theme that is installed. + * + * This hits the filesystem. + * + * @return WP_Theme|false Object, or false if no theme is installed, which would be bad. + */ + public static function get_core_default_theme() { + foreach ( array_reverse( self::$default_themes ) as $slug => $name ) { + $theme = wp_get_theme( $slug ); + if ( $theme->exists() ) { + return $theme; + } + } + return false; + } + /** * Returns array of stylesheet names of themes allowed on the site or network. * @@ -1150,18 +1185,22 @@ final class WP_Theme implements ArrayAccess { * @static * @access public * - * @param int $blog_id Optional. Defaults to current blog. + * @param int $blog_id Optional. ID of the site. Defaults to the current site. * @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. + * Filter the array of themes allowed on the network. * - * @since MU + * Site is provided as context so that a list of network allowed themes can + * be filtered further. + * + * @since 4.5.0 * * @param array $allowed_themes An array of theme stylesheet names. + * @param int $blog_id ID of the site. */ - $network = (array) apply_filters( 'allowed_themes', self::get_allowed_on_network() ); + $network = (array) apply_filters( 'network_allowed_themes', self::get_allowed_on_network(), $blog_id ); return $network + self::get_allowed_on_site( $blog_id ); } @@ -1179,8 +1218,19 @@ final class WP_Theme implements ArrayAccess { */ public static function get_allowed_on_network() { static $allowed_themes; - if ( ! isset( $allowed_themes ) ) + if ( ! isset( $allowed_themes ) ) { $allowed_themes = (array) get_site_option( 'allowedthemes' ); + } + + /** + * Filter the array of themes allowed on the network. + * + * @since MU + * + * @param array $allowed_themes An array of theme stylesheet names. + */ + $allowed_themes = apply_filters( 'allowed_themes', $allowed_themes ); + return $allowed_themes; } @@ -1194,7 +1244,7 @@ final class WP_Theme implements ArrayAccess { * * @staticvar array $allowed_themes * - * @param int $blog_id Optional. Defaults to current blog. + * @param int $blog_id Optional. ID of the site. Defaults to the current site. * @return array Array of stylesheet names. */ public static function get_allowed_on_site( $blog_id = null ) { @@ -1203,8 +1253,17 @@ final class WP_Theme implements ArrayAccess { if ( ! $blog_id || ! is_multisite() ) $blog_id = get_current_blog_id(); - if ( isset( $allowed_themes[ $blog_id ] ) ) - return $allowed_themes[ $blog_id ]; + if ( isset( $allowed_themes[ $blog_id ] ) ) { + /** + * Filter the array of themes allowed on the site. + * + * @since 4.5.0 + * + * @param array $allowed_themes An array of theme stylesheet names. + * @param int $blog_id ID of the site. Defaults to current site. + */ + return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id ); + } $current = $blog_id == get_current_blog_id(); @@ -1252,16 +1311,19 @@ final class WP_Theme implements ArrayAccess { } } - return (array) $allowed_themes[ $blog_id ]; + /** This filter is documented in wp-includes/class-wp-theme.php */ + return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id ); } /** - * Sort themes by name. + * Sorts themes by name. * * @since 3.4.0 * * @static * @access public + * + * @param array $themes Array of themes to sort, passed by reference. */ public static function sort_by_name( &$themes ) { if ( 0 === strpos( get_locale(), 'en_' ) ) { @@ -1282,7 +1344,10 @@ final class WP_Theme implements ArrayAccess { * @static * @access private * - * @return int + * @param string $a First name. + * @param string $b Second name. + * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally. + * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort(). */ private static function _name_sort( $a, $b ) { return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] ); @@ -1296,7 +1361,10 @@ final class WP_Theme implements ArrayAccess { * @static * @access private * - * @return int + * @param string $a First name. + * @param string $b Second name. + * @return int Negative if `$a` falls lower in the natural order than `$b`. Zero if they fall equally. + * Greater than 0 if `$a` falls higher in the natural order than `$b`. Used with usort(). */ private static function _name_sort_i18n( $a, $b ) { // Don't mark up; Do translate.