BP_REST_Members_Endpoint::get_endpoint_args_for_item_schema( string $method = WP_REST_Server::CREATABLE )
Make sure to retrieve the needed arguments for the endpoint CREATABLE method.
Parameters Parameters
- $method
-
(string) (Optional) HTTP method of the request.
Default value: WP_REST_Server::CREATABLE
Return Return
(array) Endpoint arguments.
Source Source
File: bp-members/classes/class-bp-rest-members-endpoint.php
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) { $args = parent::get_endpoint_args_for_item_schema( $method ); $key = 'get_item'; // Add member type args. $member_type_args = array( 'description' => __( 'Assign a member type to a member, use a comma separated list of member types to assign more than one.', 'buddypress' ), 'type' => 'string', 'enum' => bp_get_member_types(), 'context' => array( 'edit' ), 'sanitize_callback' => 'bp_rest_sanitize_member_types', 'validate_callback' => 'bp_rest_sanitize_member_types', ); if ( WP_REST_Server::CREATABLE === $method ) { $key = 'create_item'; // We don't need the mention name to create a user. unset( $args['mention_name'] ); // Add member type args. $args['member_type'] = $member_type_args; // But we absolutely need the email. $args['email'] = array( 'description' => __( 'The email address for the member.', 'buddypress' ), 'type' => 'string', 'format' => 'email', 'context' => array( 'edit' ), 'required' => true, ); } elseif ( WP_REST_Server::EDITABLE === $method ) { $key = 'update_item'; /** * 1. The mention name or user login are not updatable. * 2. The password belongs to the Settings endpoint parameter. */ unset( $args['mention_name'], $args['user_login'], $args['password'] ); // Add member type args. $args['member_type'] = $member_type_args; } elseif ( WP_REST_Server::DELETABLE === $method ) { $key = 'delete_item'; } /** * Filters the method query arguments. * * @since 5.0.0 * * @param array $args Query arguments. * @param string $method HTTP method of the request. */ return apply_filters( "bp_rest_members_{$key}_query_arguments", $args, $method ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |