Automattic\WooCommerce\Internal\Admin

WcPayWelcomePage::get_incentive() │ private │ WC 1.0

Fetches and caches eligible incentive from the WooPayments API.

Метод класса: WcPayWelcomePage{}

Хуков нет.

Возвращает

Массив|null. Array of eligible incentive or null.

Использование

// private - только в коде основоного (родительского) класса
$result = $this->get_incentive(): ?array;

Код WcPayWelcomePage::get_incentive() WcPayWelcomePage::get incentive ^{WC 9.3.3}

private function get_incentive(): ?array {
	// Return in-memory cached incentive if it is set.
	if ( isset( $this->incentive ) ) {
		return $this->incentive;
	}

	// Get the cached data.
	$cache = get_transient( self::CACHE_TRANSIENT_NAME );

	// If the cached data is not expired and it's a WP_Error,
	// it means there was an API error previously and we should not retry just yet.
	if ( is_wp_error( $cache ) ) {
		// Initialize the in-memory cache and return it.
		$this->incentive = [];

		return $this->incentive;
	}

	// Gather the store context data.
	$store_context = [
		// Store ISO-2 country code, e.g. `US`.
		'country'      => WC()->countries->get_base_country(),
		// Store locale, e.g. `en_US`.
		'locale'       => get_locale(),
		// WooCommerce store active for duration in seconds.
		'active_for'   => WCAdminHelper::get_wcadmin_active_for_in_seconds(),
		'has_orders'   => $this->has_orders(),
		// Whether the store has at least one payment gateway enabled.
		'has_payments' => ! empty( WC()->payment_gateways()->get_available_payment_gateways() ),
		'has_wcpay'    => $this->has_wcpay(),
	];

	// Fingerprint the store context through a hash of certain entries.
	$store_context_hash = $this->generate_context_hash( $store_context );

	// Use the transient cached incentive if it exists, it is not expired,
	// and the store context hasn't changed since we last requested from the WooPayments API (based on context hash).
	if ( false !== $cache
		&& ! empty( $cache['context_hash'] ) && is_string( $cache['context_hash'] )
		&& hash_equals( $store_context_hash, $cache['context_hash'] ) ) {

		// We have a store context hash and it matches with the current context one.
		// We can use the cached incentive data.
		// Store the incentive in the in-memory cache and return it.
		$this->incentive = $cache['incentive'] ?? [];

		return $this->incentive;
	}

	// By this point, we have an expired transient or the store context has changed.
	// Query for incentives by calling the WooPayments API.
	$url = add_query_arg(
		$store_context,
		'https://public-api.wordpress.com/wpcom/v2/wcpay/incentives',
	);

	$response = wp_remote_get(
		$url,
		[
			'user-agent' => 'WooCommerce/' . WC()->version . '; ' . get_bloginfo( 'url' ),
		]
	);

	// Return early if there is an error, waiting 6 hours before the next attempt.
	if ( is_wp_error( $response ) ) {
		// Store a trimmed down, lightweight error.
		$error = new \WP_Error(
			$response->get_error_code(),
			$response->get_error_message(),
			wp_remote_retrieve_response_code( $response )
		);
		// Store the error in the transient so we know this is due to an API error.
		set_transient( self::CACHE_TRANSIENT_NAME, $error, HOUR_IN_SECONDS * 6 );
		// Initialize the in-memory cache and return it.
		$this->incentive = [];

		return $this->incentive;
	}

	$cache_for = wp_remote_retrieve_header( $response, 'cache-for' );
	// Initialize the in-memory cache.
	$this->incentive = [];

	if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
		// Decode the results, falling back to an empty array.
		$results = json_decode( wp_remote_retrieve_body( $response ), true ) ?? [];

		// Find all `welcome_page` incentives.
		$incentives = array_filter(
			$results,
			function( $incentive ) {
				return 'welcome_page' === $incentive['type'];
			}
		);

		// Use the first found matching incentive or empty array if none was found.
		// Store incentive in the in-memory cache.
		$this->incentive = empty( $incentives ) ? [] : reset( $incentives );
	}

	// Skip transient cache if `cache-for` header equals zero.
	if ( '0' === $cache_for ) {
		// If we have a transient cache that is not expired, delete it so there are no leftovers.
		if ( false !== $cache ) {
			delete_transient( self::CACHE_TRANSIENT_NAME );
		}

		return $this->incentive;
	}

	// Store incentive in transient cache (together with the context hash) for the given number of seconds
	// or 1 day in seconds. Also attach a timestamp to the transient data so we know when we last fetched.
	set_transient(
		self::CACHE_TRANSIENT_NAME,
		[
			'incentive'    => $this->incentive,
			'context_hash' => $store_context_hash,
			'timestamp'    => time(),
		],
		! empty( $cache_for ) ? (int) $cache_for : DAY_IN_SECONDS
	);

	return $this->incentive;
}