-
Notifications
You must be signed in to change notification settings - Fork 0
/
class-wc-tab-manager.php
1164 lines (918 loc) · 33.9 KB
/
class-wc-tab-manager.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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* WooCommerce Tab Manager
*
* This source file is subject to the GNU General Public License v3.0
* that is bundled with this package in the file license.txt.
* It is also available through the world-wide-web at this URL:
* http://www.gnu.org/licenses/gpl-3.0.html
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@skyverge.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade WooCommerce Tab Manager to newer
* versions in the future. If you wish to customize WooCommerce Tab Manager for your
* needs please refer to http://docs.woocommerce.com/document/tab-manager/
*
* @author SkyVerge
* @copyright Copyright (c) 2012-2023, SkyVerge, Inc. (info@skyverge.com)
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
*/
defined( 'ABSPATH' ) or exit;
use \SkyVerge\WooCommerce\PluginFramework\v5_11_0 as Framework;
/**
* WooCommerce Tab Manager main class.
*
* @since 1.0
*/
class WC_Tab_Manager extends Framework\SV_WC_Plugin {
/** plugin version */
const VERSION = '1.16.0';
/** @var \WC_Tab_Manager single instance of this plugin */
protected static $instance;
/** the plugin ID, used for various slugs and such */
const PLUGIN_ID = 'tab_manager';
/** @var array local memoized array of product tabs, keyed off product ID */
private $product_tabs = array();
/** @var array third party tabs */
private $third_party_tabs;
/** @var \WC_Tab_Manager_Search instance */
protected $search;
/** @var \WC_Tab_Manager_Settings instance */
protected $wc_settings;
/** @var \WC_Tab_Manager_Ajax_Events instance */
protected $ajax;
/**
* Sets up the main plugin class.
*
* @since 1.0
*/
public function __construct() {
parent::__construct(
self::PLUGIN_ID,
self::VERSION,
[
'text_domain' => 'woocommerce-tab-manager',
'supports_hpos' => true,
]
);
// allow direct linking to tabs
if ( ! is_admin() ) {
add_action( 'wp', array( $this, 'use_tab_anchor_links' ) );
}
add_filter( 'woocommerce_product_tabs', array( $this, 'setup_tabs' ), 98 );
// allow the use of shortcodes within the tab content
add_filter( 'woocommerce_tab_manager_tab_panel_content', 'do_shortcode' );
add_action( 'wp_print_footer_scripts', array( $this, 'include_js_templates' ) );
add_action( 'admin_print_footer_scripts', array( $this, 'include_js_templates' ) );
}
/**
* Builds the lifecycle handler instance.
*
* @since 1.10.0
*/
protected function init_lifecycle_handler() {
require_once( $this->get_plugin_path() . '/src/Lifecycle.php' );
$this->lifecycle_handler = new SkyVerge\WooCommerce\Tab_Manager\Lifecycle( $this );
}
/**
* Initializes the plugin.
*
* @internal
*
* @since 1.10.0
*/
public function init_plugin() {
add_action( 'init', array( $this, 'init_post_types' ), 20 );
$this->includes();
}
/**
* Includes files required by both the admin and frontend.
*
* @since 1.0
*/
private function includes() {
require_once( $this->get_plugin_path() . '/woocommerce-tab-manager-template.php' );
if ( is_admin() ) {
$this->admin_includes();
}
if ( wp_doing_ajax() ) {
$this->ajax_includes();
}
if ( ! class_exists( 'WC_Tab_Manager_Search' ) ) {
$this->search = $this->load_class( '/src/class-wc-tab-manager-search.php', 'WC_Tab_Manager_Search' );
}
}
/**
* Includes required admin files.
*
* @since 1.0
*/
private function admin_includes() {
// admin functions
include_once( $this->get_plugin_path() . '/admin/woocommerce-tab-manager-admin-functions.php' );
// product tab-specific admin functions
include_once( $this->get_plugin_path() . '/admin/post-types/wc_product_tab.php' );
// product tab meta boxes
include_once( $this->get_plugin_path() . '/admin/post-types/wc_product_tab_metabox.php' );
// default Tab Layout admin screen and persistence code
include_once( $this->get_plugin_path() . '/admin/woocommerce-tab-manager-admin-global-layout.php' );
require_once( $this->get_plugin_path() . '/admin/woocommerce-tab-manager-admin-init.php' );
// custom WooCommerce settings
if ( ! class_exists( 'WC_Tab_Manager_Settings' ) ) {
$this->wc_settings = $this->load_class( '/src/class-wc-tab-manager-settings.php', 'WC_Tab_Manager_Settings' );
}
}
/**
* Includes required ajax files.
*
* @since 1.0
*/
private function ajax_includes() {
if ( ! class_exists( 'WC_Tab_Manager_Ajax_Events' ) ) {
$this->wc_settings = $this->load_class( '/src/class-wc-tab-manager-ajax-events.php', 'WC_Tab_Manager_Ajax_Events' );
}
}
/**
* Returns the tab manager search class instance.
*
* @since 1.6.0
*
* @return \WC_Tab_Manager_Search
*/
public function get_search_instance() {
return $this->search;
}
/**
* Returns the tab manager settings class instance.
*
* @since 1.6.0
*
* @return \WC_Tab_Manager_Settings
*/
public function get_settings_instance() {
return $this->wc_settings;
}
/**
* Returns the tab manager ajax class instance.
*
* @since 1.6.0
*
* @return \WC_Tab_Manager_Ajax_Events
*/
public function get_ajax_instance() {
return $this->ajax;
}
/**
* Includes frontend scripts.
*
* @since 1.8.1
*
* @internal
*/
public function use_tab_anchor_links() {
global $post;
if ( is_product() ) {
$tabs = json_encode( $this->get_product_tabs( $post->ID ) );
// adding an entire frontend js file feels sort of heavy for this, perhaps consider it if we add more js in the future {BR 2017-05-30}
wc_enqueue_js( "
(function() {
var hash = window.location.hash;
var tabs = $( this ).find( '.wc-tabs, ul.tabs' ).first();
var ref = $tabs;
for ( index in ref ) {
tab = ref[index];
/* global tabs */
if ( tab.name && ( hash === '#' + tab.name || hash === '#tab-' + tab.name ) ) {
tabs.find( 'li.' + tab.name + '_tab a' ).trigger( 'click' );
/* third-party tabs */
} else if ( hash === '#' + tab.id || hash === '#tab-' + tab.id ) {
tabs.find( 'li.' + tab.id + '_tab a' ).trigger( 'click' );
}
}
})();
" );
}
}
/**
* Initializes WooCommerce Tab Manager user role.
*
* @since 1.0
*/
private function init_user_roles() {
global $wp_roles;
if ( ! isset( $wp_roles ) && class_exists( 'WP_Roles' ) ) {
$wp_roles = new WP_Roles();
}
// it's fine if this gets executed more than once
if ( is_object( $wp_roles ) ) {
$wp_roles->add_cap( 'shop_manager', 'manage_woocommerce_tab_manager' );
$wp_roles->add_cap( 'administrator', 'manage_woocommerce_tab_manager' );
}
}
/**
* Initializes the tab custom post type.
*
* @since 1.10.0
*
* @internal
*/
public function init_post_types() {
// init user roles
$this->init_user_roles();
// bail if the post type was already registered
if ( post_type_exists( 'wc_product_tab' ) ) {
return;
}
register_post_type( 'wc_product_tab',
array(
'labels' => array(
'name' => __( 'Tabs', 'woocommerce-tab-manager' ),
'singular_name' => __( 'Tab', 'woocommerce-tab-manager' ),
'menu_name' => _x( 'Tab Manager', 'Admin menu name', 'woocommerce-tab-manager' ),
'add_new' => __( 'Add global tab', 'woocommerce-tab-manager' ),
'add_new_item' => __( 'Add new global tab', 'woocommerce-tab-manager' ),
'edit' => __( 'Edit', 'woocommerce-tab-manager' ),
'edit_item' => __( 'Edit tab', 'woocommerce-tab-manager' ),
'new_item' => __( 'New tab', 'woocommerce-tab-manager' ),
'view' => __( 'View tabs', 'woocommerce-tab-manager' ),
'view_item' => __( 'View tab', 'woocommerce-tab-manager' ),
'search_items' => __( 'Search tabs', 'woocommerce-tab-manager' ),
'not_found' => __( 'No tabs found', 'woocommerce-tab-manager' ),
'not_found_in_trash' => __( 'No tabs found in trash', 'woocommerce-tab-manager' ),
),
'description' => __( 'This is where you can add new tabs that you can add to products.', 'woocommerce-tab-manager' ),
'public' => true,
'show_ui' => true,
'capability_type' => 'post',
'capabilities' => array(
'publish_posts' => 'manage_woocommerce_tab_manager',
'edit_posts' => 'manage_woocommerce_tab_manager',
'edit_others_posts' => 'manage_woocommerce_tab_manager',
'delete_posts' => 'manage_woocommerce_tab_manager',
'delete_others_posts' => 'manage_woocommerce_tab_manager',
'read_private_posts' => 'manage_woocommerce_tab_manager',
'edit_post' => 'manage_woocommerce_tab_manager',
'delete_post' => 'manage_woocommerce_tab_manager',
'read_post' => 'manage_woocommerce_tab_manager',
),
'publicly_queryable' => true,
'exclude_from_search' => true,
'show_in_menu' => current_user_can( 'manage_woocommerce' ) ? 'woocommerce' : true,
'hierarchical' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title', 'editor' ),
'show_in_nav_menus' => false,
)
);
}
/**
* Organizes the product tabs as configured within the Tab Manager.
*
* $tabs structure:
* Array(
* id => Array(
* 'title' => (string) Tab title,
* 'priority' => (string) Tab priority,
* 'callback' => (mixed) callback function,
* )
* )
*
* @since 1.0.5
*
* @internal
*
* @param array $tabs array representing the product tabs
* @return array representing the product tabs
*/
public function setup_tabs( $tabs ) {
global $product;
// first off, make sure that we're dealing with an array rather than null
if ( null === $tabs ) {
$tabs = array();
}
$new_tabs = $tabs;
$product_tabs = $product instanceof \WC_Product ? $this->get_product_tabs( $product->get_id() ) : null;
// if product tabs have been configured for this product or globally (otherwise, allow default behavior)
if ( is_array( $product_tabs ) ) {
// start fresh
$new_tabs = array();
// unhook and load any third party tabs that have been added by this point
$third_party_tabs = $this->get_third_party_tabs( $tabs );
foreach ( $product_tabs as $key => $tab ) {
$priority = ( $tab['position'] + 1 ) * 10;
/**
* Filters the tab ID.
*
* @since 1.5.2
*
* @param int|string $tab_id note that this could be a string or integer
*/
$tab_id = apply_filters( 'wc_tab_manager_tab_id', $tab['id'] );
if ( 'core' === $tab['type'] ) {
// the core tabs can be suppressed for a variety of reasons: description tab due to no content, attributes tab due to no attributes, etc
if ( ! isset( $tabs[ $tab_id ] ) ) {
continue;
}
// set the review (comment) count for the reviews tab, if they used the '%d' substitution
if ( 'reviews' === $tab_id && false !== strpos( $tab['title'], '%d' ) ) {
/**
* Filters the review count in the Reviews (%d) tab title.
*
* @since 1.5.2
*
* @param int $review_count array representing the product tabs
* @param \WC_Product the product
*/
$tab['title'] = str_replace( '%d', apply_filters( 'wc_tab_manager_reviews_tab_title_review_count', $product->get_review_count(), $product ), $tab['title'] );
}
// add the core tab to the new tab set
$new_tabs[ $tab_id ] = array(
'title' => $tab['title'], // modified title
'priority' => $priority, // modified priority
'callback' => $tabs[ $tab_id ]['callback'], // get the core tab callback
);
// handle core tab headings (displays just before the tab content)
if ( 'additional_information' === $tab_id ) {
add_filter( 'woocommerce_product_additional_information_heading', array( $this, 'core_tab_heading' ) );
} elseif ( 'description' === $tab_id ) {
add_filter( 'woocommerce_product_description_heading', array( $this, 'core_tab_heading' ) );
}
} elseif ( 'third_party' === $tab['type'] ) {
// third-party provided tab: ensure it's still available
if ( ! isset( $third_party_tabs[ $key ] ) || ( isset( $third_party_tabs[ $key ]['ignore'] ) && true == $third_party_tabs[ $key ]['ignore'] ) ) {
continue;
}
// add the 3rd party tab in with the new priority
$new_tabs[ $tab_id ] = $third_party_tabs[ $key ];
$new_tabs[ $tab_id ]['priority'] = $priority;
// Product/Global tabs:
} else {
$post_id = (int) $tab_id;
$tab_post = get_post( $post_id );
// skip any global/product tabs that have been deleted
if ( ! $tab_post || 'publish' !== $tab_post->post_status || ! $tab_post->post_title ) {
continue;
}
// global tabs
if ( ! $tab_post->post_parent ) {
$product_terms = get_the_terms( $product->get_id(), 'product_cat' );
if ( is_wp_error( $product_terms ) ) {
continue;
}
$tab_cats = get_post_meta( $post_id, '_wc_tab_categories', true );
$product_cats = wp_list_pluck( (array) $product_terms, 'term_id' );
// compare selected categories for the tab vs the product's categories
$cat_check = empty( $tab_cats ) ? array() : array_intersect( $product_cats, $tab_cats );
// Hacky fix for WooCommerce Multilingual conflict -- revisit this in the rewrite {TZ 2016-12-06}
// We try to generate a clean unique tab name using the tab title in wc_tab_manager_process_tabs() and handle
// unicode tab titles there as well (tab switching doesn't work with unicode tab titles). However, sites using
// WooCommerce Multilingual don't benefit from this unicode handling as that function is not run for translated
// tabs. Therefore, we must take into account unicode titles later in the process (right before display)
if ( strlen( $tab_post->post_title ) !== strlen( utf8_encode( $tab_post->post_title ) ) ) {
$tab['name'] = 'global-tab-' . uniqid( '', false );
}
// add the global tab if there are no categories, or if selected ones match this product
if ( ! empty( $cat_check ) || empty( $tab_cats ) ) {
$new_tabs[ $tab['name'] ] = array(
'title' => $tab_post->post_title,
'priority' => $priority,
'callback' => 'woocommerce_tab_manager_tab_content',
'id' => $tab_id,
);
}
} else {
// Hacky fix for WooCommerce Multilingual conflict -- revisit this in the rewrite {TZ 2016-12-06}
// We try to generate a clean unique tab name using the tab title in wc_tab_manager_process_tabs() and handle
// unicode tab titles there as well (tab switching doesn't work with unicode tab titles). However, sites using
// WooCommerce Multilingual don't benefit from this unicode handling as that function is not run for translated
// tabs. Therefore, we must take into account unicode titles later in the process (right before display)
if ( strlen( $tab_post->post_title ) !== strlen( utf8_encode( $tab_post->post_title ) ) ) {
$tab['name'] = 'product-tab-' . uniqid( '', false );
}
// add any product tabs
$new_tabs[ $tab['name'] ] = array(
'title' => $tab_post->post_title,
'priority' => $priority,
'callback' => 'woocommerce_tab_manager_tab_content',
'id' => $tab_id,
);
}
}
}
// finally add in any non-managed 3rd party tabs with their own priority
foreach ( $third_party_tabs as $key => $tab ) {
if ( isset( $tab['ignore'] ) && true === $tab['ignore'] ) {
$new_tabs[ $key ] = $tab;
}
}
}
return apply_filters( 'wc_tab_manager_product_tabs', $new_tabs );
}
/**
* Filter to modify the Description and Additional Information core tab headings.
*
* The heading is not what shows up in the "tab" itself, this is the heading for the tab content area.
*
* @since 1.0
*
* @internal
*
* @param string $heading the tab heading
* @return string the tab heading
*/
public function core_tab_heading( $heading ) {
global $product;
$tabs = $this->get_product_tabs( $product->get_id() );
$current_filter = current_filter();
if ( 'woocommerce_product_additional_information_heading' === $current_filter ) {
$heading = $tabs['core_tab_additional_information']['heading'];
} elseif ( 'woocommerce_product_description_heading' === $current_filter ) {
$heading = $tabs['core_tab_description']['heading'];
}
return $heading;
}
/**
* Returns the main Tab Manager Instance.
*
* Ensures only one instance is/can be loaded.
*
* @since 1.2.0
*
* @return \WC_Tab_Manager
*/
public static function instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Gets any third party tabs which have been added via the `woocommerce_product_tabs action`.
*
* Any third party tabs so found are collected so they can be re-added by the manager in the appropriate order.
* In the admin a human readable title is automatically generated (allowing for automatic integration of 3rd party plugin tabs)
* and three filters are fired to allow for improved integration with customized titles/descriptions:
*
* - woocommerce_tab_manager_integration_tab_allowed: allows plugin to mark tab as not available for management, its priority will not be modified and it will not appear within the Tab Manager Admin UI
* - woocommerce_tab_manager_integration_tab_title: allows plugin to provide a more descriptive tab title to display within the Tab Manager Admin UI
* - woocommerce_tab_manager_integration_tab_description: allows plugin to provide a description to display within the Tab Manager Admin UI
*
* $tabs structure:
* Array(
* key => Array(
* 'title' => (string) Tab title,
* 'priority' => (string) Tab priority,
* 'callback' => (mixed) callback function,
* 'description' => (string) An optional tab description added by this method to the return array,
* 'ignore' => (boolean) Optional marker indicating this tab is not managed by the Tab Manager plugin and added by this method to the return array,
* 'id' => (string) the original tab key,
* )
* )
* Where key is: third_party_tab_{id}
*
* @since 1.0.5
*
* @param array $tabs optional array representing the product tabs
* @return array representing the product tabs
*/
public function get_third_party_tabs( $tabs = null ) {
global $wp_filter;
if ( null === $this->third_party_tabs ) {
// gather the tabs if not provided
if ( null === $tabs ) {
// in WC 2.1+ the woocommerce_default_product_tabs filter (which requires a global $post/$product) is hooked into from the admin so unhook to avoid a fatal error (has no effect in pre WC 2.1)
if ( is_admin() ) {
remove_filter( 'woocommerce_product_tabs', 'woocommerce_default_product_tabs' );
remove_filter( 'woocommerce_product_tabs', 'woocommerce_sort_product_tabs', 99 );
}
$tabs = (array) apply_filters( 'woocommerce_product_tabs', array() );
}
$this->third_party_tabs = array();
// remove the core tabs (if any) leaving only 3rd party tabs (if any)
unset( $tabs['additional_information'], $tabs['reviews'], $tabs['description'] );
foreach ( $tabs as $key => $tab ) {
// is this tab available for management by the Tab Manager plugin?
if ( apply_filters( 'woocommerce_tab_manager_integration_tab_allowed', true, $tab ) ) {
if ( is_admin() ) {
// on the off chance that the 3rd party tab doesn't have a title, provide it a default one based on the callback so it can be identified within the admin
if ( ! isset( $tab['title'] ) || ! $tab['title'] ) {
// get a title for the tab. Default to humanizing the function name, or class name
if ( is_array( $tab['callback'] ) ) {
$tab_title = ( is_object( $tab['callback'][0] ) ? get_class( $tab['callback'][0] ) : $tab['callback'][0] );
} else {
$tab_title = (string) $tab['callback'];
}
$tab_title = ucwords( str_replace( '_', ' ', $tab_title ) );
$tab_title = str_ireplace( array( 'woocommerce', 'wordpress' ), array( 'WooCommerce', 'WordPress' ), $tab_title ); // fix some common words
$tab['title'] = $tab_title;
}
// improved 3rd party integration by allowing plugins to provide a more descriptive title/description for their tabs
$tab['title'] = apply_filters( 'woocommerce_tab_manager_integration_tab_title', $tab['title'], $tab );
$tab['description'] = apply_filters( 'woocommerce_tab_manager_integration_tab_description', '', $tab );
}
$tab['id'] = $key;
} else {
// this tab is not managed by the Tab Manager, so mark it as such
$tab['ignore'] = true;
}
// save the tab
$this->third_party_tabs[ 'third_party_tab_' . $key ] = $tab;
}
}
return $this->third_party_tabs;
}
/**
* Get the default WooCommerce core tabs data structure.
*
* @since 1.0
*
* @return array the core tabs
*/
public function get_core_tabs() {
return array(
'core_tab_description' => array(
'id' => 'description',
'position' => 0,
'type' => 'core',
'title' => __( 'Description', 'woocommerce-tab-manager' ),
'description' => __( 'Displays the product content set in the main content editor.', 'woocommerce-tab-manager' ),
'heading' => __( 'Product Description', 'woocommerce-tab-manager' ),
),
'core_tab_additional_information' => array(
'id' => 'additional_information',
'position' => 1,
'type' => 'core',
'title' => __( 'Additional Information', 'woocommerce-tab-manager' ),
'description' => __( 'Displays the product attributes and properties configured in the Product Data panel.', 'woocommerce-tab-manager' ),
'heading' => __( 'Additional Information', 'woocommerce-tab-manager' ),
),
'core_tab_reviews' => array(
'id' => 'reviews',
'position' => 2,
'type' => 'core',
'title' => __( 'Reviews (%d)', 'woocommerce-tab-manager' ),
'description' => __( 'Displays the product review form and any reviews. Use %d in the Title to substitute the number of reviews for the product.', 'woocommerce-tab-manager' ),
),
);
}
/**
* Gets the product tabs (if any) for the identified product.
*
* If not configured at the product level, the default layout (if any) will be returned.
*
* returned tabs structure:
* Array(
* key => Array(
* 'position' => (int) 0-indexed ordered position from the Tab Manager Admin UI,
* 'type' => (string) one of 'core', 'global', 'third_party' or 'product',
* 'id' => (string) Tab identifier, ie 'description', 'reviews', 'additional_information' for the core tabs, post id for product/global, and woocommerce_product_tabs key for third party tabs,
* 'title' => (string) The tab title to display on the frontend (not used for 3rd party tabs, though it could be),
* 'heading' => (string) Tab heading (core description/additional_information tabs only),
* 'name' => (string) Product/Global tabs only, this is the sanitized title, and is used to key the tab in the final woocommerce tab data structure,
* )
* )
* Where key is: {type}_tab_{id}
*
* @param int $product_id product identifier
* @return array product tabs data
*/
public function get_product_tabs( $product_id ) {
if ( ! isset( $this->product_tabs[ $product_id ] ) ) {
$override_tab_layout = get_post_meta( $product_id, '_override_tab_layout', true );
if ( 'yes' === $override_tab_layout ) {
// product defines its own tab layout?
$this->product_tabs[ $product_id ] = get_post_meta( $product_id, '_product_tabs', true );
} else {
// otherwise, get the default layout if any
$this->product_tabs[ $product_id ] = get_option( 'wc_tab_manager_default_layout', false );
}
}
return $this->product_tabs[ $product_id ];
}
/**
* Gets the product tab or null if the tab cannot be found.
*
* @since 1.0
*
* @param int $product_id product identifier
* @param int $tab_id tab identifier
* @param bool $get_the_content whether to get the tab content and title
* @return array|null tab array, or null
*/
public function get_product_tab( $product_id, $tab_id, $get_the_content = false ) {
$tab = null;
// load the tabs
$this->get_product_tabs( $product_id );
if ( is_array( $this->product_tabs[ $product_id ] ) ) {
foreach ( $this->product_tabs[ $product_id ] as $id => $tab ) {
if ( $tab['id'] == $tab_id ) {
// get the tab content, if needed
if ( $get_the_content && ! isset( $tab['content'] ) ) {
/** this filter is documented in /woocommerce-tab-manager.php */
$tab_id = apply_filters( 'wc_tab_manager_tab_id', $tab_id );
$tab_post = get_post( $tab_id );
$content = apply_filters( 'the_content', $tab_post->post_content );
$content = str_replace( ']]>', ']]>', $content );
$this->product_tabs[ $product_id ][ $id ]['content'] = $content;
$this->product_tabs[ $product_id ][ $id ]['title'] = $tab_post->post_title;
}
$tab = $this->product_tabs[ $product_id ][ $id ];
break;
}
}
}
return apply_filters( 'wc_tab_manager_get_product_tab', $tab, $product_id, $tab_id, $get_the_content );
}
/**
* Processes a batch of products.
*
* @since 1.4.0
*
* @param array $args optional array of arguments
* @return array
*/
public function batch_update_products( array $args = array() ) {
$args = wp_parse_args( $args, array(
'step' => 0,
'limit' => 100,
) );
$step = absint( $args['step'] );
$limit = absint( $args['limit'] );
$offset = $step * $limit;
$product_posts = get_posts( array(
'post_type' => 'product',
'posts_per_page' => $limit,
'offset' => $offset,
) );
$products_count = $offset + count( $product_posts );
$products_total = absint( wp_count_posts( 'product' )->publish );
$response = array(
'complete' => false,
'step' => ++$step,
'offset' => $offset,
'limit' => $limit,
'current' => $products_count,
'total' => $products_total,
);
if ( 1 === $step ) {
$this->get_search_instance()->update_relevanssi_searchable_tab_meta();
$this->get_search_instance()->maybe_build_relevanssi_index();
}
// loop through the current set of products
foreach ( $product_posts as $product_post ) {
// get any tabs associated with the current product.
$tabs = $this->get_product_tabs( $product_post->ID );
if ( ! empty( $tabs ) ) {
// if any tabs were found, update the tab content meta for the current product
$tab_id_list = wp_list_pluck( array_values( $tabs ), 'id' );
$tab_id_list = array_filter( $tab_id_list, 'is_numeric' );
$args = array(
'target' => 'custom',
'action' => 'update',
'product_id' => $product_post->ID,
);
$this->get_search_instance()->update_products_for_tabs( $tab_id_list, $args );
// also update the Relevanssi index for the current product if the plugin is installed
$this->get_search_instance()->update_relevanssi_index_for_product( $product_post->ID );
}
}
// we've processed all of the products
if ( $products_count >= $products_total ) {
$response['complete'] = true;
}
return $response;
}
/**
* Includes JavaScript templates to be used in admin context.
*
* @since 1.4.0
*
* @internal
*/
public function include_js_templates() {
if ( is_admin() ) {
include_once( $this->get_plugin_path() . '/templates/js/admin.tmpl.php' );
}
}
/**
* Tries to determine the current post type based on available global values.
*
* Useful for when you need to determine if a specific post type is being edited on an admin page or when you need to know the post type in an action callback but the action is fired before `get_post_type()` has been defined.
*
* @since 1.4.0
*
* @return string|bool the current post type if one was found or false if not
*/
public function get_current_post_type() {
global $post, $typenow, $current_screen;
if ( isset( $post->post_type ) ) {
$post_type = $post->post_type;
} elseif ( $typenow ) {
$post_type = $typenow;
} elseif ( $current_screen && $current_screen->post_type ) {
$post_type = $current_screen->post_type;
} elseif ( isset( $_REQUEST['post_type'] ) ) {
$post_type = sanitize_key( $_REQUEST['post_type'] );
} else {
$post_type = false;
}
return $post_type;
}
/**
* Tries to determine the current product ID based on context.
*
* If a product is being edited, that product's ID is used.
* If a product-level tab is being edited, the parent product's ID is used.
*
* @since 1.4.0
*
* @return int|false the current product ID if one was found or false if not
*/
public function maybe_get_tab_product_id() {
global $post;
$product_id = false;
$post_type = $this->get_current_post_type();
if ( 'product' === $post_type ) {
$product_id = $post->ID;
} elseif ( 'wc_product_tab' === $post_type ) {
if ( isset( $post->post_parent ) ) {
$product_id = $post->post_parent;
}
}
return $product_id;
}
/**
* Extracts numeric IDs from an array.
*
* @since 1.4.0
*
* @param array $id_list an array where each value is either a numeric ID or an associative array where at least one of the following keys has a numeric value: 'tab_ID', 'tab_id', 'post_ID', 'post_id', 'ID', or 'id'
* @return array an array containing the extracted integer IDs.
*/
public function get_numeric_ids( array $id_list ) {
$valid_ids = array();
foreach ( array_values( $id_list ) as $value ) {
// if the current value is an array, check commonly-used key names to see if we can find a numeric ID somewhere
if ( is_array( $value ) ) {
$id_keys = array( 'tab_ID', 'tab_id', 'post_ID', 'post_id', 'ID', 'id' );
foreach ( $id_keys as $key ) {
$id = isset( $value[ $key ] ) ? $value[ $key ] : null;
if ( ! $id || ! is_numeric( $id ) ) {
continue;
}
// Stop once we find a valid ID.
$valid_ids[] = absint( $id );
break;
}
continue;
}
// bail if the current value isn't numeric
if ( ! is_numeric( $value ) ) {
continue;
}
$valid_ids[] = absint( $value );
}
// remove any duplicate or falsy values
$valid_ids = array_filter( array_unique( $valid_ids ) );
return $valid_ids;
}
/**
* Verifies that the post ID / object / array passed corresponds to an existing post and, if so, returns the WP_Post instance.
*
* @since 1.4.0
*
* @param int|\WP_Post|array|object $post a \WP_Post instance, numeric post ID, object, or array: if an object or array is passed it should match the structure of a WP_Post and contain all of the same data (or at least the data that you need returned)
* @return false|\WP_Post|bool post object if it exists or false if not found
*/
public function ensure_post( $post = null ) {
// If no post data was passed return the current global instance.
if ( empty( $post ) && $GLOBALS['post'] ) {
return $GLOBALS['post'];