WC_Cache_Helper::get_transient_version( string $group, boolean $refresh = false )

Get transient version.

Contents

Description Description

When using transients with unpredictable names, e.g. those containing an md5 hash in the name, we need a way to invalidate them all at once.

When using default WP transients we’re able to do this with a DB query to delete transients manually.

With external cache however, this isn’t possible. Instead, this function is used to append a unique string (based on time()) to each transient. When transients are invalidated, the transient version will increment and data will be regenerated.

Raised in issue https://github.com/woocommerce/woocommerce/issues/5777. Adapted from ideas in http://tollmanz.com/invalidation-schemes/.

Parameters Parameters

$group

(Required) Name for the group of transients we need to invalidate.

$refresh

(Optional) true to force a new version.

Default value: false

Top ↑

Return Return

(string) transient version based on time(), 10 digits.

Top ↑

Source Source

File: includes/class-wc-cache-helper.php 

	public static function get_transient_version( $group, $refresh = false ) {
		$transient_name  = $group . '-transient-version';
		$transient_value = get_transient( $transient_name );

		if ( false === $transient_value || true === $refresh ) {
			$transient_value = (string) time();

			set_transient( $transient_name, $transient_value );
		}

		return $transient_value;
	}

Expand full source code Collapse full source code

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
includes/wc-update-functions.php: wc_update_241_variations()

Update variations for 2.4.1
includes/admin/settings/class-wc-settings-shipping.php: WC_Settings_Shipping::save()

Save settings.
includes/admin/settings/class-wc-settings-tax.php: WC_Settings_Tax::save()

Save settings.
includes/wc-core-functions.php: wc_get_shipping_method_count()

Gets number of shipping methods currently enabled. Used to identify if shipping is configured.
includes/class-wc-ajax.php: WC_AJAX::shipping_zone_methods_save_settings()

Save method settings
includes/class-wc-ajax.php: WC_AJAX::tax_rates_save_changes()

Handle submissions from assets/js/settings-views-html-settings-tax.js Backbone model.
includes/data-stores/class-wc-product-variable-data-store-cpt.php: WC_Product_Variable_Data_Store_CPT::read_price_data()

Get an array of all sale and regular prices from all variations. This is used for example when displaying the price range at variable product level or seeing if the variable product is on sale.
includes/data-stores/class-wc-shipping-zone-data-store.php: WC_Shipping_Zone_Data_Store::delete()

Deletes a shipping zone from the database.
includes/data-stores/class-wc-shipping-zone-data-store.php: WC_Shipping_Zone_Data_Store::create()

Method to create a new shipping zone.
includes/data-stores/class-wc-shipping-zone-data-store.php: WC_Shipping_Zone_Data_Store::update()

Update zone in the database.
includes/class-wc-post-data.php: WC_Post_Data::delete_product_query_transients()

Delete product view transients when needed e.g. when post status changes, or visibility/stock status is modified.
includes/wc-product-functions.php: wc_scheduled_sales()

Function which handles the start and end of scheduled sales via cron.
includes/wc-product-functions.php: wc_delete_product_transients()

Clear transient cache for product data.
includes/class-wc-shipping.php: WC_Shipping::calculate_shipping_for_package()

Calculate shipping rates for a package,
includes/wc-user-functions.php: wc_customer_bought_product()

Checks if a user (by email or ID or both) has bought an item.
includes/class-wc-shipping-zone.php: WC_Shipping_Zone::delete_shipping_method()

Delete a shipping method from a zone.
includes/class-wc-shipping-zone.php: WC_Shipping_Zone::add_shipping_method()

Add a shipping method to this zone.
includes/wc-order-functions.php: wc_delete_shop_order_transients()

Clear all transients cache for order data.
includes/shortcodes/class-wc-shortcode-products.php: WC_Shortcode_Products::get_query_results()

Run the query and return an array of data, including queried ids and pagination information.
packages/woocommerce-admin/src/API/Reports/Cache.php: Cache::invalidate()

Invalidate cache.
packages/woocommerce-admin/src/API/Reports/Cache.php: Cache::get_version()

Get cache version number.
packages/woocommerce-blocks/src/BlockTypes/AbstractProductGrid.php: AbstractProductGrid::get_products()

Run the query and return an array of product IDs
includes/rest-api/Controllers/Version2/class-wc-rest-system-status-tools-v2-controller.php: WC_REST_System_Status_Tools_V2_Controller::execute_tool()

Actually executes a tool.
Show 18 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.