$headers, 'user-agent' => 'WooCommerce Addons Page', ) ); if ( ! is_wp_error( $raw_featured ) ) { $featured = json_decode( wp_remote_retrieve_body( $raw_featured ) ); if ( $featured ) { set_transient( 'wc_addons_featured', $featured, DAY_IN_SECONDS ); } } } if ( is_object( $featured ) ) { self::output_featured_sections( $featured->sections ); return $featured; } } /** * Render featured products and banners using WCCOM's the Featured 2.0 Endpoint * * @return void */ public static function render_featured() { $featured = get_transient( 'wc_addons_featured_2' ); if ( false === $featured ) { $headers = array(); $auth = WC_Helper_Options::get( 'auth' ); if ( ! empty( $auth['access_token'] ) ) { $headers['Authorization'] = 'Bearer ' . $auth['access_token']; } $parameter_string = ''; $country = WC()->countries->get_base_country(); if ( ! empty( $country ) ) { $parameter_string = '?' . http_build_query( array( 'country' => $country ) ); } // Important: WCCOM Extensions API v2.0 is used. $raw_featured = wp_safe_remote_get( 'https://woocommerce.com/wp-json/wccom-extensions/2.0/featured' . $parameter_string, array( 'headers' => $headers, 'user-agent' => 'WooCommerce Addons Page', ) ); if ( ! is_wp_error( $raw_featured ) ) { $featured = json_decode( wp_remote_retrieve_body( $raw_featured ) ); if ( $featured ) { set_transient( 'wc_addons_featured_2', $featured, DAY_IN_SECONDS ); } } } if ( ! empty( $featured ) ) { self::output_featured( $featured ); } } /** * Build url parameter string * * @param string $category Addon (sub) category. * @param string $term Search terms. * @param string $country Store country. * * @return string url parameter string */ public static function build_parameter_string( $category, $term, $country ) { $parameters = array( 'category' => $category, 'term' => $term, 'country' => $country, ); return '?' . http_build_query( $parameters ); } /** * Call API to get extensions * * @param string $category Addon (sub) category. * @param string $term Search terms. * @param string $country Store country. * * @return object of extensions and promotions. */ public static function get_extension_data( $category, $term, $country ) { $parameters = self::build_parameter_string( $category, $term, $country ); $headers = array(); $auth = WC_Helper_Options::get( 'auth' ); if ( ! empty( $auth['access_token'] ) ) { $headers['Authorization'] = 'Bearer ' . $auth['access_token']; } $raw_extensions = wp_safe_remote_get( 'https://woocommerce.com/wp-json/wccom-extensions/1.0/search' . $parameters, array( 'headers' => $headers ) ); if ( ! is_wp_error( $raw_extensions ) ) { $addons = json_decode( wp_remote_retrieve_body( $raw_extensions ) ); } return $addons; } /** * Get sections for the addons screen * * @return array of objects */ public static function get_sections() { $addon_sections = get_transient( 'wc_addons_sections' ); if ( false === ( $addon_sections ) ) { $raw_sections = wp_safe_remote_get( 'https://woocommerce.com/wp-json/wccom-extensions/1.0/categories' ); if ( ! is_wp_error( $raw_sections ) ) { $addon_sections = json_decode( wp_remote_retrieve_body( $raw_sections ) ); if ( $addon_sections ) { set_transient( 'wc_addons_sections', $addon_sections, WEEK_IN_SECONDS ); } } } return apply_filters( 'woocommerce_addons_sections', $addon_sections ); } /** * Get section for the addons screen. * * @param string $section_id Required section ID. * * @return object|bool */ public static function get_section( $section_id ) { $sections = self::get_sections(); if ( isset( $sections[ $section_id ] ) ) { return $sections[ $section_id ]; } return false; } /** * Get section content for the addons screen. * * @deprecated 5.9.0 No longer used in In-App Marketplace * * @param string $section_id Required section ID. * * @return array */ public static function get_section_data( $section_id ) { $section = self::get_section( $section_id ); $section_data = ''; if ( ! empty( $section->endpoint ) ) { $section_data = get_transient( 'wc_addons_section_' . $section_id ); if ( false === $section_data ) { $raw_section = wp_safe_remote_get( esc_url_raw( $section->endpoint ), array( 'user-agent' => 'WooCommerce Addons Page' ) ); if ( ! is_wp_error( $raw_section ) ) { $section_data = json_decode( wp_remote_retrieve_body( $raw_section ) ); if ( ! empty( $section_data->products ) ) { set_transient( 'wc_addons_section_' . $section_id, $section_data, WEEK_IN_SECONDS ); } } } } return apply_filters( 'woocommerce_addons_section_data', $section_data->products, $section_id ); } /** * Handles the outputting of a contextually aware Storefront link (points to child themes if Storefront is already active). * * @deprecated 5.9.0 No longer used in In-App Marketplace */ public static function output_storefront_button() { $template = get_option( 'template' ); $stylesheet = get_option( 'stylesheet' ); if ( 'storefront' === $template ) { if ( 'storefront' === $stylesheet ) { $url = 'https://woocommerce.com/product-category/themes/storefront-child-theme-themes/'; $text = __( 'Need a fresh look? Try Storefront child themes', 'woocommerce' ); $utm_content = 'nostorefrontchildtheme'; } else { $url = 'https://woocommerce.com/product-category/themes/storefront-child-theme-themes/'; $text = __( 'View more Storefront child themes', 'woocommerce' ); $utm_content = 'hasstorefrontchildtheme'; } } else { $url = 'https://woocommerce.com/storefront/'; $text = __( 'Need a theme? Try Storefront', 'woocommerce' ); $utm_content = 'nostorefront'; } $url = add_query_arg( array( 'utm_source' => 'addons', 'utm_medium' => 'product', 'utm_campaign' => 'woocommerceplugin', 'utm_content' => $utm_content, ), $url ); echo '' . esc_html( $text ) . '' . "\n"; } /** * Handles the outputting of a banner block. * * @deprecated 5.9.0 No longer used in In-App Marketplace * * @param object $block Banner data. */ public static function output_banner_block( $block ) { ?>

title ); ?>

description ); ?>

