forked from kathyisawesome/wc-mnm-categories
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wc-mnm-categories.php
455 lines (354 loc) · 13.1 KB
/
wc-mnm-categories.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 - Categories
* Plugin URI: https://woocommerce.com/products/woocommerce-mix-and-match-products/
* Description: Add products as mix and match options by product category.
* Version: 1.0.0-rc-4
* Author: Kathy Darling
* Author URI: http://kathyisawesome.com/
*
* Text Domain: wc-mnm-categories
* Domain Path: /languages/
*
* Requires at least: 5.1.0
* Tested up to: 5.3.0
*
* WC requires at least: 3.6.0
* WC tested up to: 4.2.0
*
* Copyright: © 2019 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_Categories {
/**
* Plugin version.
*/
const VERSION = '1.0.0-rc-3';
/**
* Min required MNM version.
*
* @var string
*/
const REQ_MNM_VERSION = '1.6.0';
/**
* 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__ ) );
}
/**
* Fire in the hole!
*/
public static function init() {
// Load translation files.
add_action( 'init', array( __CLASS__, 'load_plugin_textdomain' ) );
// Check dependencies.
if ( ! function_exists( 'WC_Mix_and_Match' ) || version_compare( WC_Mix_and_Match()->version, self::REQ_MNM_VERSION ) < 0 ) {
add_action( 'admin_notices', array( __CLASS__, 'version_notice' ) );
return false;
}
/*
* Admin.
*/
// Admin sripts
add_action( 'admin_enqueue_scripts', array( __CLASS__, 'admin_scripts' ) );
// Add extra meta.
add_action( 'woocommerce_mnm_product_options', array( __CLASS__, 'additional_container_option') , 15, 2 );
add_action( 'woocommerce_mnm_product_options', array( __CLASS__, 'add_container_category_contents_option') , 15, 2 );
add_action( 'woocommerce_admin_process_product_object', array( __CLASS__, 'process_meta' ), 20 );
add_filter( 'wc_mnm_display_empty_container_error', array( __CLASS__, 'suppress_container_error' ), 10, 2 );
/*
* Product.
*/
add_filter( 'woocommerce_product_get_contents', array( __CLASS__, 'get_category_contents' ), 10, 2 );
add_filter( 'woocommerce_mnm_get_children', array( __CLASS__, 'get_category_children' ), 10, 2 );
/*
* Display.
*/
add_action( 'woocommerce_before_mnm_items', array( __CLASS__, 'first_category_caption' ), -10 );
add_action( 'woocommerce_mnm_child_item_details', array( __CLASS__, 'change_category_caption' ), -10, 2 );
}
/*-----------------------------------------------------------------------------------*/
/* Localization */
/*-----------------------------------------------------------------------------------*/
/**
* Make the plugin translation ready
*
* @return void
*/
public static function load_plugin_textdomain() {
load_plugin_textdomain( 'wc-mnm-categories' , false , dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}
/*-----------------------------------------------------------------------------------*/
/* Admin */
/*-----------------------------------------------------------------------------------*/
/**
* Load the product metabox script.
*/
public static function admin_scripts() {
// Get admin screen id.
$screen = get_current_screen();
$screen_id = $screen ? $screen->id : '';
$suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
$version = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? time() : self::VERSION;
// WooCommerce product admin page.
if ( 'product' === $screen_id ) {
wp_enqueue_script( 'wc_mnm_categories_writepanel', self::plugin_url() . '/assets/js/wc-mnm-categories-metabox' . $suffix . '.js', array( 'jquery', 'wc-enhanced-select' ), $version, true );
}
}
/**
* Add a notice if versions not met.
*/
public static function version_notice() {
echo '<div class="error"><p>' . sprintf( __( '<strong>WooCommerce Mix & Match: Categories is inactive.</strong> The %sWooCommerce Mix and Match plugin%s must be active and at least version %s for Categories mini-extension to function. Please upgrade or activate WooCommerce Mix and Match.', 'wc-mnm-categories' ), '<a href="https://woocommerce.com/products/woocommerce-mix-and-match-products/">', '</a>', self::REQ_MNM_VERSION ) . '</p></div>';
}
/**
* Adds the 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 ) {
woocommerce_wp_radio(
array(
'id' => 'mnm_use_category',
'class' => 'select short mnm_use_category',
'label' => __( 'Use product category', 'wc-mnm-categories' ),
'value' => $mnm_product_object->get_meta( '_mnm_use_category' ) === 'yes' ? 'yes' : 'no',
'options' => array(
'no' => __( 'Use default', 'wc-mnm-categories' ),
'yes' => __( 'Use Product Categories for contents', 'wc-mnm-categories' )
)
)
);
}
/**
* Adds the writepanel options.
*
* @param int $post_id
* @param WC_Product_Mix_and_Match $mnm_product_object
*/
public static function add_container_category_contents_option( $post_id, $mnm_product_object ) { ?>
<p class="form-field mnm_product_cat_field">
<label for="mnm_allowed_contents"><?php _e( 'Mix and Match product categories', 'wc-mnm-categories' ); ?></label>
<?php
// Generate some data for the select2 input.
$selected_cats = self::get_categories( $mnm_product_object );
?>
<select id="mnm_product_cat" class="wc-category-search" name="mnm_product_cat[]" multiple="multiple" style="width: 400px;" data-sortable="sortable" data-placeholder="<?php esc_attr_e( 'Search for a category…', 'wc-mnm-categories' ); ?>" data-action="woocommerce_json_search_categories" data-allow_clear="true">
<?php
foreach ( $selected_cats as $slug ) {
$current_cat = get_term_by( 'slug', $slug, 'product_cat' );
if ( $current_cat && ! is_wp_error( $current_cat ) ) {
echo '<option value="' . esc_attr( $current_cat->slug ) . '"' . selected( true, true, false ) . '>' . wp_kses_post( $current_cat->name ) . '</option>';
}
}
?>
</select>
</p>
<?php
}
/**
* Saves the new meta field.
*
* @param WC_Product_Mix_and_Match $product
*/
public static function process_meta( $product ) {
if( isset( $_POST[ 'mnm_use_category' ] ) && $_POST[ 'mnm_use_category' ] === 'yes' ) {
$product->update_meta_data( '_mnm_use_category', 'yes' );
} else {
$product->delete_meta_data( '_mnm_use_category' );
}
if( isset( $_POST[ 'mnm_product_cat' ] ) ) {
$meta = array_map( 'sanitize_title', $_POST[ 'mnm_product_cat' ] );
$product->update_meta_data( '_mnm_product_cat', $meta );
} elseif ( 'yes' === $product->get_meta( '_mnm_use_category' ) ) {
WC_Admin_Meta_Boxes::add_error( __( 'Please select at least one category to use for this Mix and Match product.', 'wc-mnm-categories' ) );
}
}
/**
* Saves the new meta field.
*
* @param bool $display_error
* @param WC_Product_Mix_and_Match $product
* @return bool
*/
public static function suppress_container_error( $display_error, $product ) {
if( isset( $_POST[ 'mnm_use_category' ] ) && $_POST[ 'mnm_use_category' ] === 'yes' ) {
$display_error = false;
}
return $display_error;
}
/*-----------------------------------------------------------------------------------*/
/* Front End Display */
/*-----------------------------------------------------------------------------------*/
/**
* Ensure the contents prop is empty. We will get the children directly.
*
* @param array $contents an array of product IDs
* @param obj $container_product WC_Product_Mix_and_Match
* @return array
*/
public static function get_category_contents( $contents, $container_product ) {
if( ! is_admin() && self::use_categories( $container_product ) ) {
$contents = array();
}
return $contents;
}
/**
* Get the product IDs from a product category
*
* @param array $children an array of products
* @param obj $container_product WC_Product_Mix_and_Match
* @return array
*/
public static function get_category_children( $children, $container_product ) {
if( self::is_frontend_request() && self::use_categories( $container_product ) ) {
$new_children = array();
$categories = self::get_categories( $container_product );
foreach( self::get_categories( $container_product ) as $cat_slug ) {
$cat_contents = self::get_cat_contents( $cat_slug );
foreach ( $cat_contents as $mnm_item_id ) {
$child_product = $container_product->get_child( $mnm_item_id );
$child_product->mnm_category = $cat_slug;
// Products that show up later in another category, get skipped.
if ( ! isset( $new_children[ $mnm_item_id ] ) ) {
$new_children[ $mnm_item_id ] = $child_product;
}
}
}
$children = ! empty( $new_children ) ? $new_children : $children;
}
return $children;
}
/**
* The category caption
*
* @param obj $container_product WC_Product_Mix_and_Match
*/
public static function first_category_caption( $container_product ) {
if( self::use_multi_cat( $container_product ) ) {
$categories = self::get_categories( $container_product );
$category = get_term_by( 'slug', array_shift( $categories ), 'product_cat' );
if( $category && ! is_wp_error( $category ) ) {
echo '<div class="products categories-wrapper">';
add_action( 'woocommerce_after_mnm_items', array( __CLASS__, 'close_wrapper' ), 200 );
// Stash the current category.
$container_product->current_cat = $category->slug;
// Don't display the category count.
add_filter( 'woocommerce_subcategory_count_html', '__return_null' );
// Use the existing category title template.
woocommerce_template_loop_category_title( $category );
}
}
}
/**
* Insert a category break if the category has changed.
*
* @param obj $child_product WC_Product
* @param obj $container_product WC_Product_Mix_and_Match
*/
public static function change_category_caption( $child_product, $container_product ) {
if( self::use_multi_cat( $container_product ) ) {
if( property_exists ( $container_product, 'current_cat' ) && $container_product->current_cat !== $child_product->mnm_category ) {
$new_category = get_term_by( 'slug', $child_product->mnm_category, 'product_cat' );
if( $new_category && ! is_wp_error( $new_category ) ) {
wc_mnm_template_child_items_wrapper_close( $container_product );
woocommerce_template_loop_category_title( $new_category );
wc_mnm_template_child_items_wrapper_open( $container_product );
}
// Update the current state of the parent container.
$container_product->current_cat = $child_product->mnm_category;
}
}
}
/**
* Close the wrapping div
*
* @param obj $container_product WC_Product_Mix_and_Match
*/
public static function close_wrapper( $container_product ) {
echo '</div>';
}
/*-----------------------------------------------------------------------------------*/
/* Helpers */
/*-----------------------------------------------------------------------------------*/
/**
* Does this product use categories?
*
* @param WC_Product $product
* @return bool
*/
public static function use_categories( $product ) {
return 'yes' === $product->get_meta( '_mnm_use_category' ) && ! empty( self::get_categories( $product ) );
}
/**
* Does this product use multiple categories?
*
* @param WC_Product $product
* @return bool
*/
public static function use_multi_cat( $product ) {
return 'yes' === $product->get_meta( '_mnm_use_category' ) && count( self::get_categories( $product ) ) > 1;
}
/**
* Get the categories, ensure they're an array.
*
* @param WC_Product $product
* @return array
*/
public static function get_categories( $product ) {
$categories = $product->get_meta( '_mnm_product_cat' );
// Old data was stored as integer, convert to slug.
if( is_integer( $categories ) ) {
$term = get_term_by( 'id', $categories, 'product_cat' );
$categories = $term && ! is_wp_error( $term ) ? $term->slug : array();
}
return (array) $categories ;
}
/**
* Get the categeory's contents.
*
* @param string $cat the category slug
* @return array
*/
public static function get_cat_contents( $cat ) {
$args = apply_filters( 'wc_mnm_categories_get_cat_content_args',
array(
'type' => WC_Mix_and_Match_Helpers::get_supported_product_types(),
'category' => array( $cat ),
'orderby' => 'title',
'order' => 'ASC',
'return' => 'ids',
'limit' => -1
)
);
return wc_get_products( $args );
}
/**
* Determines if the current request is for the frontend.
*
* The logic in this function is based off WooCommerce::is_request( 'frontend' ).
*
* @return bool True if it's a frontend request, false otherwise.
*/
public static function is_frontend_request() {
return ( ! is_admin() || defined( 'DOING_AJAX' ) ) && ! defined( 'DOING_CRON' ) && ! WC()->is_rest_api_request();
}
}
add_action( 'plugins_loaded', array( 'WC_MNM_Categories', 'init' ) );