WP_REST_URL_Details_Controller::get_description( array $meta_elements ): string

In this article

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 meta description from the provided HTML.

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.

Return

string The meta description contents on success. Empty string if not found.

Source

private function get_description( $meta_elements ) {
	// Bail out if there are no meta elements.
	if ( empty( $meta_elements[0] ) ) {
		return '';
	}

	$description = $this->get_metadata_from_meta_element(
		$meta_elements,
		'name',
		'(?:description|og:description)'
	);

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

	return $this->prepare_metadata_for_output( $description );
}

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

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