Changeset 36366

Timestamp:

01/20/2016 06:28:33 PM (11 years ago)

Author:

jeremyfelt

Message:

Themes: Enhance filtering options for allowed themes on a network.

• Move the legacy allowed_themes filter to WP_Theme::get_allowed_on_network(), where it will continue to filter themes allowed on the network.
• Add network_allowed_themes filter to WP_Theme::get_allowed() and pass $blog_id to provide context.
• Add site_allowed_themes filter to WP_Theme::get_allowed_on_site() and pass $blog_id to provide context.

Props pauldewouters, lamosty, michalzuber, dmsnell, johnnypea, rob.
Fixes #28436.

Location:

trunk

Files:

• src/wp-includes/class-wp-theme.php (modified) (5 diffs)
• tests/phpunit/tests/theme/getAllowedFilters.php (modified) (4 diffs)

trunk/src/wp-includes/class-wp-theme.php

@@ -1178 +1178 @@
          * @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.
+                 *
+                 * 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( 'network_allowed_themes', self::get_allowed_on_network(), $blog_id );
+                return $network + self::get_allowed_on_site( $blog_id );
+        }
+
+        /**
+         * 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() {
+                static $allowed_themes;
+                if ( ! isset( $allowed_themes ) ) {
+                        $allowed_themes = (array) get_site_option( 'allowedthemes' );
+                }
+
+                /**
+                 * Filter the array of themes allowed on the network.
                  *
                  * @since MU
@@ -1189 +1222 @@
                  * @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 );
-        }
-
-        /**
-         * Returns array of stylesheet names of themes allowed on the network.
+                $allowed_themes = apply_filters( 'allowed_themes', $allowed_themes );
+
+                return $allowed_themes;
+        }
+
+        /**
+         * Returns array of stylesheet names of themes allowed on the site.
          *
          * @since 3.4.0
@@ -1203 +1237 @@
          * @staticvar array $allowed_themes
          *
-         * @return array Array of stylesheet names.
-         */
-        public static function get_allowed_on_network() {
-                static $allowed_themes;
-                if ( ! isset( $allowed_themes ) )
-                        $allowed_themes = (array) get_site_option( 'allowedthemes' );
-                return $allowed_themes;
-        }
-
-        /**
-         * 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.
+         * @param int $blog_id Optional. ID of the site. Defaults to the current site.
          * @return array Array of stylesheet names.
          */
@@ -1231 +1246 @@
                         $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();
@@ -1280 +1304 @@
                 }
 
-                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 );
         }
 

trunk/tests/phpunit/tests/theme/getAllowedFilters.php

@@ -1 +1 @@
 <?php
+if ( is_multisite() ) :
 /**
  * Tests specific to the filtering of `WP_Theme::get_allowed()` and related functions.
  *
  * @group themes
+ * @group multisite
  */
 class Tests_WP_Theme_Get_Allowed_Filters extends WP_UnitTestCase {
@@ -10 +12 @@
          */
         protected $default_allowed;
+
+        protected $filter_network_allowed_themes_args;
+
+        public function test_network_allowed_themes_filter_sends_blog_id() {
+                $blog_id = 1;
+
+                add_filter( 'network_allowed_themes', array( $this, 'filter_network_allowed_themes' ), 10, 2 );
+                WP_Theme::get_allowed( $blog_id );
+                remove_filter( 'network_allowed_themes', array( $this, 'filter_network_allowed_themes' ) );
+
+                $this->assertEquals( 2, count( $this->filter_network_allowed_themes_args ) );
+                $this->assertEquals( $blog_id, $this->filter_network_allowed_themes_args[1] );
+        }
 
         /**
@@ -28 +43 @@
         }
 
+        /**
+         * Test the `network_allowed_themes` filter, which filters allowed themes on the network and provides `$blog_id`.
+         */
+        public function test_wp_theme_get_allowed_with_network_allowed_themes_filter() {
+                $blog_id = 1;
+
+                $this->default_allowed = WP_Theme::get_allowed( $blog_id );
+
+                add_filter( 'network_allowed_themes', array( $this, 'filter_network_allowed_themes' ), 10, 2 );
+                $allowed = WP_Theme::get_allowed( $blog_id );
+                remove_filter( 'network_allowed_themes', array( $this, 'filter_network_allowed_themes' ), 10 );
+
+                $expected = $this->default_allowed + array( 'network-allowed-theme' => true );
+
+                $this->assertEquals( $expected, $allowed );
+        }
+
+        /**
+         * Test the `site_allowed_themes` filter, which filters allowed themes for a site and provides `$blog_id`.
+         */
+        public function test_wp_theme_get_allowed_with_site_allowed_themes_filter() {
+                $blog_id = 1;
+
+                $this->default_allowed = WP_Theme::get_allowed( $blog_id );
+
+                add_filter( 'site_allowed_themes', array( $this, 'filter_site_allowed_themes' ), 10, 2 );
+                $allowed = WP_Theme::get_allowed( $blog_id );
+                remove_filter( 'site_allowed_themes', array( $this, 'filter_site_allowed_themes' ), 10 );
+
+                $expected = $this->default_allowed + array( 'site-allowed-theme' => true );
+
+                $this->assertEquals( $expected, $allowed );
+        }
+
         public function filter_allowed_themes( $allowed_themes ) {
                 $allowed_themes['allow-on-network'] = true;
@@ -33 +82 @@
                 return $allowed_themes;
         }
+
+        public function filter_network_allowed_themes( $allowed_themes, $blog_id ) {
+                $this->filter_network_allowed_themes_args = func_get_args();
+
+                $allowed_themes['network-allowed-theme'] = true;
+
+                return $allowed_themes;
+        }
+
+        public function filter_site_allowed_themes( $allowed_themes, $blog_id ) {
+                $allowed_themes['site-allowed-theme'] = true;
+
+                return $allowed_themes;
+        }
 }
+endif;