is_complete() ) { add_action( 'current_screen', array( $this, 'maybe_redirect_to_add_product_tasklist' ), 30, 0 ); } add_action( 'trashed_post', array( $this, 'on_product_trashed' ) ); add_action( 'deleted_post_product', array( $this, 'on_product_deleted' ) ); } /** * Highlight Add product while creating a product from the onboarding task. * * @internal * * @param mixed $submenu_file Current submenu file. * @return mixed */ public function highlight_add_product_menu( $submenu_file ) { $screen = get_current_screen(); $tutorial = wc_clean( wp_unslash( $_GET['tutorial'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended $tutorial = is_string( $tutorial ) ? $tutorial : ''; if ( ! $this->is_active() || ! wc_string_to_bool( $tutorial ) || ! $screen || 'post' !== $screen->base || 'product' !== $screen->post_type ) { return $submenu_file; } return 'post-new.php?post_type=product'; } /** * ID. * * @return string */ public function get_id() { return 'products'; } /** * Contextual image URL. * * @return string */ public function get_image_url() { return WC()->plugin_url() . '/assets/images/task_list/sales-section-illustration.svg'; } /** * Alt text for the contextual image. * * @return string */ public function get_image_alt() { return __( 'Products illustration', 'woocommerce' ); } /** * Title. * * @return string */ public function get_title() { $onboarding_profile = get_option( OnboardingProfile::DATA_OPTION, array() ); if ( isset( $onboarding_profile['business_choice'] ) && 'im_already_selling' === $onboarding_profile['business_choice'] ) { return __( 'Import your products', 'woocommerce' ); } return __( 'Add your products', 'woocommerce' ); } /** * Content. * * @return string */ public function get_content() { return __( 'Start by adding the first product to your store. You can add your products manually, via CSV, or import them from another service.', 'woocommerce' ); } /** * Time. * * @return string */ public function get_time() { return __( '1 minute per product', 'woocommerce' ); } /** * Task completion. * * @return bool */ public function is_complete() { if ( $this->has_previously_completed() ) { return true; } return self::has_products(); } /** * Additional data. * * @return array */ public function get_additional_data() { return array( 'has_products' => self::has_products(), ); } /** * If a task is always accessible, relevant for when a task list is hidden but a task can still be viewed. * * @return bool */ public function is_always_accessible() { return true; } /** * Adds a return to task list notice when completing the import product task. * * @param string $hook Page hook. */ public function possibly_add_import_return_notice_script( $hook ) { $step = isset( $_GET['step'] ) ? $_GET['step'] : ''; // phpcs:ignore csrf ok, sanitization ok. if ( $hook !== 'product_page_product_importer' || $step !== 'done' ) { return; } if ( ! $this->is_active() || $this->is_complete() ) { return; } WCAdminAssets::register_script( 'wp-admin-scripts', 'onboarding-product-import-notice', true ); } /** * Adds a return to task list notice when completing the loading sample products action. * * @param string $hook Page hook. */ public function possibly_add_load_sample_return_notice_script( $hook ) { if ( $hook !== 'edit.php' || get_query_var( 'post_type' ) !== 'product' ) { return; } $referer = wp_get_referer(); if ( ! $referer || strpos( $referer, wc_admin_url() ) !== 0 ) { return; } if ( ! isset( $_GET[ Task::ACTIVE_TASK_TRANSIENT ] ) ) { return; } $task_id = sanitize_title_with_dashes( wp_unslash( $_GET[ Task::ACTIVE_TASK_TRANSIENT ] ) ); if ( $task_id !== $this->get_id() || ! $this->is_complete() ) { return; } WCAdminAssets::register_script( 'wp-admin-scripts', 'onboarding-load-sample-products-notice', true ); } /** * Set the has products transient if the post qualifies as a user created product. * * @param int $post_id Post ID. */ public function maybe_set_has_product_transient_on_untrashed_post( $post_id ) { if ( get_post_type( $post_id ) !== 'product' ) { return; } $this->maybe_set_has_product_transient( $post_id, wc_get_product( $post_id ) ); } /** * Set the has products transient if the product qualifies as a user created product. * * @param int $product_id Product ID. * @param WC_Product $product Product object. */ public function maybe_set_has_product_transient( $product_id, $product ) { if ( ! $this->has_previously_completed() && ProductStatus::PUBLISH === $product->get_status() ) { set_transient( self::HAS_PRODUCT_TRANSIENT, 'yes' ); $this->possibly_track_completion(); } } /** * Handle product trashing via the trashed_post hook. * * @param int $post_id Post ID. * @return void */ public function on_product_trashed( $post_id ) { if ( get_post_type( $post_id ) !== 'product' ) { return; } $this->revert_task_completion(); } /** * Handle permanent product deletion via the deleted_post_product hook. * * @return void */ public function on_product_deleted() { $this->revert_task_completion(); } /** * Schedule a deferred check to revert task completion if no products remain. * * Uses the shutdown hook so that bulk operations (e.g. trashing many products * at once) only trigger a single has_products() query instead of one per product. * * @return void */ private function revert_task_completion(): void { delete_transient( self::HAS_PRODUCT_TRANSIENT ); if ( self::$revert_scheduled ) { return; } self::$revert_scheduled = true; add_action( 'shutdown', array( $this, 'maybe_revert_on_shutdown' ) ); } /** * Re-check whether valid products still exist and revert task completion if none remain. * * Runs once at the end of the request via the shutdown hook. * * @return void */ public function maybe_revert_on_shutdown(): void { self::$revert_scheduled = false; if ( self::has_products() ) { return; } $completed_tasks = get_option( self::COMPLETED_OPTION, array() ); $task_id = $this->get_id(); if ( in_array( $task_id, $completed_tasks, true ) ) { $completed_tasks = array_values( array_diff( $completed_tasks, array( $task_id ) ) ); update_option( self::COMPLETED_OPTION, $completed_tasks ); } } /** * Check if the store has any user created published products. * * @return bool */ public static function has_products() { $product_exists = get_transient( self::HAS_PRODUCT_TRANSIENT ); if ( $product_exists ) { return 'yes' === $product_exists; } $counts = wp_count_posts( 'product' ); $value = isset( $counts->publish ) && $counts->publish > 0 ? 'yes' : 'no'; set_transient( self::HAS_PRODUCT_TRANSIENT, $value ); return 'yes' === $value; } /** * Redirect to the add product tasklist if there are no products. * * @return void */ public function maybe_redirect_to_add_product_tasklist() { $screen = get_current_screen(); if ( $screen && 'edit' === $screen->base && 'product' === $screen->post_type ) { $counts = wc_get_container()->get( ProductUtil::class )->get_counts_for_type( 'product' ); $count = array_sum( $counts ) - ( $counts[ ProductStatus::AUTO_DRAFT ] ?? 0 ); if ( $count > 0 ) { return; } wp_safe_redirect( admin_url( 'admin.php?page=wc-admin&path=/add-product&task=products&from=products-list' ) ); exit; } } }