WP_REST_URL_Details_Controller::get_description()privateWP 5.9.0

Parses the meta description from the provided HTML.

{} It's a method of the class: WP_REST_URL_Details_Controller{}

No Hooks.

Return

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

Usage

// private - for code of main (parent) class only
$result = $this->get_description( $meta_elements );
$meta_elements(array) (required)

A multi-dimensional 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.

Changelog

Since 5.9.0 Introduced.

Code of WP_REST_URL_Details_Controller::get_description() WP 6.0

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 );
}