WP_REST_Themes_Controller::prepare_item_for_response( WP_Theme $item, WP_REST_Request $request ): WP_REST_Response

Prepares a single theme output for response.


Parameters

$item WP_Theme Required
Theme object.
$request WP_REST_Request Required
Request object.

Top ↑

Return

WP_REST_Response Response object.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php. View all references

public function prepare_item_for_response( $item, $request ) {
	// Restores the more descriptive, specific name for use within this method.
	$theme  = $item;
	$data   = array();
	$fields = $this->get_fields_for_response( $request );

	if ( rest_is_field_included( 'stylesheet', $fields ) ) {
		$data['stylesheet'] = $theme->get_stylesheet();
	}

	if ( rest_is_field_included( 'template', $fields ) ) {
		/**
		 * Use the get_template() method, not the 'Template' header, for finding the template.
		 * The 'Template' header is only good for what was written in the style.css, while
		 * get_template() takes into account where WordPress actually located the theme and
		 * whether it is actually valid.
		 */
		$data['template'] = $theme->get_template();
	}

	$plain_field_mappings = array(
		'requires_php' => 'RequiresPHP',
		'requires_wp'  => 'RequiresWP',
		'textdomain'   => 'TextDomain',
		'version'      => 'Version',
	);

	foreach ( $plain_field_mappings as $field => $header ) {
		if ( rest_is_field_included( $field, $fields ) ) {
			$data[ $field ] = $theme->get( $header );
		}
	}

	if ( rest_is_field_included( 'screenshot', $fields ) ) {
		// Using $theme->get_screenshot() with no args to get absolute URL.
		$data['screenshot'] = $theme->get_screenshot() ? $theme->get_screenshot() : '';
	}

	$rich_field_mappings = array(
		'author'      => 'Author',
		'author_uri'  => 'AuthorURI',
		'description' => 'Description',
		'name'        => 'Name',
		'tags'        => 'Tags',
		'theme_uri'   => 'ThemeURI',
	);

	foreach ( $rich_field_mappings as $field => $header ) {
		if ( rest_is_field_included( "{$field}.raw", $fields ) ) {
			$data[ $field ]['raw'] = $theme->display( $header, false, true );
		}

		if ( rest_is_field_included( "{$field}.rendered", $fields ) ) {
			$data[ $field ]['rendered'] = $theme->display( $header );
		}
	}

	$current_theme = wp_get_theme();
	if ( rest_is_field_included( 'status', $fields ) ) {
		$data['status'] = ( $this->is_same_theme( $theme, $current_theme ) ) ? 'active' : 'inactive';
	}

	if ( rest_is_field_included( 'theme_supports', $fields ) && $this->is_same_theme( $theme, $current_theme ) ) {
		foreach ( get_registered_theme_features() as $feature => $config ) {
			if ( ! is_array( $config['show_in_rest'] ) ) {
				continue;
			}

			$name = $config['show_in_rest']['name'];

			if ( ! rest_is_field_included( "theme_supports.{$name}", $fields ) ) {
				continue;
			}

			if ( ! current_theme_supports( $feature ) ) {
				$data['theme_supports'][ $name ] = $config['show_in_rest']['schema']['default'];
				continue;
			}

			$support = get_theme_support( $feature );

			if ( isset( $config['show_in_rest']['prepare_callback'] ) ) {
				$prepare = $config['show_in_rest']['prepare_callback'];
			} else {
				$prepare = array( $this, 'prepare_theme_support' );
			}

			$prepared = $prepare( $support, $config, $feature, $request );

			if ( is_wp_error( $prepared ) ) {
				continue;
			}

			$data['theme_supports'][ $name ] = $prepared;
		}
	}

	$data = $this->add_additional_fields_to_object( $data, $request );

	// Wrap the data in a response object.
	$response = rest_ensure_response( $data );

	$response->add_links( $this->prepare_links( $theme ) );

	if ( $theme->get_stylesheet() === wp_get_theme()->get_stylesheet() ) {
		// This creates a record for the active theme if not existent.
		$id = WP_Theme_JSON_Resolver::get_user_global_styles_post_id();
	} else {
		$user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
		$id       = isset( $user_cpt['ID'] ) ? $user_cpt['ID'] : null;
	}

	if ( $id ) {
		$response->add_link(
			'https://api.w.org/user-global-styles',
			rest_url( 'wp/v2/global-styles/' . $id )
		);
	}

	/**
	 * Filters theme data returned from the REST API.
	 *
	 * @since 5.0.0
	 *
	 * @param WP_REST_Response $response The response object.
	 * @param WP_Theme         $theme    Theme object used to create response.
	 * @param WP_REST_Request  $request  Request object.
	 */
	return apply_filters( 'rest_prepare_theme', $response, $theme, $request );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
5.9.0 Renamed $theme to $item to match parent class for PHP 8 named parameter support.
5.0.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.