Automattic\WooCommerce\StoreApi\Schemas\V1

ProductSchema::get_variations │ protected │ WC 1.0

Get variation IDs and attributes from the DB.

Method of the class: ProductSchema{}

No Hooks.

Returns

null. Nothing (null).

Usage

// protected - for code of main (parent) or child class
$result = $this->get_variations( $product );

$product(WC_Product) (required)

Product instance.

ProductSchema::get_variations() ProductSchema::get variations code ^{WC 9.9.5}

protected function get_variations( \WC_Product $product ) {
	$variation_ids = $product->is_type( ProductType::VARIABLE ) ? $product->get_visible_children() : [];

	if ( ! count( $variation_ids ) ) {
		return [];
	}

	/**
	 * Gets default variation data which applies to all of this products variations.
	 */
	$attributes                  = array_filter( $product->get_attributes(), [ $this, 'filter_variation_attribute' ] );
	$default_variation_meta_data = array_reduce(
		$attributes,
		function ( $defaults, $attribute ) use ( $product ) {
			$meta_key              = wc_variation_attribute_name( $attribute->get_name() );
			$defaults[ $meta_key ] = [
				'name'  => wc_attribute_label( $attribute->get_name(), $product ),
				'value' => null,
			];
			return $defaults;
		},
		[]
	);
	$default_variation_meta_keys = array_keys( $default_variation_meta_data );

	/**
	 * Gets individual variation data from the database, using cache where possible.
	 */
	$cache_group   = 'product_variation_meta_data';
	$cache_value   = wp_cache_get( $product->get_id(), $cache_group );
	$last_modified = get_the_modified_date( 'U', $product->get_id() );

	if ( false === $cache_value || $last_modified !== $cache_value['last_modified'] ) {
		global $wpdb;
		// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
		$variation_meta_data = $wpdb->get_results(
			"
			SELECT post_id as variation_id, meta_key as attribute_key, meta_value as attribute_value
			FROM {$wpdb->postmeta}
			WHERE post_id IN (" . implode( ',', array_map( 'esc_sql', $variation_ids ) ) . ")
			AND meta_key IN ('" . implode( "','", array_map( 'esc_sql', $default_variation_meta_keys ) ) . "')
		"
		);
		// phpcs:enable

		wp_cache_set(
			$product->get_id(),
			[
				'last_modified' => $last_modified,
				'data'          => $variation_meta_data,
			],
			$cache_group
		);
	} else {
		$variation_meta_data = $cache_value['data'];
	}

	/**
	 * Merges and formats default variation data with individual variation data.
	 */
	$attributes_by_variation = array_reduce(
		$variation_meta_data,
		function ( $values, $data ) use ( $default_variation_meta_keys ) {
			// The query above only includes the keys of $default_variation_meta_data so we know all of the attributes
			// being processed here apply to this product. However, we need an additional check here because the
			// cache may have been primed elsewhere and include keys from other products.
			// @see AbstractProductGrid::prime_product_variations.
			if ( in_array( $data->attribute_key, $default_variation_meta_keys, true ) ) {
				$values[ $data->variation_id ][ $data->attribute_key ] = $data->attribute_value;
			}
			return $values;
		},
		array_fill_keys( $variation_ids, [] )
	);

	$variations = [];

	foreach ( $variation_ids as $variation_id ) {
		$attribute_data = $default_variation_meta_data;

		foreach ( $attributes_by_variation[ $variation_id ] as $meta_key => $meta_value ) {
			if ( '' !== $meta_value ) {
				$attribute_data[ $meta_key ]['value'] = $meta_value;
			}
		}

		$variations[] = (object) [
			'id'         => $variation_id,
			'attributes' => array_values( $attribute_data ),
		];
	}

	return $variations;
}