WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / class-wp-theme.php
index cf497f130f432e4c92f849090dd31fe23897ec97..d98fb3149b0a5d2b6f825a887ba91e02289ce888 100644 (file)
@@ -268,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. <a href="%2$s">Child themes</a> need to have a Template header in the %3$s stylesheet.' ),
+                                       '<code>index.php</code>',
+                                       __( 'https://codex.wordpress.org/Child_Themes' ),
+                                       '<code>style.css</code>'
+                               );
+                               $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;
                        }
@@ -336,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(
@@ -350,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 ) {
@@ -1129,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 ) {
@@ -1176,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 );
        }
 
@@ -1205,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;
        }
 
@@ -1220,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 ) {
@@ -1229,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();
 
@@ -1278,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_' ) ) {
@@ -1308,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'] );
@@ -1322,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.