items as $item ) : ?>

title ); ?>

description ); ?>

href, $item->button, 'addons-button-solid', $item->plugin ); ?>
container ) && 'column_container_start' === $block->container ) { ?>
module ) { ?>
container ) && 'column_container_end' === $block->container ) { ?>

title ); ?>

description ); ?>

items as $item ) : ?>

title ); ?>

href, $item->button, 'addons-button-solid', $item->plugin ); ?>

description ); ?>

title ); ?>

description ); ?>

buttons as $button ) : ?> href, $button->text, 'addons-button-solid' ); ?>

title ); ?>

description ); ?>

items as $item ) : ?>
image ) ) : ?>
href, $item->button, 'addons-button-outline-white' ); ?>
'woocommerce-services', ) ), 'install-addon_woocommerce-services' ); $defaults = array( 'image' => WC()->plugin_url() . '/assets/images/wcs-extensions-banner-3x.jpg', 'image_alt' => __( 'WooCommerce Shipping', 'woocommerce' ), 'title' => __( 'Save time and money with WooCommerce Shipping', 'woocommerce' ), 'description' => __( 'Print discounted USPS and DHL labels straight from your WooCommerce dashboard and save on shipping.', 'woocommerce' ), 'button' => __( 'Free - Install now', 'woocommerce' ), 'href' => $button_url, 'logos' => array(), ); switch ( $location['country'] ) { case 'US': $local_defaults = array( 'logos' => array_merge( $defaults['logos'], array( array( 'link' => WC()->plugin_url() . '/assets/images/wcs-usps-logo.png', 'alt' => 'USPS logo', ), array( 'link' => WC()->plugin_url() . '/assets/images/wcs-dhlexpress-logo.png', 'alt' => 'DHL Express logo', ), ) ), ); break; default: $local_defaults = array(); } $block_data = array_merge( $defaults, $local_defaults, $block ); ?>
<?php echo esc_attr( $block_data['image_alt'] ); ?>

