ClassicPress logo
Skip to content
Filter by type:

Browse:

  • Home
  • Classes
  • WP_REST_Post_Meta_Fields

WP_REST_Post_Meta_Fields

Core class used to manage meta values for posts via the REST API.


Description

See also

  • WP_REST_Meta_Fields


Source

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

class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {

	/**
	 * Post type to register fields for.
	 *
	 * @since WP-4.7.0
	 * @var string
	 */
	protected $post_type;

	/**
	 * Constructor.
	 *
	 * @since WP-4.7.0
	 *
	 * @param string $post_type Post type to register fields for.
	 */
	public function __construct( $post_type ) {
		$this->post_type = $post_type;
	}

	/**
	 * Retrieves the object meta type.
	 *
	 * @since WP-4.7.0
	 *
	 * @return string The meta type.
	 */
	protected function get_meta_type() {
		return 'post';
	}

	/**
	 * Retrieves the object meta subtype.
	 *
	 * @since WP-4.9.8
	 *
	 * @return string Subtype for the meta type, or empty string if no specific subtype.
	 */
	protected function get_meta_subtype() {
		return $this->post_type;
	}

	/**
	 * Retrieves the type for register_rest_field().
	 *
	 * @since WP-4.7.0
	 *
	 * @see register_rest_field()
	 *
	 * @return string The REST field type.
	 */
	public function get_rest_field_type() {
		return $this->post_type;
	}
}

Expand Source Code View on GitHub


Related

Uses

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

Core class to manage meta values for an object via the REST API.


Methods

  • __construct — Constructor.
  • get_meta_subtype — Retrieves the post meta subtype.
  • get_meta_type — Retrieves the post meta type.
  • get_rest_field_type — Retrieves the type for register_rest_field().

Changelog

Changelog
Version Description
4.7.0 Introduced.
ClassicPress Documentation • Made with ClassicPress
Privacy Policy