class WP_REST_User_Meta_Fields {}

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

Description

See also

Methods

NameDescription
WP_REST_User_Meta_Fields::get_meta_subtypeRetrieves the user meta subtype.
WP_REST_User_Meta_Fields::get_meta_typeRetrieves the user meta type.
WP_REST_User_Meta_Fields::get_rest_field_typeRetrieves the type for register_rest_field() .

Source

class WP_REST_User_Meta_Fields extends WP_REST_Meta_Fields {

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

	/**
	 * Retrieves the user meta subtype.
	 *
	 * @since 4.9.8
	 *
	 * @return string 'user' There are no subtypes.
	 */
	protected function get_meta_subtype() {
		return 'user';
	}

	/**
	 * Retrieves the type for register_rest_field().
	 *
	 * @since 4.7.0
	 *
	 * @return string The user REST field type.
	 */
	public function get_rest_field_type() {
		return 'user';
	}
}

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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