W3cubDocs

/WordPress

WP_REST_Meta_Fields::get_value( int $object_id, WP_REST_Request $request )

Retrieves the meta field value.

Parameters

$object_id

(int) (Required) Object ID to fetch meta for.

$request

(WP_REST_Request) (Required) Full details about the request.

Return

(array) Array containing the meta values keyed by name.

Source

File: wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 

public function get_value( $object_id, $request ) {
		$fields   = $this->get_registered_fields();
		$response = array();

		foreach ( $fields as $meta_key => $args ) {
			$name       = $args['name'];
			$all_values = get_metadata( $this->get_meta_type(), $object_id, $meta_key, false );

			if ( $args['single'] ) {
				if ( empty( $all_values ) ) {
					$value = $args['schema']['default'];
				} else {
					$value = $all_values[0];
				}

				$value = $this->prepare_value_for_response( $value, $request, $args );
			} else {
				$value = array();

				foreach ( $all_values as $row ) {
					$value[] = $this->prepare_value_for_response( $row, $request, $args );
				}
			}

			$response[ $name ] = $value;
		}

		return $response;
	}

Uses

Uses Description
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::get_registered_fields()

Retrieves all the registered meta fields.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::prepare_value_for_response()

Prepares a meta value for a response.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::get_meta_type()

Retrieves the object meta type.
wp-includes/meta.php: get_metadata()

Retrieves the value of a metadata field for the specified object type and ID.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_meta_fields/get_value