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

Fix PHP DocBlock for WC_CLI_Runner (#47599) 

* Fix PHP DocBlock for WC_CLI_Runner

Fixes #47598

* Update plugins/woocommerce/changelog/fix-fix-php-docblock-for-wc-cli-runner-register-route-commands-47598

* Update plugins/woocommerce/includes/cli/class-wc-cli-runner.php

Fix phpdoc linting errors 🙄

---------

Co-authored-by: Corey McKrill <916023+coreymckrill@users.noreply.github.com>
This commit is contained in:
Andrew Dawes 2024-05-20 18:45:02 -04:00 committed by GitHub
parent a9aa14e254
commit 42cb91ae3c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/fix-fix-php-docblock-for-wc-cli-runner-register-route-commands-47598 Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: fix
Updated the PHP DocBlock for WC_CLI_Runner::register_route_commands to correctly specify the first parameter's type as being a WC_CLI_REST_Command object rather than a string.

8
plugins/woocommerce/includes/cli/class-wc-cli-runner.php
View File

@ -98,10 +98,10 @@ class WC_CLI_Runner {
* Generates command information and tells WP CLI about all
* commands available from a route.
*
* @param string $rest_command WC-API command.
* @param string $route Path to route endpoint.
* @param array $route_data Command data.
* @param array $command_args WP-CLI command arguments.
* @param WC_CLI_REST_Command $rest_command WC-API command.
* @param string $route Path to route endpoint.
* @param array $route_data Command data.
* @param array $command_args WP-CLI command arguments.
*/
private static function register_route_commands( $rest_command, $route, $route_data, $command_args = array() ) {
// Define IDs that we are looking for in the routes (in addition to id)