1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<?php
namespace Automattic\WooCommerce\Blocks\Utils;

use WP_Query;

/**
 * BlocksWpQuery query.
 *
 * Wrapper for WP Query with additional helper methods.
 * Allows query args to be set and parsed without doing running it, so that a cache can be used.
 *
 * @deprecated 2.5.0
 */
class BlocksWpQuery extends WP_Query {
    /**
     * Constructor.
     *
     * Sets up the WordPress query, if parameter is not empty.
     *
     * Unlike the constructor in WP_Query, this does not RUN the query.
     *
     * @param string|array $query URL query string or array of vars.
     */
    public function __construct( $query = '' ) {
        if ( ! empty( $query ) ) {
            $this->init();
            $this->query      = wp_parse_args( $query );
            $this->query_vars = $this->query;
            $this->parse_query_vars();
        }
    }

    /**
     * Get cached posts, if a cache exists.
     *
     * A hash is generated using the array of query_vars. If doing custom queries via filters such as posts_where
     * (where the SQL query is manipulated directly) you can still ensure there is a unique hash by injecting custom
     * query vars via the parse_query filter. For example:
     *
     *      add_filter( 'parse_query', function( $wp_query ) {
     *           $wp_query->query_vars['my_custom_query_var'] = true;
     *      } );
     *
     * Doing so won't have any negative effect on the query itself, and it will cause the hash to change.
     *
     * @param string $transient_version Transient version to allow for invalidation.
     * @return WP_Post[]|int[] Array of post objects or post IDs.
     */
    public function get_cached_posts( $transient_version = '' ) {
        $hash            = md5( wp_json_encode( $this->query_vars ) );
        $transient_name  = 'wc_blocks_query_' . $hash;
        $transient_value = get_transient( $transient_name );

        if ( isset( $transient_value, $transient_value['version'], $transient_value['value'] ) && $transient_value['version'] === $transient_version ) {
            return $transient_value['value'];
        }

        $results = $this->get_posts();

        set_transient(
            $transient_name,
            array(
                'version' => $transient_version,
                'value'   => $results,
            ),
            DAY_IN_SECONDS * 30
        );

        return $results;
    }
}