PHP Класс WP_REST_Meta_Fields, wordpress

С версии: 4.7.0
Показать файл Открыть проект

Открытые методы

Метод Описание
get_field_schema ( ) : array Retrieves the object's meta schema, conforming to JSON Schema.
get_value ( integer $object_id, WP_REST_Request $request ) : WP_Error | object Retrieves the meta field value.
prepare_value ( mixed $value, WP_REST_Request $request, array $args ) : mixed Prepares a meta value for output.
register_field ( ) Registers the meta field.
update_value ( WP_REST_Request $request, integer $object_id ) : WP_Error | null Updates meta values.

Защищенные методы

Метод Описание
delete_meta_value ( integer $object_id, string $meta_key, string $name ) : boolean | WP_Error Deletes a meta value for an object.
get_meta_type ( ) : string Retrieves the object meta type.
get_registered_fields ( ) : array Retrieves all the registered meta fields.
get_rest_field_type ( ) : string Retrieves the object type for register_rest_field().
prepare_value_for_response ( mixed $value, WP_REST_Request $request, array $args ) : mixed Prepares a meta value for a response.
update_meta_value ( integer $object_id, string $meta_key, string $name, mixed $value ) : boolean | WP_Error Updates a meta value for an object.
update_multi_meta_value ( integer $object_id, string $meta_key, string $name, array $values ) : boolean | WP_Error Updates multiple meta values for an object.

Описание методов

delete_meta_value() защищенный Метод

Deletes a meta value for an object.
С версии: 4.7.0
protected delete_meta_value ( integer $object_id, string $meta_key, string $name ) : boolean | WP_Error
$object_id integer Object ID the field belongs to.
$meta_key string Key for the field.
$name string Name for the field that is exposed in the REST API.
Результат boolean | WP_Error True if meta field is deleted, WP_Error otherwise.

get_field_schema() публичный Метод

Retrieves the object's meta schema, conforming to JSON Schema.
С версии: 4.7.0
public get_field_schema ( ) : array
Результат array Field schema data.

get_meta_type() абстрактный защищенный Метод

Retrieves the object meta type.
С версии: 4.7.0
abstract protected get_meta_type ( ) : string
Результат string One of 'post', 'comment', 'term', 'user', or anything else supported by `_get_meta_table()`.

get_registered_fields() защищенный Метод

Retrieves all the registered meta fields.
С версии: 4.7.0
protected get_registered_fields ( ) : array
Результат array Registered fields.

get_rest_field_type() абстрактный защищенный Метод

Retrieves the object type for register_rest_field().
С версии: 4.7.0
abstract protected get_rest_field_type ( ) : string
Результат string The REST field type, such as post type name, taxonomy name, 'comment', or `user`.

get_value() публичный Метод

Retrieves the meta field value.
С версии: 4.7.0
public get_value ( integer $object_id, WP_REST_Request $request ) : WP_Error | object
$object_id integer Object ID to fetch meta for.
$request WP_REST_Request Full details about the request.
Результат WP_Error | object Object containing the meta values by name, otherwise WP_Error object.

prepare_value() публичный статический Метод

Default preparation for meta fields. Override by passing the prepare_callback in your show_in_rest options.
С версии: 4.7.0
public static prepare_value ( mixed $value, WP_REST_Request $request, array $args ) : mixed
$value mixed Meta value from the database.
$request WP_REST_Request Request object.
$args array REST-specific options for the meta key.
Результат mixed Value prepared for output. If a non-JsonSerializable object, null.

prepare_value_for_response() защищенный Метод

This is required because some native types cannot be stored correctly in the database, such as booleans. We need to cast back to the relevant type before passing back to JSON.
С версии: 4.7.0
protected prepare_value_for_response ( mixed $value, WP_REST_Request $request, array $args ) : mixed
$value mixed Meta value to prepare.
$request WP_REST_Request Current request object.
$args array Options for the field.
Результат mixed Prepared value.

register_field() публичный Метод

Registers the meta field.
См. также: register_rest_field()
С версии: 4.7.0
public register_field ( )

update_meta_value() защищенный Метод

Updates a meta value for an object.
С версии: 4.7.0
protected update_meta_value ( integer $object_id, string $meta_key, string $name, mixed $value ) : boolean | WP_Error
$object_id integer Object ID to update.
$meta_key string Key for the custom field.
$name string Name for the field that is exposed in the REST API.
$value mixed Updated value.
Результат boolean | WP_Error True if the meta field was updated, WP_Error otherwise.

update_multi_meta_value() защищенный Метод

Alters the list of values in the database to match the list of provided values.
С версии: 4.7.0
protected update_multi_meta_value ( integer $object_id, string $meta_key, string $name, array $values ) : boolean | WP_Error
$object_id integer Object ID to update.
$meta_key string Key for the custom field.
$name string Name for the field that is exposed in the REST API.
$values array List of values to update to.
Результат boolean | WP_Error True if meta fields are updated, WP_Error otherwise.

update_value() публичный Метод

Updates meta values.
С версии: 4.7.0
public update_value ( WP_REST_Request $request, integer $object_id ) : WP_Error | null
$request WP_REST_Request Full details about the request.
$object_id integer Object ID to fetch meta for.
Результат WP_Error | null WP_Error if one occurs, null on success.