Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docblock CS

This commit is contained in:
Mike Jolley 2019-06-13 16:28:07 +01:00
parent d54bb381c0
commit 989a9978e2
2 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Controllers/Version4/AbstractObjectsController.php
View File

@ -389,7 +389,7 @@ abstract class AbstractObjectsController extends AbstractController {
* Get a collection of posts.
*
* @param \WP_REST_Request $request Full details about the request.
* @return \WP_Error|\WP_REST_Response
* @return \WP_REST_Response
*/
public function get_items( $request ) {
$query_args = $this->prepare_objects_query( $request );

25
src/Controllers/Version4/OrderNotes.php
View File

@ -54,13 +54,16 @@ class OrderNotes extends AbstractController {
'methods' => \WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => array_merge( $this->get_endpoint_args_for_item_schema( \WP_REST_Server::CREATABLE ), array(
'note' => array(
'type' => 'string',
'description' => __( 'Order note content.', 'woocommerce' ),
'required' => true,
),
) ),
'args' => array_merge(
$this->get_endpoint_args_for_item_schema( \WP_REST_Server::CREATABLE ),
array(
'note' => array(
'type' => 'string',
'description' => __( 'Order note content.', 'woocommerce' ),
'required' => true,
),
)
),
),
'schema' => array( $this, 'get_public_item_schema' ),
),
@ -254,7 +257,7 @@ class OrderNotes extends AbstractController {
/**
* Fires after a order note is created or updated via the REST API.
*
* @param WP_Comment $note New order note object.
* @param \WP_Comment $note New order note object.
* @param \WP_REST_Request $request Request object.
* @param boolean $creating True when creating item, false when updating.
*/
@ -341,7 +344,7 @@ class OrderNotes extends AbstractController {
/**
* Fires after a order note is deleted or trashed via the REST API.
*
* @param WP_Comment $note The deleted or trashed order note.
* @param \WP_Comment $note The deleted or trashed order note.
* @param \WP_REST_Response $response The response data.
* @param \WP_REST_Request $request The request sent to the API.
*/
@ -353,7 +356,7 @@ class OrderNotes extends AbstractController {
/**
* Prepare a single order note output for response.
*
* @param WP_Comment $note Order note object.
* @param \WP_Comment $note Order note object.
* @param \WP_REST_Request $request Request object.
* @return \WP_REST_Response $response Response data.
*/
@ -380,7 +383,7 @@ class OrderNotes extends AbstractController {
* Filter order note object returned from the REST API.
*
* @param \WP_REST_Response $response The response object.
* @param WP_Comment $note Order note object used to create response.
* @param \WP_Comment $note Order note object used to create response.
* @param \WP_REST_Request $request Request object.
*/
return apply_filters( 'woocommerce_rest_prepare_order_note', $response, $note, $request );