'woocommerce-payments', ) ), 'install-addon_woocommerce-payments' ); $defaults = array( 'image' => WC()->plugin_url() . '/assets/images/wcpayments-icon-secure.png', 'image_alt' => __( 'WooCommerce Payments', 'woocommerce' ), 'title' => __( 'Payments made simple, with no monthly fees — exclusively for WooCommerce stores.', 'woocommerce' ), 'description' => __( 'Securely accept cards in your store. See payments, track cash flow into your bank account, and stay on top of disputes – right from your dashboard.', 'woocommerce' ), 'button' => __( 'Free - Install now', 'woocommerce' ), 'href' => $button_url, 'logos' => array(), ); $block_data = array_merge( $defaults, $block ); ?>
<?php echo esc_attr( $block_data['image_alt'] ); ?>

<?php echo esc_attr( $promotion['image_alt'] ); ?>

geowhitelist ) ) { $section_object->geowhitelist = explode( ',', $section_object->geowhitelist ); } if ( ! empty( $section_object->geoblacklist ) ) { $section_object->geoblacklist = explode( ',', $section_object->geoblacklist ); } if ( ! self::show_extension( $section_object ) ) { return; } ?>
<?php echo esc_attr( $section['image_alt'] ); ?>

module ) { case 'banner_block': self::output_banner_block( $section ); break; case 'column_start': self::output_column( $section ); break; case 'column_end': self::output_column( $section ); break; case 'column_block': self::output_column_block( $section ); break; case 'small_light_block': self::output_small_light_block( $section ); break; case 'small_dark_block': self::output_small_dark_block( $section ); break; case 'wcs_banner_block': self::output_wcs_banner_block( (array) $section ); break; case 'wcpay_banner_block': self::output_wcpay_banner_block( (array) $section ); break; case 'promotion_block': self::output_promotion_block( (array) $section ); break; } } } /** * Handles the outputting of featured page * * @param array $blocks Featured page's blocks. */ private static function output_featured( $blocks ) { foreach ( $blocks as $block ) { $block_type = $block->type ?? null; switch ( $block_type ) { case 'group': self::output_group( $block ); break; case 'banner': self::output_banner( $block ); break; } } } /** * Render a group block including products * * @param mixed $block Block of the page for rendering. * * @return void */ private static function output_group( $block ) { $capacity = $block->capacity ?? 3; $product_list_classes = 3 === $capacity ? 'three-column' : 'two-column'; $product_list_classes = 'products addons-products-' . $product_list_classes; ?>

title ); ?>

