BP_REST_Document_Endpoint::get_endpoint_args_for_item_schema( string $method = WP_REST_Server::CREATABLE )
Select the item schema arguments needed for the CREATABLE methods.
Description
Parameters
- $method
-
(Optional) HTTP method of the request.
Default value: WP_REST_Server::CREATABLE
Return
(array) Endpoint arguments.
Source
File: bp-document/classes/class-bp-rest-document-endpoint.php
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
$args = array();
$key = 'create';
if ( WP_REST_Server::CREATABLE === $method ) {
$args['document_ids'] = array(
'description' => __( 'Document specific IDs.', 'buddyboss' ),
'default' => array(),
'type' => 'array',
'required' => true,
'items' => array( 'type' => 'integer' ),
'sanitize_callback' => 'wp_parse_id_list',
'validate_callback' => 'rest_validate_request_arg',
);
$args['activity_id'] = array(
'description' => __( 'A unique numeric ID for the activity.', 'buddyboss' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
$args['content'] = array(
'description' => __( 'Document Content.', 'buddyboss' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
}
if ( WP_REST_Server::EDITABLE === $method ) {
$key = 'edit';
$args['id'] = array(
'description' => __( 'A unique numeric ID for the document.', 'buddyboss' ),
'type' => 'integer',
'required' => true,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
}
$args['group_id'] = array(
'description' => __( 'A unique numeric ID for the Group.', 'buddyboss' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
$args['folder_id'] = array(
'description' => __( 'A unique numeric ID for the Document Folder.', 'buddyboss' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
$args['privacy'] = array(
'description' => __( 'Privacy of the document.', 'buddyboss' ),
'type' => 'string',
'enum' => array( 'public', 'loggedin', 'friends', 'onlyme', 'grouponly' ),
'default' => 'public',
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
/**
* Filters the method query arguments.
*
* @param array $args Query arguments.
* @param string $method HTTP method of the request.
*
* @since 0.1.0
*/
return apply_filters( "bp_rest_document_{$key}_query_arguments", $args, $method );
}
Changelog
| Version | Description |
|---|---|
| 0.1.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.