类文档

WP_REST_User_Meta_Fields

💡 云策文档标注

概述

WP_REST_User_Meta_Fields 是 WordPress 核心类,用于通过 REST API 管理用户元数据。它继承自 WP_REST_Meta_Fields,专门处理用户对象的元数据操作。

关键要点

  • 继承自 WP_REST_Meta_Fields,提供用户元数据管理的特定实现。
  • 包含三个核心方法:get_meta_type() 返回 'user',get_meta_subtype() 返回 'user'(无子类型),get_rest_field_type() 返回 'user'。
  • 自 WordPress 4.7.0 版本引入,用于支持 REST API 中的用户元数据字段注册和操作。

代码示例

class WP_REST_User_Meta_Fields extends WP_REST_Meta_Fields {
    protected function get_meta_type() {
        return 'user';
    }
    protected function get_meta_subtype() {
        return 'user';
    }
    public function get_rest_field_type() {
        return 'user';
    }
}

📄 原文内容

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

Description

See also

Methods

Name Description
WP_REST_User_Meta_Fields::get_meta_subtype Retrieves the user meta subtype.
WP_REST_User_Meta_Fields::get_meta_type Retrieves the user meta type.
WP_REST_User_Meta_Fields::get_rest_field_type Retrieves 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

Version Description
4.7.0 Introduced.