PHP Class WC_REST_Controller

Author: WooThemes
Inheritance: extends WP_REST_Controller
Afficher le fichier Open project: woocommerce/woocommerce Class Usage Examples

Protected Properties

Свойство Type Description
$namespace string Endpoint namespace.
$rest_base string Route base.

Méthodes publiques

Méthode Description
batch_items ( WP_REST_Request $request ) : array Bulk create, update and delete items.
get_public_batch_schema ( ) : array Get the batch schema, conforming to JSON Schema.
validate_setting_checkbox_field ( string $value, array $setting ) : string | WP_Error Validate checkbox based settings.
validate_setting_image_width_field ( $values, array $setting ) : string | WP_Error Validate image_width based settings.
validate_setting_multiselect_field ( array $values, array $setting ) : string | WP_Error Validate multiselect based settings.
validate_setting_radio_field ( string $value, array $setting ) : string | WP_Error Validate radio based settings.
validate_setting_select_field ( string $value, array $setting ) : string | WP_Error Validate select based settings.
validate_setting_text_field ( string $value, array $setting ) : string Validate a text value for a text based setting.
validate_setting_textarea_field ( string $value, array $setting ) : string Validate textarea based settings.

Méthodes protégées

Méthode Description
add_additional_fields_schema ( array $schema ) Add the schema from additional fields to an schema array.
add_meta_query ( array $args, array $meta_query ) : array Add meta query.
check_batch_limit ( array $items ) : boolean | WP_Error Check batch limit.
get_normalized_rest_base ( ) : string Get normalized rest base.

Method Details

add_additional_fields_schema() protected méthode

The type of object is inferred from the passed schema.
protected add_additional_fields_schema ( array $schema )
$schema array Schema array.

add_meta_query() protected méthode

Add meta query.
Since: 2.7.0
protected add_meta_query ( array $args, array $meta_query ) : array
$args array Query args.
$meta_query array Meta query.
Résultat array

batch_items() public méthode

Bulk create, update and delete items.
public batch_items ( WP_REST_Request $request ) : array
$request WP_REST_Request Full details about the request.
Résultat array Of WP_Error or WP_REST_Response.

check_batch_limit() protected méthode

Check batch limit.
protected check_batch_limit ( array $items ) : boolean | WP_Error
$items array Request items.
Résultat boolean | WP_Error

get_normalized_rest_base() protected méthode

Get normalized rest base.
protected get_normalized_rest_base ( ) : string
Résultat string

get_public_batch_schema() public méthode

Get the batch schema, conforming to JSON Schema.
public get_public_batch_schema ( ) : array
Résultat array

validate_setting_checkbox_field() public méthode

Validate checkbox based settings.
Since: 2.7.0
public validate_setting_checkbox_field ( string $value, array $setting ) : string | WP_Error
$value string
$setting array
Résultat string | WP_Error

validate_setting_image_width_field() public méthode

Validate image_width based settings.
Since: 2.7.0
public validate_setting_image_width_field ( $values, array $setting ) : string | WP_Error
$setting array
Résultat string | WP_Error

validate_setting_multiselect_field() public méthode

Validate multiselect based settings.
Since: 2.7.0
public validate_setting_multiselect_field ( array $values, array $setting ) : string | WP_Error
$values array
$setting array
Résultat string | WP_Error

validate_setting_radio_field() public méthode

Validate radio based settings.
Since: 2.7.0
public validate_setting_radio_field ( string $value, array $setting ) : string | WP_Error
$value string
$setting array
Résultat string | WP_Error

validate_setting_select_field() public méthode

Validate select based settings.
Since: 2.7.0
public validate_setting_select_field ( string $value, array $setting ) : string | WP_Error
$value string
$setting array
Résultat string | WP_Error

validate_setting_text_field() public méthode

Validate a text value for a text based setting.
Since: 2.7.0
public validate_setting_text_field ( string $value, array $setting ) : string
$value string
$setting array
Résultat string

validate_setting_textarea_field() public méthode

Validate textarea based settings.
Since: 2.7.0
public validate_setting_textarea_field ( string $value, array $setting ) : string
$value string
$setting array
Résultat string

Property Details

$namespace protected_oe property

Endpoint namespace.
protected string $namespace
Résultat string

$rest_base protected_oe property

Route base.
protected string $rest_base
Résultat string