WP_Theme::get_allowed_on_site( int $blog_id = null ): string[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$blog_idintoptional

ID of the site. Defaults to the current site.Default: null

Return value

string[]

Array of stylesheet names.

Performance profile

How much work a call to WP_Theme::get_allowed_on_site() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

17–83

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 128.

Plugin surface

1 hook

Third-party callbacks on 'site_allowed_themes' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below WP_Theme::get_allowed_on_site()
• serializeserialisationmaybe_unserialize()one call below WP_Theme::get_allowed_on_site()

Further down the call graph this can also reach transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 81 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme::get_allowed_on_site() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Theme::get_allowed_on_site() runs, in this order:

1. 1
   apply_filters( site_allowed_themes )filterline 1721 (+16 into the body)

   Filters the array of themes allowed on the site.

2. 2
   apply_filters( site_allowed_themes )filterline 1774 (+69 into the body)

   Filters the array of themes allowed on the site.

Uses · 10

• is_multisite()Determines whether Multisite is enabled.
• get_current_blog_id()Retrieves the current site ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_option()Retrieves an option value based on an option name.
• switch_to_blog()Switches the current blog.
• restore_current_blog()Restores the current blog, after calling switch_to_blog().
• wp_get_themes()Returns an array of WP_Theme objects based on the arguments.
• is_admin()Determines whether the current request is for an administrative interface page.
• update_option()Updates the value of an option that was already added.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.

Used by · 4

• WP_Theme::get_allowed()Returns array of stylesheet names of themes allowed on the site or network.
• WP_Theme::is_allowed()Determines whether the theme is allowed (multisite only).
• wp_get_themes()Returns an array of WP_Theme objects based on the arguments.
• wpmu_get_blog_allowedthemes()Deprecated functionality for getting themes allowed on a specific site.

Source code

View on Trac ↗View on GitHub ↗

1705	public static function get_allowed_on_site( $blog_id = null ) {1706		static $allowed_themes = array();1707 1708		if ( ! $blog_id || ! is_multisite() ) {1709			$blog_id = get_current_blog_id();1710		}1711 1712		if ( isset( $allowed_themes[ $blog_id ] ) ) {1713			/**1714			 * Filters the array of themes allowed on the site.1715			 *1716			 * @since 4.5.01717			 *1718			 * @param string[] $allowed_themes An array of theme stylesheet names.1719			 * @param int      $blog_id        ID of the site. Defaults to current site.1720			 */1721			return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );1722		}1723 1724		$current = get_current_blog_id() === $blog_id;1725 1726		if ( $current ) {1727			$allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );1728		} else {1729			switch_to_blog( $blog_id );1730			$allowed_themes[ $blog_id ] = get_option( 'allowedthemes' );1731			restore_current_blog();1732		}1733 1734		/*1735		 * This is all super old MU back compat joy.1736		 * 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name.1737		 */1738		if ( false === $allowed_themes[ $blog_id ] ) {1739			if ( $current ) {1740				$allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );1741			} else {1742				switch_to_blog( $blog_id );1743				$allowed_themes[ $blog_id ] = get_option( 'allowed_themes' );1744				restore_current_blog();1745			}1746 1747			if ( ! is_array( $allowed_themes[ $blog_id ] ) || empty( $allowed_themes[ $blog_id ] ) ) {1748				$allowed_themes[ $blog_id ] = array();1749			} else {1750				$converted = array();1751				$themes    = wp_get_themes();1752				foreach ( $themes as $stylesheet => $theme_data ) {1753					if ( isset( $allowed_themes[ $blog_id ][ $theme_data->get( 'Name' ) ] ) ) {1754						$converted[ $stylesheet ] = true;1755					}1756				}1757				$allowed_themes[ $blog_id ] = $converted;1758			}1759			// Set the option so we never have to go through this pain again.1760			if ( is_admin() && $allowed_themes[ $blog_id ] ) {1761				if ( $current ) {1762					update_option( 'allowedthemes', $allowed_themes[ $blog_id ], false );1763					delete_option( 'allowed_themes' );1764				} else {1765					switch_to_blog( $blog_id );1766					update_option( 'allowedthemes', $allowed_themes[ $blog_id ], false );1767					delete_option( 'allowed_themes' );1768					restore_current_blog();1769				}1770			}1771		}1772 1773		/** This filter is documented in wp-includes/class-wp-theme.php */1774		return (array) apply_filters( 'site_allowed_themes', $allowed_themes[ $blog_id ], $blog_id );1775	}

Changelog

Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-theme.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.