WP_REST_User_Meta_Fields WordPress Class
This class allows developers to add extra fields to the WordPress user meta data table. This can be useful for storing extra data about a user that is not covered by the default WordPress user fields.
WP_REST_User_Meta_Fields #
Core class used to manage meta values for users via the REST API.
Description
See also
Source
File: wp-includes/rest-api/fields/class-wp-rest-user-meta-fields.php
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';
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Methods
- get_meta_subtype— Retrieves the user meta subtype.
- get_meta_type— Retrieves the user meta type.
- get_rest_field_type— Retrieves the type for register_rest_field().
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |