WP CLI add a custom command

Creates a WP-CLI class and functions accepting arguments and reporting success or error.

// Class Of Commands
class CCOM_CLI {

	// Gets order Thank You page URL
	public function get_thankyou_url( $args, $assoc_args ) {
		if( empty( $args[0] ) ) {
			WP_CLI::error( 'Error: Order ID is missing.' );
			return;
		}
		$order = wc_get_order( $args[0] );
		WP_CLI::success( $order->get_checkout_order_received_url() );
	}

}

// Hook Into WP-CLI
add_action( 'cli_init', function() {

	WP_CLI::add_command( 'ccom', 'CCOM_CLI' );

} );

Instructions for WP CLI add a custom command

  1. Log into a staging or locally hosted clone of your site.
  2. Install and activate Code Snippets plugin.
  3. WP Admin > Snippets > Add New
  4. Copy and paste the code from the section above.
  5. Check to ensure formatting came over properly.
  6. Customize the code as desired.
  7. Add a meaningful title.
  8. Select whether to run on front-end or back-end (or both).
  9. Click “Save and Activate”.
  10. Test your site to ensure it works.
  11. Disable if any problems, or recover.
  12. Repeat for live environment.

Need help modifying WP CLI add a custom command?

Contact me. I can help with fitting projects or refer to my partner.

Email Sean

License

All code snippets are licensed GPLv2 (or later) matching WordPress licensing.

Except when otherwise stated in writing the copyright holders and/or other parties provide the program as-is without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose.

Disclaimer of warranty
Return to WooCommerce code snippets