description ) ) : ?>
description ); ?>
url ) : ?>
buttons ) ) { // Render a product-like banner. ?> site_url(), 'wccom-back' => rawurlencode( $back_admin_path ), 'wccom-woo-version' => Constants::get_constant( 'WC_VERSION' ), 'wccom-connect-nonce' => wp_create_nonce( 'connect' ), ); } /** * Add in-app-purchase URL params to link. * * Adds various url parameters to a url to support a streamlined * flow for obtaining and setting up WooCommerce extensons. * * @param string $url Destination URL. */ public static function add_in_app_purchase_url_params( $url ) { return add_query_arg( self::get_in_app_purchase_url_params(), $url ); } /** * Outputs a button. * * @param string $url Destination URL. * @param string $text Button label text. * @param string $style Button style class. * @param string $plugin The plugin the button is promoting. */ public static function output_button( $url, $text, $style, $plugin = '' ) { $style = __( 'Free', 'woocommerce' ) === $text ? 'addons-button-outline-purple' : $style; $style = is_plugin_active( $plugin ) ? 'addons-button-installed' : $style; $text = is_plugin_active( $plugin ) ? __( 'Installed', 'woocommerce' ) : $text; $url = self::add_in_app_purchase_url_params( $url ); ?> countries->get_base_country(); $extension_data = self::get_extension_data( $category, $term, $country ); $addons = $extension_data->products; $promotions = ! empty( $extension_data->promotions ) ? $extension_data->promotions : array(); } // We need Automattic\WooCommerce\Admin\RemoteInboxNotifications for the next part, if not remove all promotions. if ( ! WC()->is_wc_admin_active() ) { $promotions = array(); } // Check for existence of promotions and evaluate out if we should show them. if ( ! empty( $promotions ) ) { foreach ( $promotions as $promo_id => $promotion ) { $evaluator = new PromotionRuleEngine\RuleEvaluator(); $passed = $evaluator->evaluate( $promotion->rules ); if ( ! $passed ) { unset( $promotions[ $promo_id ] ); } } // Transform promotions to the correct format ready for output. $promotions = self::format_promotions( $promotions ); } /** * Addon page view. * * @uses $addons * @uses $search * @uses $sections * @uses $theme * @uses $current_section */ include_once dirname( __FILE__ ) . '/views/html-admin-page-addons.php'; } /** * Install WooCommerce Services from Extensions screens. */ public static function install_woocommerce_services_addon() { check_admin_referer( 'install-addon_woocommerce-services' ); $services_plugin_id = 'woocommerce-services'; $services_plugin = array( 'name' => __( 'WooCommerce Services', 'woocommerce' ), 'repo-slug' => 'woocommerce-services', ); WC_Install::background_installer( $services_plugin_id, $services_plugin ); wp_safe_redirect( remove_query_arg( array( 'install-addon', '_wpnonce' ) ) ); exit; } /** * Install WooCommerce Payments from the Extensions screens. * * @param string $section Optional. Extenstions tab. * * @return void */ public static function install_woocommerce_payments_addon( $section = '_featured' ) { check_admin_referer( 'install-addon_woocommerce-payments' ); $wcpay_plugin_id = 'woocommerce-payments'; $wcpay_plugin = array( 'name' => __( 'WooCommerce Payments', 'woocommerce' ), 'repo-slug' => 'woocommerce-payments', ); WC_Install::background_installer( $wcpay_plugin_id, $wcpay_plugin ); do_action( 'woocommerce_addon_installed', $wcpay_plugin_id, $section ); wp_safe_redirect( remove_query_arg( array( 'install-addon', '_wpnonce' ) ) ); exit; } /** * We're displaying page=wc-addons and page=wc-addons§ion=helper as two separate pages. * When we're on those pages, add body classes to distinguishe them. * * @param string $admin_body_class Unfiltered body class. * * @return string Body class with added class for Marketplace or My Subscriptions page. */ public static function filter_admin_body_classes( string $admin_body_class = '' ): string { if ( isset( $_GET['section'] ) && 'helper' === $_GET['section'] ) { return " $admin_body_class woocommerce-page-wc-subscriptions "; } return " $admin_body_class woocommerce-page-wc-marketplace "; } /** * Take an action object and return the URL based on properties of the action. * * @param object $action Action object. * @return string URL. */ public static function get_action_url( $action ): string { if ( ! isset( $action->url ) ) { return ''; } if ( isset( $action->url_is_admin_query ) && $action->url_is_admin_query ) { return wc_admin_url( $action->url ); } if ( isset( $action->url_is_admin_nonce_query ) && $action->url_is_admin_nonce_query ) { if ( empty( $action->nonce ) ) { return ''; } return wp_nonce_url( admin_url( $action->url ), $action->nonce ); } return $action->url; } /** * Format the promotion data ready for display, ie fetch locales and actions. * * @param array $promotions Array of promotoin objects. * @return array Array of formatted promotions ready for output. */ public static function format_promotions( array $promotions ): array { $formatted_promotions = array(); foreach ( $promotions as $promotion ) { // Get the matching locale or fall back to en-US. $locale = PromotionRuleEngine\SpecRunner::get_locale( $promotion->locales ); if ( null === $locale ) { continue; } $promotion_actions = array(); if ( ! empty( $promotion->actions ) ) { foreach ( $promotion->actions as $action ) { $action_locale = PromotionRuleEngine\SpecRunner::get_action_locale( $action->locales ); $url = self::get_action_url( $action ); $promotion_actions[] = array( 'name' => $action->name, 'label' => $action_locale->label, 'url' => $url, 'primary' => isset( $action->is_primary ) ? $action->is_primary : false, ); } } $formatted_promotions[] = array( 'title' => $locale->title, 'description' => $locale->description, 'image' => ( 'http' === substr( $locale->image, 0, 4 ) ) ? $locale->image : WC()->plugin_url() . $locale->image, 'image_alt' => $locale->image_alt, 'actions' => $promotion_actions, ); } return $formatted_promotions; } /** * Map data from different endpoints to a universal format * * Search and featured products has a slightly different products' field names. * Mapping converts different data structures into a universal one for further processing. * * @param mixed $data Product Card Data. * * @return object Converted data. */ public static function map_product_card_data( $data ) { $mapped = (object) null; $type = $data->type ?? null; // Icon. $mapped->icon = $data->icon ?? null; if ( null === $mapped->icon && 'banner' === $type ) { // For product-related banners icon is a product's image. $mapped->icon = $data->image ?? null; } // URL. $mapped->url = $data->link ?? null; if ( empty( $mapped->url ) ) { $mapped->url = $data->url ?? null; } // Title. $mapped->title = $data->title ?? null; // Vendor Name. $mapped->vendor_name = $data->vendor_name ?? null; if ( empty( $mapped->vendor_name ) ) { $mapped->vendor_name = $data->vendorName ?? null; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } // Vendor URL. $mapped->vendor_url = $data->vendor_url ?? null; if ( empty( $mapped->vendor_url ) ) { $mapped->vendor_url = $data->vendorUrl ?? null; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } // Description. $mapped->description = $data->excerpt ?? null; if ( empty( $mapped->description ) ) { $mapped->description = $data->description ?? null; } $has_currency = ! empty( $data->currency ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase // Is Free. if ( $has_currency ) { $mapped->is_free = 0 === (int) $data->price; } else { $mapped->is_free = '$0.00' === $data->price; } // Price. if ( $has_currency ) { $mapped->price = wc_price( $data->price, array( 'currency' => $data->currency ) ); } else { $mapped->price = $data->price; } // Rating. $mapped->rating = $data->rating ?? null; if ( null === $mapped->rating ) { $mapped->rating = $data->averageRating ?? null; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } // Reviews Count. $mapped->reviews_count = $data->reviews_count ?? null; if ( null === $mapped->reviews_count ) { $mapped->reviews_count = $data->reviewsCount ?? null; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase } // Featured & Promoted product card. // Label. $mapped->label = $data->label ?? null; // Primary color. $mapped->primary_color = $data->primary_color ?? null; // Text color. $mapped->text_color = $data->text_color ?? null; // Button text. $mapped->button = $data->button ?? null; return $mapped; } /** * Render a product card * * There's difference in data structure (e.g. field names) between endpoints such as search and * featured. Inner mapping helps to use universal field names for further work. * * @param mixed $data Product data. * @param string $block_type Block type that's different from the default product card, e.g. a banner. * * @return void */ public static function render_product_card( $data, $block_type = null ) { $mapped = self::map_product_card_data( $data ); $product_url = self::add_in_app_purchase_url_params( $mapped->url ); $class_names = array( 'product' ); // Specify a class name according to $block_type (if it's specified). if ( null !== $block_type ) { $class_names[] = 'addons-product-' . $block_type; } $product_details_classes = 'product-details'; if ( 'banner' === $block_type ) { $product_details_classes .= ' addon-product-banner-details'; } if ( isset( $mapped->label ) && 'promoted' === $mapped->label ) { $product_details_classes .= ' promoted'; } elseif ( isset( $mapped->label ) && 'featured' === $mapped->label ) { $product_details_classes .= ' featured'; } if ( 'promoted' === $mapped->label && ! empty( $mapped->primary_color ) && ! empty( $mapped->text_color ) && ! empty( $mapped->button ) ) { // Promoted product card. ?>
  • title ); ?>

    description ); ?>

  • label ) && 'featured' === $mapped->label ) { ?>

    title ); ?>

    vendor_name ) && ! empty( $mapped->vendor_url ) ) : ?>
    'extensionsscreen', 'utm_medium' => 'product', 'utm_campaign' => 'wcaddons', 'utm_content' => 'devpartner', ), $mapped->vendor_url ); printf( /* translators: %s vendor link */ esc_html__( 'Developed by %s', 'woocommerce' ), sprintf( '%2$s', esc_url_raw( $vendor_url ), esc_html( $mapped->vendor_name ) ) ); ?>

    description ); ?>

    icon ) ) : ?>
  • = $index ) { // Rating more that current star to show. return 'fill'; } elseif ( abs( $index - 1 - floor( $rating ) ) < 0.0000001 && 0 < ( $rating - floor( $rating ) ) ) { // For rating more than x.0 and less than x.5 or equal it will show a half star. return 50 >= floor( ( $rating - floor( $rating ) ) * 100 ) ? 'half-fill' : 'fill'; } // Don't show a golden star otherwise. return 'no-fill'; } }