vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-07-01 15:50:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Improve documentation for WP_REST_Attachments_Controller.

Browse Source 
This adds a missing DocBlock for `::register_routes()` and parameter descriptions for `::post_process_item()`.

Includes minor documenation fixes in other REST API classes for consistency.

Props dkarfa, mukesh27, SergeyBiryukov.
Fixes #48841.

git-svn-id: https://develop.svn.wordpress.org/trunk@47391 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-02-28 12:29:53 +00:00
parent 697127203b
commit b54d5925ce
6 changed files with 34 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php
View File

@@ -42,6 +42,8 @@ abstract class WP_REST_Controller {
* Registers the routes for the objects of the controller.
*
* @since 4.7.0
*
* @see register_rest_route()
*/
public function register_routes() {
_doing_it_wrong(
@@ -57,7 +59,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
*/
public function get_items_permissions_check( $request ) {
@@ -74,7 +76,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function get_items( $request ) {
@@ -91,7 +93,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise.
*/
public function get_item_permissions_check( $request ) {
@@ -108,7 +110,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function get_item( $request ) {
@@ -125,7 +127,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to create items, WP_Error object otherwise.
*/
public function create_item_permissions_check( $request ) {
@@ -142,7 +144,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function create_item( $request ) {
@@ -159,7 +161,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
*/
public function update_item_permissions_check( $request ) {
@@ -176,7 +178,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function update_item( $request ) {
@@ -193,7 +195,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
*/
public function delete_item_permissions_check( $request ) {
@@ -210,7 +212,7 @@ abstract class WP_REST_Controller {
*
* @since 4.7.0
*
* @param WP_REST_Request $request Full data about the request.
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function delete_item( $request ) {