* REST API Launch Your Store Controller
* Handles requests to /launch-your-store/*
namespace Automattic\WooCommerce\Admin\API;
use Automattic\WooCommerce\Admin\WCAdminHelper;
defined( 'ABSPATH' ) || exit;
* Launch Your Store controller.
protected $namespace = 'wc-admin';
protected $rest_base = 'launch-your-store';
public function register_routes() {
'/' . $this->rest_base . '/initialize-coming-soon',
'callback' => array( $this, 'initialize_coming_soon' ),
'permission_callback' => array( $this, 'must_be_shop_manager_or_admin' ),
'/' . $this->rest_base . '/update-survey-status',
'callback' => array( $this, 'update_survey_status' ),
'permission_callback' => array( $this, 'must_be_shop_manager_or_admin' ),
'enum' => array( 'yes', 'no' ),
'/' . $this->rest_base . '/survey-completed',
'callback' => array( $this, 'has_survey_completed' ),
'permission_callback' => array( $this, 'must_be_shop_manager_or_admin' ),
'/' . $this->rest_base . '/woopayments/test-orders/count',
'callback' => array( $this, 'get_woopay_test_orders_count' ),
'permission_callback' => array( $this, 'must_be_shop_manager_or_admin' ),
'/' . $this->rest_base . '/woopayments/test-orders',
'callback' => array( $this, 'delete_woopay_test_orders' ),
'permission_callback' => array( $this, 'must_be_shop_manager_or_admin' ),
* User must be either shop_manager or administrator.
public function must_be_shop_manager_or_admin() {
if ( ! current_user_can( 'manage_woocommerce' ) && ! current_user_can( 'administrator' ) ) {
* Initializes options for coming soon. Overwrites existing coming soon status but keeps the private link and share key.
public function initialize_coming_soon() {
$current_user_id = get_current_user_id();
// Abort if we don't have a user id for some reason.
if ( ! $current_user_id ) {
$store_pages_only = WCAdminHelper::is_site_fresh() ? 'no' : 'yes';
$share_key = wp_generate_password( 32, false );
update_option( 'woocommerce_coming_soon', $coming_soon );
update_option( 'woocommerce_store_pages_only', $store_pages_only );
add_option( 'woocommerce_private_link', $private_link );
add_option( 'woocommerce_share_key', $share_key );
wc_admin_record_tracks_event(
'launch_your_store_initialize_coming_soon',
'coming_soon' => $coming_soon,
'store_pages_only' => $store_pages_only,
'private_link' => $private_link,
* Count the test orders created during Woo Payments test mode.
* @return \WP_REST_Response
public function get_woopay_test_orders_count() {
$return = function ( $count ) {
return new \WP_REST_Response( array( 'count' => $count ) );
'meta_key' => '_wcpay_mode',
return $return( count( $orders ) );
* Delete WooPayments test orders.
* @return \WP_REST_Response
public function delete_woopay_test_orders() {
$return = function ( $status = 204 ) {
return new \WP_REST_Response( null, $status );
'meta_key' => '_wcpay_mode',
foreach ( $orders as $order ) {
* Update woocommerce_admin_launch_your_store_survey_completed to yes or no
* @param \WP_REST_Request $request WP_REST_Request object.
* @return \WP_REST_Response
public function update_survey_status( \WP_REST_Request $request ) {
update_option( 'woocommerce_admin_launch_your_store_survey_completed', $request->get_param( 'status' ) );
return new \WP_REST_Response();
* Return woocommerce_admin_launch_your_store_survey_completed option.
* @return \WP_REST_Response
public function has_survey_completed() {
return new \WP_REST_Response( get_option( 'woocommerce_admin_launch_your_store_survey_completed', 'no' ) );