wp_prepare_themes_for_js( WP_Theme[] $themes = null ): array

Parameters

$themesWP_Theme[]optional

Array of theme objects to prepare. Defaults to all allowed themes.Default: null

Return

array

An associative array of theme data, sorted by name.

Hooks fired · 2

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

1. 1
   apply_filters( pre_prepare_themes_for_js )filterline 666 (+15 into the body)

   Filters theme data before it is prepared for JavaScript.

2. 2
   apply_filters( wp_prepare_themes_for_js )filterline 816 (+165 into the body)

   Filters the themes prepared for JavaScript, for themes.php.

Uses · 23

• get_stylesheet()Retrieves name of the current stylesheet.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_themes()Returns an array of WP_Theme objects based on the arguments.
• wp_get_theme()Gets a WP_Theme object for a theme.
• is_multisite()Determines whether Multisite is enabled.
• current_user_can()Returns whether the current user has the specified capability.
• get_site_transient()Retrieves the value of a site transient.
• get_site_option()Retrieve an option value for the current network based on name of option.
• admin_url()Retrieves the URL to the admin area for the current site.
• add_query_arg()Retrieves a modified URL query string.
• wp_customize_url()Returns a URL to load the Customizer.
• sanitize_url()Sanitizes a URL for database or redirect usage.

Used by · 1

• WP_Customize_Manager::handle_load_themes_request()Loads themes into the theme browsing/installation UI.

Source

View on Trac ↗View on GitHub ↗

651function wp_prepare_themes_for_js( $themes = null ) {652	$current_theme = get_stylesheet();653 654	/**655	 * Filters theme data before it is prepared for JavaScript.656	 *657	 * Passing a non-empty array will result in wp_prepare_themes_for_js() returning658	 * early with that value instead.659	 *660	 * @since 4.2.0661	 *662	 * @param array           $prepared_themes An associative array of theme data. Default empty array.663	 * @param WP_Theme[]|null $themes          An array of theme objects to prepare, if any.664	 * @param string          $current_theme   The active theme slug.665	 */666	$prepared_themes = (array) apply_filters( 'pre_prepare_themes_for_js', array(), $themes, $current_theme );667 668	if ( ! empty( $prepared_themes ) ) {669		return $prepared_themes;670	}671 672	// Make sure the active theme is listed first.673	$prepared_themes[ $current_theme ] = array();674 675	if ( null === $themes ) {676		$themes = wp_get_themes( array( 'allowed' => true ) );677		if ( ! isset( $themes[ $current_theme ] ) ) {678			$themes[ $current_theme ] = wp_get_theme();679		}680	}681 682	$updates    = array();683	$no_updates = array();684	if ( ! is_multisite() && current_user_can( 'update_themes' ) ) {685		$updates_transient = get_site_transient( 'update_themes' );686		if ( isset( $updates_transient->response ) ) {687			$updates = $updates_transient->response;688		}689		if ( isset( $updates_transient->no_update ) ) {690			$no_updates = $updates_transient->no_update;691		}692	}693 694	WP_Theme::sort_by_name( $themes );695 696	$parents = array();697 698	$auto_updates = (array) get_site_option( 'auto_update_themes', array() );699 700	foreach ( $themes as $theme ) {701		$slug         = $theme->get_stylesheet();702		$encoded_slug = urlencode( $slug );703 704		$parent = false;705		if ( $theme->parent() ) {706			$parent           = $theme->parent();707			$parents[ $slug ] = $parent->get_stylesheet();708			$parent           = $parent->display( 'Name' );709		}710 711		$customize_action = null;712 713		$can_edit_theme_options = current_user_can( 'edit_theme_options' );714		$can_customize          = current_user_can( 'customize' );715		$is_block_theme         = $theme->is_block_theme();716 717		if ( $is_block_theme && $can_edit_theme_options ) {718			$customize_action = admin_url( 'site-editor.php' );719			if ( $current_theme !== $slug ) {720				$customize_action = add_query_arg( 'wp_theme_preview', $slug, $customize_action );721			}722		} elseif ( ! $is_block_theme && $can_customize && $can_edit_theme_options ) {723			$customize_action = wp_customize_url( $slug );724		}725		if ( null !== $customize_action ) {726			$customize_action = add_query_arg(727				array(728					'return' => urlencode( sanitize_url( remove_query_arg( wp_removable_query_args(), wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ),729				),730				$customize_action

History

Introduced in 3.8.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.9.7 tag, from src/wp-admin/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.