X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/e0feb3b2e5b436a06bbb04fbc838d1cd6ec95399..refs/tags/wordpress-4.6.1-scripts:/wp-includes/class-wp-theme.php
diff --git a/wp-includes/class-wp-theme.php b/wp-includes/class-wp-theme.php
index ad70a4bf..40af39df 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',
);
/**
@@ -158,7 +170,7 @@ final class WP_Theme implements ArrayAccess {
/**
* Flag for whether the themes cache bucket should be persistently cached.
*
- * Default is false. Can be set with the wp_cache_themes_persistently filter.
+ * Default is false. Can be set with the {@see 'wp_cache_themes_persistently'} filter.
*
* @static
* @access private
@@ -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 ) {
@@ -416,7 +437,7 @@ final class WP_Theme implements ArrayAccess {
* translated data. We are doing so now as it is safe to do. However, as
* Name and Title could have been used as the key for get_themes(), both remain
* 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
+ * and care should be taken to use `$theme::display( 'Name' )` to get a properly
* translated header.
*
* @param mixed $offset
@@ -426,8 +447,10 @@ final class WP_Theme implements ArrayAccess {
switch ( $offset ) {
case 'Name' :
case 'Title' :
- // See note above about using translated data. get() is not ideal.
- // It is only for backwards compatibility. Use display().
+ /*
+ * See note above about using translated data. get() is not ideal.
+ * It is only for backward compatibility. Use display().
+ */
return $this->get('Name');
case 'Author' :
return $this->display( 'Author');
@@ -748,15 +771,28 @@ final class WP_Theme implements ArrayAccess {
$this->name_translated = translate( $value, $this->get('TextDomain' ) );
return $this->name_translated;
case 'Tags' :
- if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) )
+ if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) ) {
return $value;
+ }
static $tags_list;
if ( ! isset( $tags_list ) ) {
- $tags_list = array();
+ $tags_list = array(
+ // As of 4.6, deprecated tags which are only used to provide translation for older themes.
+ 'black' => __( 'Black' ), 'blue' => __( 'Blue' ), 'brown' => __( 'Brown' ),
+ 'gray' => __( 'Gray' ), 'green' => __( 'Green' ), 'orange' => __( 'Orange' ),
+ 'pink' => __( 'Pink' ), 'purple' => __( 'Purple' ), 'red' => __( 'Red' ),
+ 'silver' => __( 'Silver' ), 'tan' => __( 'Tan' ), 'white' => __( 'White' ),
+ 'yellow' => __( 'Yellow' ), 'dark' => __( 'Dark' ), 'light' => __( 'Light' ),
+ 'fixed-layout' => __( 'Fixed Layout' ), 'fluid-layout' => __( 'Fluid Layout' ),
+ 'responsive-layout' => __( 'Responsive Layout' ), 'blavatar' => __( 'Blavatar' ),
+ 'photoblogging' => __( 'Photoblogging' ), 'seasonal' => __( 'Seasonal' ),
+ );
+
$feature_list = get_theme_feature_list( false ); // No API
- foreach ( $feature_list as $tags )
+ foreach ( $feature_list as $tags ) {
$tags_list += $tags;
+ }
}
foreach ( $value as &$tag ) {
@@ -897,7 +933,7 @@ final class WP_Theme implements ArrayAccess {
*
* This is typically the absolute URL to wp-content/themes. This forms the basis
* 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.
+ * get_theme_root_uri() and allow it to run the {@see 'theme_root_uri'} filter.
*
* @since 3.4.0
* @access public
@@ -1008,20 +1044,17 @@ final class WP_Theme implements ArrayAccess {
$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.
+ * Filters list of page templates for a theme.
*
* @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 +1153,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 +1175,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 +1200,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.
+ * Filters 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 +1233,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' );
+ }
+
+ /**
+ * Filters 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 +1259,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 +1268,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 ] ) ) {
+ /**
+ * Filters 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 +1326,73 @@ 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 );
+ }
+
+ /**
+ * Enables a theme for all sites on the current network.
+ *
+ * @since 4.6.0
+ * @access public
+ * @static
+ *
+ * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
+ */
+ public static function network_enable_theme( $stylesheets ) {
+ if ( ! is_multisite() ) {
+ return;
+ }
+
+ if ( ! is_array( $stylesheets ) ) {
+ $stylesheets = array( $stylesheets );
+ }
+
+ $allowed_themes = get_site_option( 'allowedthemes' );
+ foreach ( $stylesheets as $stylesheet ) {
+ $allowed_themes[ $stylesheet ] = true;
+ }
+
+ update_site_option( 'allowedthemes', $allowed_themes );
+ }
+
+ /**
+ * Disables a theme for all sites on the current network.
+ *
+ * @since 4.6.0
+ * @access public
+ * @static
+ *
+ * @param string|array $stylesheets Stylesheet name or array of stylesheet names.
+ */
+ public static function network_disable_theme( $stylesheets ) {
+ if ( ! is_multisite() ) {
+ return;
+ }
+
+ if ( ! is_array( $stylesheets ) ) {
+ $stylesheets = array( $stylesheets );
+ }
+
+ $allowed_themes = get_site_option( 'allowedthemes' );
+ foreach ( $stylesheets as $stylesheet ) {
+ if ( isset( $allowed_themes[ $stylesheet ] ) ) {
+ unset( $allowed_themes[ $stylesheet ] );
+ }
+ }
+
+ update_site_option( 'allowedthemes', $allowed_themes );
}
/**
- * 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 +1413,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 +1430,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.