| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
REST API: WP_REST_Application_Passwords_Controller class
| File Size: | 836 lines (24 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_REST_Application_Passwords_Controller:: (24 methods):
__construct()
register_routes()
get_items_permissions_check()
get_items()
get_item_permissions_check()
get_item()
create_item_permissions_check()
create_item()
update_item_permissions_check()
update_item()
delete_items_permissions_check()
delete_items()
delete_item_permissions_check()
delete_item()
get_current_item_permissions_check()
get_current_item()
do_permissions_check()
prepare_item_for_database()
prepare_item_for_response()
prepare_links()
get_user()
get_application_password()
get_collection_params()
get_item_schema()
Class: WP_REST_Application_Passwords_Controller - X-Ref
Core class to access a user's application passwords via the REST API.| __construct() X-Ref |
| Application Passwords controller constructor. since: 5.6.0 |
| register_routes() X-Ref |
| Registers the REST API routes for the application passwords controller. since: 5.6.0 |
| get_items_permissions_check( $request ) X-Ref |
| Checks if a given request has access to get application passwords. return: true|WP_Error True if the request has read access, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| get_items( $request ) X-Ref |
| Retrieves a collection of application passwords. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| get_item_permissions_check( $request ) X-Ref |
| Checks if a given request has access to get a specific application password. return: true|WP_Error True if the request has read access for the item, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| get_item( $request ) X-Ref |
| Retrieves one application password from the collection. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| create_item_permissions_check( $request ) X-Ref |
| Checks if a given request has access to create application passwords. return: true|WP_Error True if the request has access to create items, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| create_item( $request ) X-Ref |
| Creates an application password. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| update_item_permissions_check( $request ) X-Ref |
| Checks if a given request has access to update application passwords. return: true|WP_Error True if the request has access to create items, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| update_item( $request ) X-Ref |
| Updates an application password. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| delete_items_permissions_check( $request ) X-Ref |
| Checks if a given request has access to delete all application passwords for a user. return: true|WP_Error True if the request has access to delete the item, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| delete_items( $request ) X-Ref |
| Deletes all application passwords for a user. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| delete_item_permissions_check( $request ) X-Ref |
| Checks if a given request has access to delete a specific application password for a user. return: true|WP_Error True if the request has access to delete the item, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| delete_item( $request ) X-Ref |
| Deletes an application password for a user. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.6.0 |
| get_current_item_permissions_check( $request ) X-Ref |
| Checks if a given request has access to get the currently used application password for a user. return: true|WP_Error True if the request has read access for the item, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.7.0 |
| get_current_item( $request ) X-Ref |
| Retrieves the application password being currently used for authentication of a user. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.7.0 |
| do_permissions_check( $request ) X-Ref |
| Performs a permissions check for the request. return: true|WP_Error param: WP_REST_Request $request since: 5.6.0 |
| prepare_item_for_database( $request ) X-Ref |
| Prepares an application password for a create or update operation. return: object|WP_Error The prepared item, or WP_Error object on failure. param: WP_REST_Request $request Request object. since: 5.6.0 |
| prepare_item_for_response( $item, $request ) X-Ref |
| Prepares the application password for the REST response. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: array $item WordPress representation of the item. param: WP_REST_Request $request Request object. since: 5.6.0 |
| prepare_links( WP_User $user, $item ) X-Ref |
| Prepares links for the request. return: array The list of links. param: WP_User $user The requested user. param: array $item The application password. since: 5.6.0 |
| get_user( $request ) X-Ref |
| Gets the requested user. return: WP_User|WP_Error The WordPress user associated with the request, or a WP_Error if none found. param: WP_REST_Request $request The request object. since: 5.6.0 |
| get_application_password( $request ) X-Ref |
| Gets the requested application password for a user. return: array|WP_Error The application password details if found, a WP_Error otherwise. param: WP_REST_Request $request The request object. since: 5.6.0 |
| get_collection_params() X-Ref |
| Retrieves the query params for the collections. return: array Query parameters for the collection. since: 5.6.0 |
| get_item_schema() X-Ref |
| Retrieves the application password's schema, conforming to JSON Schema. return: array Item schema data. since: 5.6.0 |
| Generated: Thu Nov 21 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |