WP_REST_Application_Passwords_Controller
- Since
- 5.6.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.php:17
Core class to access a user's application passwords via the REST API.
Compatibility
- WordPress
- since 5.6.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Hooks and filters fired · 4
Every hook that fires from inside WP_REST_Application_Passwords_Controller, in the order it appears in the class, grouped by the method that fires it.
WP_REST_Application_Passwords_Controller::create_item()
- do_action( rest_after_insert_application_password )action line 273
WP_REST_Application_Passwords_Controller::update_item()
- do_action( rest_after_insert_application_password )action line 352
Methods · 24
- __construct()Application Passwords controller constructor.
- register_routes()Registers the REST API routes for the application passwords controller.
- get_items_permissions_check()Checks if a given request has access to get application passwords.
- get_items()Retrieves a collection of application passwords.
- get_item_permissions_check()Checks if a given request has access to get a specific application password.
- get_item()Retrieves one application password from the collection.
- create_item_permissions_check()Checks if a given request has access to create application passwords.
- create_item()Creates an application password.
- update_item_permissions_check()Checks if a given request has access to update application passwords.
- update_item()Updates an application password.
- delete_items_permissions_check()Checks if a given request has access to delete all application passwords for a user.
- delete_items()Deletes all application passwords for a user.
- delete_item_permissions_check()Checks if a given request has access to delete a specific application password for a user.
- delete_item()Deletes an application password for a user.
- get_current_item_permissions_check()Checks if a given request has access to get the currently used application password for a user.
- get_current_item()Retrieves the application password being currently used for authentication of a user.
- do_permissions_check()Performs a permissions check for the request.
- prepare_item_for_database()Prepares an application password for a create or update operation.
- prepare_item_for_response()Prepares the application password for the REST response.
- prepare_links()Prepares links for the request.
- get_user()Gets the requested user.
- get_application_password()Gets the requested application password for a user.
- get_collection_params()Retrieves the query params for the collections.
- get_item_schema()Retrieves the application password's schema, conforming to JSON Schema.
Source code
class WP_REST_Application_Passwords_Controller extends WP_REST_Controller { /** * Application Passwords controller constructor. * * @since 5.6.0 */ public function __construct() { $this->namespace = 'wp/v2'; $this->rest_base = 'users/(?P<user_id>(?:[\d]+|me))/application-passwords'; } /** * Registers the REST API routes for the application passwords controller. * * @since 5.6.0 */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base, array( array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_items' ), 'permission_callback' => array( $this, 'get_items_permissions_check' ), 'args' => $this->get_collection_params(), ), array( 'methods' => WP_REST_Server::CREATABLE, 'callback' => array( $this, 'create_item' ), 'permission_callback' => array( $this, 'create_item_permissions_check' ), 'args' => $this->get_endpoint_args_for_item_schema(), ), array( 'methods' => WP_REST_Server::DELETABLE, 'callback' => array( $this, 'delete_items' ), 'permission_callback' => array( $this, 'delete_items_permissions_check' ), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/introspect', array( array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_current_item' ), 'permission_callback' => array( $this, 'get_current_item_permissions_check' ), 'args' => array( 'context' => $this->get_context_param( array( 'default' => 'view' ) ), ), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<uuid>[\w\-]+)', array( array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_item_permissions_check' ), 'args' => array( 'context' => $this->get_context_param( array( 'default' => 'view' ) ), ), ), array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'update_item' ), 'permission_callback' => array( $this, 'update_item_permissions_check' ), 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), ), array( 'methods' => WP_REST_Server::DELETABLE, 'callback' => array( $this, 'delete_item' ),Changelog
Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.