-
Notifications
You must be signed in to change notification settings - Fork 1
/
wc-mnm-filter.php
455 lines (362 loc) · 13.1 KB
/
wc-mnm-filter.php
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<?php
/**
* Plugin Name: WooCommerce Mix and Match - Filter by Terms
* Plugin URI: https://woocommerce.com/products/woocommerce-mix-and-match-products
* Description: Dynmamic Term Filtering for WooCommerce Mix and Match Products.
* Version: 2.1.0
* Author: Kathy Darling
* Author URI: http://kathyisawesome.com/
*
* Text Domain: wc-mnm-filter
* Domain Path: /languages/
*
* Requires at least: 5.8
* Tested up to: 6.0
*
* WC requires at least: 7.0.0
* WC tested up to: 7.5.0
*
* GitHub Plugin URI: https://github.com/wc-mnm-filter
* Primary Branch: trunk
* Release Asset: true
*
* Copyright: © 2023 Kathy Darling
* License: GNU General Public License v3.0
* License URI: http://www.gnu.org/licenses/gpl-3.0.html
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
class WC_MNM_Filter {
/**
* Plugin version.
*
* @var string
*/
public static $version = '2.1.0';
/**
* Required MNM Plugin version.
*
* @var string
*/
private static $required_mnm = '2.4.0';
/**
* Product Taxonomies.
*
* @var array
*/
private static $product_taxonomies = array();
/**
* Filter taxonomy.
*
* @var array
*/
private static $taxonomy = '';
/**
* Fire in the hole!
*/
public static function init() {
add_action( 'plugins_loaded', array( __CLASS__, 'load_plugin' ), 20 );
}
/**
* Hooks.
*/
public static function load_plugin() {
/*
* Admin.
*/
// Load translation files.
add_action( 'init', array( __CLASS__, 'load_plugin_textdomain' ) );
if ( ! is_callable( array( 'WC_MNM_Compatibility', 'is_version_gte' ) ) || ! WC_MNM_Compatibility::is_version_gte( '2.0' ) ) {
add_action( 'admin_notices', function() {
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
// Translators: %1$s = Plugin name, %2$s = Plugin version, %2$s = Required Mix and Match Plugin version.
$message = '<p>' . sprintf( esc_html__( 'To function properly, %1$s %2$s requires WooCommerce Mix and Match version %3$s', 'wc-mnm-filter' ), '<strong>' . esc_html( 'WooCommerce Mix and Match - Filter by Terms', 'wc-mnm-filter' ) . '</strong>', self::$version, self::$required_mnm ) . '</p>';
echo '<div class="notice notice-error">' . wp_kses_post( $message ) . '</div>';
} );
return false;
}
// Add extra meta.
add_action( 'wc_mnm_admin_product_options', array( __CLASS__, 'additional_container_option' ) , 7, 2 );
// Save extra meta.
add_action( 'woocommerce_admin_process_product_object', array( __CLASS__, 'process_meta' ), 20 );
// Display the filter and add term to product class.
add_action( 'wc_mnm_content_loop', array( __CLASS__, 'add_filter_navigation' ), 5 );
add_action( 'wc_mnm_before_child_items', array( __CLASS__, 'add_product_class_filter' ) );
add_action( 'wc_mnm_after_child_items', array( __CLASS__, 'remove_product_class_filter' ) );
// Add data to <form> for consumption by script.
add_action( 'wc_mnm_container_data_attributes', array( __CLASS__, 'container_data_attributes' ), 10, 2 );
// Register Scripts.
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'register_scripts' ) );
// Display Scripts.
add_action( 'woocommerce_mix-and-match_add_to_cart', array( __CLASS__, 'load_scripts' ) );
add_action( 'woocommerce_grouped-mnm_add_to_cart', array( __CLASS__, 'load_scripts' ) );
// QuickView support.
add_action( 'wc_quick_view_enqueue_scripts', array( __CLASS__, 'load_scripts' ) );
// Declare Features compatibility.
add_action( 'before_woocommerce_init', array( __CLASS__, 'declare_features_compatibility' ) );
}
/*-----------------------------------------------------------------------------------*/
/* Localization */
/*-----------------------------------------------------------------------------------*/
/**
* Make the plugin translation ready
*
* @return void
*/
public static function load_plugin_textdomain() {
load_plugin_textdomain( 'wc-mnm-filter' , false , dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}
/*-----------------------------------------------------------------------------------*/
/* Admin */
/*-----------------------------------------------------------------------------------*/
/**
* Adds the container max weight option writepanel options.
*
* @param int $post_id
* @param WC_Product_Mix_and_Match $mnm_product_object
*/
public static function additional_container_option( $post_id, $mnm_product_object ) {
$value = $mnm_product_object->get_meta( '_mnm_filter', true );
// Previous version was strictly categories so convert.
$value = $value === 'yes' ? 'product_cat' : $value;
woocommerce_wp_select( array(
'id' => '_mnm_filter',
'label' => __( 'Filter container options by taxonomy', 'wc-mnm-filter' ),
'options' => self::get_product_taxonomies(),
'value' => $value
) );
}
/**
* Saves the new meta field.
*
* @param WC_Product_Mix_and_Match $product
*/
public static function process_meta( $product ) {
if ( isset( $_POST[ '_mnm_filter' ] ) && array_key_exists( $_POST[ '_mnm_filter' ], self::get_product_taxonomies() ) ) {
$product->update_meta_data( '_mnm_filter', sanitize_text_field( $_POST[ '_mnm_filter' ] ) );
} else {
$product->delete_meta_data( '_mnm_filter' );
}
}
/*-----------------------------------------------------------------------------------*/
/* Front End Display */
/*-----------------------------------------------------------------------------------*/
/**
* Maybe use the plugin's template version
*
* @param WC_Product_Mix_and_Match $product
*/
public static function add_filter_navigation( $product ) {
if ( $product->is_type( 'mix-and-match' ) && ( $taxonomy = $product->get_meta( '_mnm_filter', true ) ) ) {
if ( apply_filters( 'wc_mnm_filter_display_inline_styles', true, $product ) ) {
?>
<style type="text/css">
.mnm_filter_button_group .mnm_filters {
margin-bottom: 2em;
padding: 0;
list-style: none;
overflow: hidden;
width: 100%;
display: flex;
flex-wrap: wrap;
justify-content: space-between;
gap: .5em;
gap: .5em 1em; /* row-gap column gap */
row-gap: .5em;
column-gap: 1em;
}
.mnm_filter_button_group .mnm_filters button {
flex-grow: 1;
flex-shrink: 0;
flex-basis: calc(100% / 3 - 1rem);
opacity: .5;
}
.mnm_filter_button_group .mnm_filters button:focus {
background-color: var(--wp--preset--color--contrast);
outline-style: none;
}
.mnm_filter_button_group .mnm_filters button.selected {
opacity: 1;
}
@media only screen and (min-width: 380px) {
/* full-width layout adjustment */
.summary-add-to-cart-form-mnm .mnm_filter_button_group .mnm_filters button {
flex-basis: calc(100% / 6 - 1rem);
}
}
</style>
<?php
}
// Load the navigation template.
wc_get_template(
'single-product/mnm/options-filter.php',
array(
'container' => $product,
'layout' => $product->get_layout(),
'taxonomy' => $taxonomy,
'terms' => get_terms( $taxonomy, array( 'orderby' => 'name' ) )
),
'',
self::plugin_path() . '/templates/'
);
}
}
/**
* Add the woocommerce_post_class filter
*
* @param WC_Product_Mix_and_Match $product
*/
public static function add_product_class_filter( $product ) {
$taxonomy = $product->get_meta( '_mnm_filter', true );
if ( $taxonomy ) {
self::$taxonomy = $taxonomy;
add_filter( 'woocommerce_post_class', array( __CLASS__, 'term_classes' ), 10, 3 );
}
}
/**
* Remove the woocommerce_post_class filter
*
* @param WC_Product_Mix_and_Match $product
*/
public static function remove_product_class_filter( $product ) {
remove_filter( 'woocommerce_post_class', array( __CLASS__, 'term_classes' ), 10, 3 );
self::$taxonomy = '';
}
/**
* Add attributes to the children's woocommerce_post_class
*
* @param array $classes Array of CSS classes.
* @param WC_Product $product Product object.
* @return array
*/
public static function term_classes( $classes, $product ) {
if ( self::$taxonomy ) {
$new_classes = array();
// Include attributes and any extra taxonomies only if enabled via the hook - this is a performance issue.
if ( false === apply_filters( 'woocommerce_get_product_class_include_taxonomies', false ) ) {
$taxonomies = self::get_product_taxonomies();
$type = 'variation' === $product->get_type() ? 'product_variation' : 'product';
if ( is_object_in_taxonomy( $type, self::$taxonomy ) && ! in_array( self::$taxonomy, array( 'product_cat', 'product_tag' ), true ) ) {
$new_classes = wc_get_product_taxonomy_class( (array) get_the_terms( $product->get_id(), self::$taxonomy ), self::$taxonomy );
}
}
// If variation.
if ( $product->get_parent_id() > 0 ) {
$attributes = $product->get_attributes();
// If it's a variation's attribute then use that.
if ( array_key_exists( self::$taxonomy, $attributes ) ) {
$new_classes = array( self::$taxonomy . '-'. strtolower( $product->get_attribute( self::$taxonomy ) ) );
} else {
// Else inherit the parent's terms.
$new_classes = wc_get_product_taxonomy_class( (array) get_the_terms( $product->get_parent_id(), self::$taxonomy ), self::$taxonomy );
}
}
if ( ! empty( $new_classes ) ) {
$classes = array_merge( $classes, $new_classes );
}
}
return $classes;
}
/**
* Add some props to the form class for script data.
*
* @since 2.1.0
*
* @param array $attributes
* @param obj WC_Product_Mix_and_Match $this
* @return array
*/
public static function container_data_attributes( $attributes, $product ) {
$attributes['filter-columns'] = apply_filters( 'woocommerce_mnm_grid_layout_columns', 3, $product );
$attributes['filter-multi_terms' ] = apply_filters( 'wc_mnm_filters_support_multi_term_filtering', false, $product );
return $attributes;
}
/*-----------------------------------------------------------------------------------*/
/* Scripts and Styles */
/*-----------------------------------------------------------------------------------*/
/**
* Register scripts
*
* @return void
*/
public static function register_scripts() {
$suffix = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
$script_path = 'assets/js/frontend/wc-mnm-filter' . $suffix . '.js';
$script_url = plugins_url( $script_path, __FILE__ );
$script_version = WC_Mix_and_Match()->get_file_version( plugin_dir_path( __FILE__ ) . $script_path, self::$version );
wp_register_script( 'wc-mnm-filter', $script_url, array( 'wc-add-to-cart-mnm' ), $script_version, true );
$l10n = array(
'i18n_no_matches' => esc_html__( 'No matching products were found', 'wc-mnm-filter' ),
);
wp_localize_script( 'wc-mnm-filter', 'WC_MNM_FILTER_PARAMS', $l10n );
}
/**
* Load the script anywhere the MNN add to cart button is displayed
* @return void
*/
public static function load_scripts() {
wp_enqueue_script( 'wc-mnm-filter' );
}
/*-----------------------------------------------------------------------------------*/
/* Core Compat */
/*-----------------------------------------------------------------------------------*/
/**
* Declare Features compatibility.
*
*/
public static function declare_features_compatibility() {
if ( ! class_exists( 'Automattic\WooCommerce\Utilities\FeaturesUtil' ) ) {
return;
}
// HPOS (Custom Order tables) compatibility.
\Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility( 'custom_order_tables', plugin_basename( __FILE__ ), true );
// Cart and Checkout Blocks.
\Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility( 'cart_checkout_blocks', plugin_basename( __FILE__ ), true );
}
/*-----------------------------------------------------------------------------------*/
/* Helper Functions */
/*-----------------------------------------------------------------------------------*/
/**
* Plugin URL.
*
* @return string
*/
public static function plugin_url() {
return plugins_url( basename( plugin_dir_path( __FILE__ ) ), basename(__FILE__) );
}
/**
* Plugin path.
*
* @return string
*/
public static function plugin_path() {
return untrailingslashit( plugin_dir_path( __FILE__ ) );
}
/**
* Fetch and stash the taxonomies for products.
*
* @param int $post_id
* @param WC_Product_Mix_and_Match $mnm_product_object
*/
public static function get_product_taxonomies() {
if ( empty( self::$product_taxonomies ) ) {
$args = array(
'object_type' => array( 'product' ),
);
// Product Addons support.
if ( class_exists( 'WC_Product_Addons' ) ) {
$args['object_type'][] = 'global_product_addon';
}
$taxonomies = get_taxonomies( $args, 'object' );
unset( $taxonomies['product_type'] );
$taxonomies = wp_list_pluck( $taxonomies, 'label', 'name' );
self::$product_taxonomies = array_merge( array( '' => __( 'No filter', 'wc-mnm-filter' ) ), $taxonomies );
}
return self::$product_taxonomies;
}
}
WC_MNM_Filter::init();