class-wc-widget-brand-description.php
1 year ago
class-wc-widget-brand-nav.php
7 months ago
class-wc-widget-brand-thumbnails.php
1 year ago
class-wc-widget-cart.php
3 years ago
class-wc-widget-layered-nav-filters.php
2 years ago
class-wc-widget-layered-nav.php
3 months ago
class-wc-widget-price-filter.php
7 months ago
class-wc-widget-product-categories.php
7 months ago
class-wc-widget-product-search.php
5 years ago
class-wc-widget-product-tag-cloud.php
5 years ago
class-wc-widget-products.php
1 year ago
class-wc-widget-rating-filter.php
5 years ago
class-wc-widget-recent-reviews.php
2 months ago
class-wc-widget-recently-viewed.php
1 year ago
class-wc-widget-top-rated-products.php
5 years ago
class-wc-widget-products.php
223 lines
| 1 | <?php |
| 2 | /** |
| 3 | * List products. One widget to rule them all. |
| 4 | * |
| 5 | * @package WooCommerce\Widgets |
| 6 | * @version 3.3.0 |
| 7 | */ |
| 8 | |
| 9 | defined( 'ABSPATH' ) || exit; |
| 10 | |
| 11 | use Automattic\WooCommerce\Enums\ProductStockStatus; |
| 12 | |
| 13 | /** |
| 14 | * Widget products. |
| 15 | */ |
| 16 | class WC_Widget_Products extends WC_Widget { |
| 17 | |
| 18 | /** |
| 19 | * Constructor. |
| 20 | */ |
| 21 | public function __construct() { |
| 22 | $this->widget_cssclass = 'woocommerce widget_products'; |
| 23 | $this->widget_description = __( "A list of your store's products.", 'woocommerce' ); |
| 24 | $this->widget_id = 'woocommerce_products'; |
| 25 | $this->widget_name = __( 'Products list', 'woocommerce' ); |
| 26 | $this->settings = array( |
| 27 | 'title' => array( |
| 28 | 'type' => 'text', |
| 29 | 'std' => __( 'Products', 'woocommerce' ), |
| 30 | 'label' => __( 'Title', 'woocommerce' ), |
| 31 | ), |
| 32 | 'number' => array( |
| 33 | 'type' => 'number', |
| 34 | 'step' => 1, |
| 35 | 'min' => 1, |
| 36 | 'max' => '', |
| 37 | 'std' => 5, |
| 38 | 'label' => __( 'Number of products to show', 'woocommerce' ), |
| 39 | ), |
| 40 | 'show' => array( |
| 41 | 'type' => 'select', |
| 42 | 'std' => '', |
| 43 | 'label' => __( 'Show', 'woocommerce' ), |
| 44 | 'options' => array( |
| 45 | '' => __( 'All products', 'woocommerce' ), |
| 46 | 'featured' => __( 'Featured products', 'woocommerce' ), |
| 47 | 'onsale' => __( 'On-sale products', 'woocommerce' ), |
| 48 | ), |
| 49 | ), |
| 50 | 'orderby' => array( |
| 51 | 'type' => 'select', |
| 52 | 'std' => 'date', |
| 53 | 'label' => __( 'Order by', 'woocommerce' ), |
| 54 | 'options' => array( |
| 55 | 'menu_order' => __( 'Menu order', 'woocommerce' ), |
| 56 | 'date' => __( 'Date', 'woocommerce' ), |
| 57 | 'price' => __( 'Price', 'woocommerce' ), |
| 58 | 'rand' => __( 'Random', 'woocommerce' ), |
| 59 | 'sales' => __( 'Sales', 'woocommerce' ), |
| 60 | ), |
| 61 | ), |
| 62 | 'order' => array( |
| 63 | 'type' => 'select', |
| 64 | 'std' => 'desc', |
| 65 | 'label' => _x( 'Order', 'Sorting order', 'woocommerce' ), |
| 66 | 'options' => array( |
| 67 | 'asc' => __( 'ASC', 'woocommerce' ), |
| 68 | 'desc' => __( 'DESC', 'woocommerce' ), |
| 69 | ), |
| 70 | ), |
| 71 | 'hide_free' => array( |
| 72 | 'type' => 'checkbox', |
| 73 | 'std' => 0, |
| 74 | 'label' => __( 'Hide free products', 'woocommerce' ), |
| 75 | ), |
| 76 | 'show_hidden' => array( |
| 77 | 'type' => 'checkbox', |
| 78 | 'std' => 0, |
| 79 | 'label' => __( 'Show hidden products', 'woocommerce' ), |
| 80 | ), |
| 81 | ); |
| 82 | |
| 83 | parent::__construct(); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Query the products and return them. |
| 88 | * |
| 89 | * @param array $args Arguments. |
| 90 | * @param array $instance Widget instance. |
| 91 | * |
| 92 | * @return WP_Query |
| 93 | */ |
| 94 | public function get_products( $args, $instance ) { |
| 95 | $number = ! empty( $instance['number'] ) ? absint( $instance['number'] ) : $this->settings['number']['std']; |
| 96 | $show = ! empty( $instance['show'] ) ? sanitize_title( $instance['show'] ) : $this->settings['show']['std']; |
| 97 | $orderby = ! empty( $instance['orderby'] ) ? sanitize_title( $instance['orderby'] ) : $this->settings['orderby']['std']; |
| 98 | $order = ! empty( $instance['order'] ) ? sanitize_title( $instance['order'] ) : $this->settings['order']['std']; |
| 99 | $product_visibility_term_ids = wc_get_product_visibility_term_ids(); |
| 100 | |
| 101 | $query_args = array( |
| 102 | 'posts_per_page' => $number, |
| 103 | 'post_status' => 'publish', |
| 104 | 'post_type' => 'product', |
| 105 | 'no_found_rows' => 1, |
| 106 | 'order' => $order, |
| 107 | 'meta_query' => array(), |
| 108 | 'tax_query' => array( |
| 109 | 'relation' => 'AND', |
| 110 | ), |
| 111 | ); // WPCS: slow query ok. |
| 112 | |
| 113 | if ( empty( $instance['show_hidden'] ) ) { |
| 114 | $query_args['tax_query'][] = array( |
| 115 | 'taxonomy' => 'product_visibility', |
| 116 | 'field' => 'term_taxonomy_id', |
| 117 | 'terms' => is_search() ? $product_visibility_term_ids['exclude-from-search'] : $product_visibility_term_ids['exclude-from-catalog'], |
| 118 | 'operator' => 'NOT IN', |
| 119 | ); |
| 120 | $query_args['post_parent'] = 0; |
| 121 | } |
| 122 | |
| 123 | if ( ! empty( $instance['hide_free'] ) ) { |
| 124 | $query_args['meta_query'][] = array( |
| 125 | 'key' => '_price', |
| 126 | 'value' => 0, |
| 127 | 'compare' => '>', |
| 128 | 'type' => 'DECIMAL', |
| 129 | ); |
| 130 | } |
| 131 | |
| 132 | if ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) ) { |
| 133 | $query_args['tax_query'][] = array( |
| 134 | array( |
| 135 | 'taxonomy' => 'product_visibility', |
| 136 | 'field' => 'term_taxonomy_id', |
| 137 | 'terms' => $product_visibility_term_ids[ ProductStockStatus::OUT_OF_STOCK ], |
| 138 | 'operator' => 'NOT IN', |
| 139 | ), |
| 140 | ); // WPCS: slow query ok. |
| 141 | } |
| 142 | |
| 143 | switch ( $show ) { |
| 144 | case 'featured': |
| 145 | $query_args['tax_query'][] = array( |
| 146 | 'taxonomy' => 'product_visibility', |
| 147 | 'field' => 'term_taxonomy_id', |
| 148 | 'terms' => $product_visibility_term_ids['featured'], |
| 149 | ); |
| 150 | break; |
| 151 | case 'onsale': |
| 152 | $product_ids_on_sale = wc_get_product_ids_on_sale(); |
| 153 | $product_ids_on_sale[] = 0; |
| 154 | $query_args['post__in'] = $product_ids_on_sale; |
| 155 | break; |
| 156 | } |
| 157 | |
| 158 | switch ( $orderby ) { |
| 159 | case 'menu_order': |
| 160 | $query_args['orderby'] = 'menu_order'; |
| 161 | break; |
| 162 | case 'price': |
| 163 | $query_args['meta_key'] = '_price'; // WPCS: slow query ok. |
| 164 | $query_args['orderby'] = 'meta_value_num'; |
| 165 | break; |
| 166 | case 'rand': |
| 167 | $query_args['orderby'] = 'rand'; |
| 168 | break; |
| 169 | case 'sales': |
| 170 | $query_args['meta_key'] = 'total_sales'; // WPCS: slow query ok. |
| 171 | $query_args['orderby'] = 'meta_value_num'; |
| 172 | break; |
| 173 | default: |
| 174 | $query_args['orderby'] = 'date'; |
| 175 | } |
| 176 | |
| 177 | return new WP_Query( apply_filters( 'woocommerce_products_widget_query_args', $query_args ) ); |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Output widget. |
| 182 | * |
| 183 | * @param array $args Arguments. |
| 184 | * @param array $instance Widget instance. |
| 185 | * |
| 186 | * @see WP_Widget |
| 187 | */ |
| 188 | public function widget( $args, $instance ) { |
| 189 | if ( $this->get_cached_widget( $args ) ) { |
| 190 | return; |
| 191 | } |
| 192 | |
| 193 | ob_start(); |
| 194 | |
| 195 | wc_set_loop_prop( 'name', 'widget' ); |
| 196 | |
| 197 | $products = $this->get_products( $args, $instance ); |
| 198 | if ( $products && $products->have_posts() ) { |
| 199 | $this->widget_start( $args, $instance ); |
| 200 | |
| 201 | echo wp_kses_post( apply_filters( 'woocommerce_before_widget_product_list', '<ul class="product_list_widget">' ) ); |
| 202 | |
| 203 | $template_args = array( |
| 204 | 'widget_id' => isset( $args['widget_id'] ) ? $args['widget_id'] : $this->widget_id, |
| 205 | 'show_rating' => true, |
| 206 | ); |
| 207 | |
| 208 | while ( $products->have_posts() ) { |
| 209 | $products->the_post(); |
| 210 | wc_get_template( 'content-widget-product.php', $template_args ); |
| 211 | } |
| 212 | |
| 213 | echo wp_kses_post( apply_filters( 'woocommerce_after_widget_product_list', '</ul>' ) ); |
| 214 | |
| 215 | $this->widget_end( $args ); |
| 216 | } |
| 217 | |
| 218 | wp_reset_postdata(); |
| 219 | |
| 220 | echo $this->cache_widget( $args, ob_get_clean() ); // WPCS: XSS ok. |
| 221 | } |
| 222 | } |
| 223 |