W3cubDocs

/WordPress

WP_REST_URL_Details_Controller::get_description( array $meta_elements ): string

Parses the meta description from the provided HTML.

Parameters

$meta_elementsarrayrequired
A multidimensional indexed array on success, else empty array.
  • 0 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

Version Description
5.9.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_url_details_controller/get_description