WP_Site::get_details(): stdClass

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness. Use WP_Site::__get() instead.

Retrieves the details for this site.

Description

This method is used internally to lazy-load the extended properties of a site.

See also

Return

stdClass A raw site object with all details included.

Source

private function get_details() {
	$details = wp_cache_get( $this->blog_id, 'site-details' );

	if ( false === $details ) {

		switch_to_blog( $this->blog_id );
		// Create a raw copy of the object for backward compatibility with the filter below.
		$details = new stdClass();
		foreach ( get_object_vars( $this ) as $key => $value ) {
			$details->$key = $value;
		}
		$details->blogname   = get_option( 'blogname' );
		$details->siteurl    = get_option( 'siteurl' );
		$details->post_count = get_option( 'post_count' );
		$details->home       = get_option( 'home' );
		restore_current_blog();

		wp_cache_set( $this->blog_id, $details, 'site-details' );
	}

	/** This filter is documented in wp-includes/ms-blogs.php */
	$details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' );

	/**
	 * Filters a site's extended properties.
	 *
	 * @since 4.6.0
	 *
	 * @param stdClass $details The site details.
	 */
	$details = apply_filters( 'site_details', $details );

	return $details;
}

Hooks

apply_filters_deprecated( ‘blog_details’, WP_Site $details )

Filters a blog’s details.

apply_filters( ‘site_details’, stdClass $details )

Filters a site’s extended properties.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

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