WP_REST_URL_Details_Controller::get_image( array $meta_elements, string $url ): string

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.

Parses the Open Graph (OG) Image from the provided HTML.

Description

See: https://ogp.me/.

Parameters

$meta_elementsarrayrequired
A multi-dimensional indexed array on success, else empty array.
  • string[]
    Meta elements with a content attribute.
  • 1 string[]
    Content attribute’s opening quotation mark.
  • 2 string[]
    Content attribute’s value for each meta element.
$urlstringrequired
The target website URL.

Return

string The OG image on success. Empty string if not found.

Source

private function get_image( $meta_elements, $url ) {
	$image = $this->get_metadata_from_meta_element(
		$meta_elements,
		'property',
		'(?:og:image|og:image:url)'
	);

	// Bail out if image not found.
	if ( '' === $image ) {
		return '';
	}

	// Attempt to convert relative URLs to absolute.
	$parsed_url = parse_url( $url );
	if ( isset( $parsed_url['scheme'] ) && isset( $parsed_url['host'] ) ) {
		$root_url = $parsed_url['scheme'] . '://' . $parsed_url['host'] . '/';
		$image    = WP_Http::make_absolute_url( $image, $root_url );
	}

	return $image;
}

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

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