wp_get_themes( array $args = array() ): WP_Theme[]

Description

Compatibility

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

Parameters

$argsarrayoptional

The search arguments.Default: array()

• $errorsmixeddefault: false

  True to return themes with errors, false to return themes without errors, null to return all themes.

• $allowedmixeddefault: null

  (Multisite) True to return only allowed themes for a site. False to return only disallowed themes for a site. 'site' to return only site-allowed themes. 'network' to return only network-allowed themes. Null to return all themes.

• $blog_idintdefault: 0, synonymous for the current blog

  (Multisite) The blog ID used to calculate which themes are allowed.

Return value

WP_Theme[]

Array of WP_Theme objects.

Performance profile

How much work a call to wp_get_themes() 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

16–71

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

16

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

What it touches

• hookthird-party callbacksapply_filters()one call below wp_get_themes()
• transienttransientget_site_transient()one call below wp_get_themes()
• optionoption read or writeget_option()one call below wp_get_themes()

Further down the call graph this can also reach cache, serialize 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 · 12 distinct outcomes

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

Uses · 9

• wp_parse_args()Merges user defined arguments into defaults array.
• search_theme_directories()Searches all registered theme directories for complete and valid themes.
• get_stylesheet()Retrieves name of the current stylesheet.
• get_raw_theme_root()Gets the raw theme root relative to the content directory with no filters applied.
• is_multisite()Determines whether Multisite is enabled.
• WP_Theme::get_allowed_on_network()Returns array of stylesheet names of themes allowed on the network.
• WP_Theme::get_allowed_on_site()Returns array of stylesheet names of themes allowed on the site.
• WP_Theme::get_allowed()Returns array of stylesheet names of themes allowed on the site or network.
• WP_Theme::__construct()Constructor for WP_Theme.

Used by · 16

• Theme_Installer_Skin::do_overwrite()Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
• WP_Customize_Manager::handle_load_themes_request()Loads themes into the theme browsing/installation UI.
• WP_Debug_Data::get_wp_themes_inactive()Gets the WordPress inactive themes section of the debug data.
• WP_MS_Themes_List_Table::prepare_items()
• WP_REST_Themes_Controller::get_items()Retrieves a collection of themes.
• WP_Site_Health::get_test_theme_version()Tests if themes are outdated, or unnecessary.
• WP_Theme::get_allowed_on_site()Returns array of stylesheet names of themes allowed on the site.
• WP_Themes_List_Table::prepare_items()
• get_allowed_themes()Get the allowed themes for the current site.
• get_broken_themes()Retrieves a list of broken themes.
• get_themes()Retrieve list of themes with theme data in theme directory.
• upgrade_network()Executes network-level upgrade routines.

Source code

View on Trac ↗View on GitHub ↗

35function wp_get_themes( $args = array() ) {36	global $wp_theme_directories;37 38	$defaults = array(39		'errors'  => false,40		'allowed' => null,41		'blog_id' => 0,42	);43	$args     = wp_parse_args( $args, $defaults );44 45	$theme_directories = search_theme_directories();46 47	if ( is_array( $wp_theme_directories ) && count( $wp_theme_directories ) > 1 ) {48		/*49		 * Make sure the active theme wins out, in case search_theme_directories() picks the wrong50		 * one in the case of a conflict. (Normally, last registered theme root wins.)51		 */52		$current_theme = get_stylesheet();53		if ( isset( $theme_directories[ $current_theme ] ) ) {54			$root_of_current_theme = get_raw_theme_root( $current_theme );55			if ( ! in_array( $root_of_current_theme, $wp_theme_directories, true ) ) {56				$root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme;57			}58			$theme_directories[ $current_theme ]['theme_root'] = $root_of_current_theme;59		}60	}61 62	if ( empty( $theme_directories ) ) {63		return array();64	}65 66	if ( is_multisite() && null !== $args['allowed'] ) {67		$allowed = $args['allowed'];68		if ( 'network' === $allowed ) {69			$theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_network() );70		} elseif ( 'site' === $allowed ) {71			$theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed_on_site( $args['blog_id'] ) );72		} elseif ( $allowed ) {73			$theme_directories = array_intersect_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );74		} else {75			$theme_directories = array_diff_key( $theme_directories, WP_Theme::get_allowed( $args['blog_id'] ) );76		}77	}78 79	$themes         = array();80	static $_themes = array();81 82	foreach ( $theme_directories as $theme => $theme_root ) {83		if ( isset( $_themes[ $theme_root['theme_root'] . '/' . $theme ] ) ) {84			$themes[ $theme ] = $_themes[ $theme_root['theme_root'] . '/' . $theme ];85		} else {86			$themes[ $theme ] = new WP_Theme( $theme, $theme_root['theme_root'] );87 88			$_themes[ $theme_root['theme_root'] . '/' . $theme ] = $themes[ $theme ];89		}90	}91 92	if ( null !== $args['errors'] ) {93		foreach ( $themes as $theme => $wp_theme ) {94			if ( (bool) $wp_theme->errors() !== $args['errors'] ) {95				unset( $themes[ $theme ] );96			}97		}98	}99 100	return $themes;101}

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/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.