[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/rest-api/endpoints/ -> class-wp-rest-application-passwords-controller.php (summary)

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

Defines 1 class

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.

since: 5.6.0
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.

get_items( $request )   X-Ref
Retrieves a collection of application passwords.

since: 5.6.0
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.

get_item_permissions_check( $request )   X-Ref
Checks if a given request has access to get a specific application password.

since: 5.6.0
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.

get_item( $request )   X-Ref
Retrieves one application password from the collection.

since: 5.6.0
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.

create_item_permissions_check( $request )   X-Ref
Checks if a given request has access to create application passwords.

since: 5.6.0
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.

create_item( $request )   X-Ref
Creates an application password.

since: 5.6.0
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.

update_item_permissions_check( $request )   X-Ref
Checks if a given request has access to update application passwords.

since: 5.6.0
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.

update_item( $request )   X-Ref
Updates an application password.

since: 5.6.0
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.

delete_items_permissions_check( $request )   X-Ref
Checks if a given request has access to delete all application passwords.

since: 5.6.0
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.

delete_items( $request )   X-Ref
Deletes all application passwords.

since: 5.6.0
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.

delete_item_permissions_check( $request )   X-Ref
Checks if a given request has access to delete a specific application password.

since: 5.6.0
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.

delete_item( $request )   X-Ref
Deletes one application password.

since: 5.6.0
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.

get_current_item_permissions_check( $request )   X-Ref
Checks if a given request has access to get the currently used application password.

since: 5.7.0
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.

get_current_item( $request )   X-Ref
Retrieves the application password being currently used for authentication.

since: 5.7.0
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.

do_permissions_check( $request )   X-Ref
Performs a permissions check for the request.

since: 5.6.0
return: true|WP_Error
param: WP_REST_Request $request

prepare_item_for_database( $request )   X-Ref
Prepares an application password for a create or update operation.

since: 5.6.0
return: object|WP_Error The prepared item, or WP_Error object on failure.
param: WP_REST_Request $request Request object.

prepare_item_for_response( $item, $request )   X-Ref
Prepares the application password for the REST response.

since: 5.6.0
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.

prepare_links( WP_User $user, $item )   X-Ref
Prepares links for the request.

since: 5.6.0
return: array The list of links.
param: WP_User $user The requested user.
param: array   $item The application password.

get_user( $request )   X-Ref
Gets the requested user.

since: 5.6.0
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.

get_application_password( $request )   X-Ref
Gets the requested application password.

since: 5.6.0
return: array|WP_Error The application password details if found, a WP_Error otherwise.
param: WP_REST_Request $request The request object.

get_collection_params()   X-Ref
Retrieves the query params for the collections.

since: 5.6.0
return: array Query parameters for the collection.

get_item_schema()   X-Ref
Retrieves the application password's schema, conforming to JSON Schema.

since: 5.6.0
return: array Item schema data.



Generated: Tue Sep 28 01:00:02 2021 Cross-referenced by PHPXref 0.7.1