-
Notifications
You must be signed in to change notification settings - Fork 145
/
custom-post-type-ui.php
1129 lines (995 loc) · 37.7 KB
/
custom-post-type-ui.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
/**
* Custom Post Type UI.
*
* For all your post type and taxonomy needs.
*
* @package CPTUI
* @subpackage Loader
* @author WebDevStudios
* @since 0.1.0.0
* @license GPL-2.0+
*/
/**
* Plugin Name: Custom Post Type UI
* Plugin URI: https://github.com/WebDevStudios/custom-post-type-ui/
* Description: Admin UI panel for registering custom post types and taxonomies
* Author: WebDevStudios
* Version: 1.17.1
* Author URI: https://webdevstudios.com/
* Text Domain: custom-post-type-ui
* Domain Path: /languages
* License: GPL-2.0+
* Requires at least: 6.5
* Requires PHP: 7.4
*/
// phpcs:disable WebDevStudios.All.RequireAuthor
// phpcs:set WordPress.WP.I18n check_translator_comments false
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
define( 'CPT_VERSION', '1.17.1' ); // Left for legacy purposes.
define( 'CPTUI_VERSION', '1.17.1' );
define( 'CPTUI_WP_VERSION', get_bloginfo( 'version' ) );
/**
* Load our Admin UI class that powers our form inputs.
*
* @since 1.0.0
*
* @internal
*/
function cptui_load_ui_class() {
require_once plugin_dir_path( __FILE__ ) . 'classes/class.cptui_admin_ui.php';
require_once plugin_dir_path( __FILE__ ) . 'classes/class.cptui_debug_info.php';
}
add_action( 'init', 'cptui_load_ui_class' );
/**
* Set a transient used for redirection upon activation.
*
* @since 1.4.0
*/
function cptui_activation_redirect() {
// Bail if activating from network, or bulk.
if ( is_network_admin() ) {
return;
}
// Add the transient to redirect.
set_transient( 'cptui_activation_redirect', true, 30 );
}
add_action( 'activate_' . plugin_basename( __FILE__ ), 'cptui_activation_redirect' );
/**
* Redirect user to CPTUI about page upon plugin activation.
*
* @since 1.4.0
*/
function cptui_make_activation_redirect() {
if ( ! get_transient( 'cptui_activation_redirect' ) ) {
return;
}
delete_transient( 'cptui_activation_redirect' );
// Bail if activating from network, or bulk.
if ( is_network_admin() ) {
return;
}
if ( ! cptui_is_new_install() ) {
return;
}
// Redirect to CPTUI about page.
wp_safe_redirect(
add_query_arg(
[ 'page' => 'cptui_main_menu' ],
cptui_admin_url( 'admin.php?page=cptui_main_menu' )
)
);
}
add_action( 'admin_init', 'cptui_make_activation_redirect', 1 );
/**
* Flush our rewrite rules on deactivation.
*
* @since 0.8.0
*
* @internal
*/
function cptui_deactivation() {
flush_rewrite_rules();
}
register_deactivation_hook( __FILE__, 'cptui_deactivation' );
/**
* Register our text domain.
*
* @since 0.8.0
*
* @internal
*/
function cptui_load_textdomain() {
load_plugin_textdomain( 'custom-post-type-ui' );
}
add_action( 'init', 'cptui_load_textdomain' );
/**
* Load our main menu.
*
* Submenu items added in version 1.1.0
*
* @since 0.1.0
*
* @internal
*/
function cptui_plugin_menu() {
/**
* Filters the required capability to manage CPTUI settings.
*
* @since 1.3.0
*
* @param string $value Capability required.
*/
$capability = apply_filters( 'cptui_required_capabilities', 'manage_options' );
$parent_slug = 'cptui_main_menu';
add_menu_page( esc_html__( 'Custom Post Types', 'custom-post-type-ui' ), esc_html__( 'CPT UI', 'custom-post-type-ui' ), $capability, $parent_slug, 'cptui_settings', cptui_menu_icon() );
add_submenu_page( $parent_slug, esc_html__( 'Add/Edit Post Types', 'custom-post-type-ui' ), esc_html__( 'Add/Edit Post Types', 'custom-post-type-ui' ), $capability, 'cptui_manage_post_types', 'cptui_manage_post_types' );
add_submenu_page( $parent_slug, esc_html__( 'Add/Edit Taxonomies', 'custom-post-type-ui' ), esc_html__( 'Add/Edit Taxonomies', 'custom-post-type-ui' ), $capability, 'cptui_manage_taxonomies', 'cptui_manage_taxonomies' );
add_submenu_page( $parent_slug, esc_html__( 'Registered Types and Taxes', 'custom-post-type-ui' ), esc_html__( 'Registered Types/Taxes', 'custom-post-type-ui' ), $capability, 'cptui_listings', 'cptui_listings' );
add_submenu_page( $parent_slug, esc_html__( 'Custom Post Type UI Tools', 'custom-post-type-ui' ), esc_html__( 'Tools', 'custom-post-type-ui' ), $capability, 'cptui_tools', 'cptui_tools' );
add_submenu_page( $parent_slug, esc_html__( 'Help/Support', 'custom-post-type-ui' ), esc_html__( 'Help/Support', 'custom-post-type-ui' ), $capability, 'cptui_support', 'cptui_support' );
/**
* Fires after the default submenu pages.
*
* @since 1.3.0
*
* @param string $value Parent slug for Custom Post Type UI menu.
* @param string $capability Capability required to manage CPTUI settings.
*/
do_action( 'cptui_extra_menu_items', $parent_slug, $capability );
// Remove the default one so we can add our customized version.
remove_submenu_page( $parent_slug, 'cptui_main_menu' );
add_submenu_page( $parent_slug, esc_html__( 'About CPT UI', 'custom-post-type-ui' ), esc_html__( 'About CPT UI', 'custom-post-type-ui' ), $capability, 'cptui_main_menu', 'cptui_settings' );
}
add_action( 'admin_menu', 'cptui_plugin_menu' );
/**
* Fire our CPTUI Loaded hook.
*
* @since 1.3.0
*
* @internal Use `cptui_loaded` hook.
*/
function cptui_loaded() {
if ( class_exists( 'WPGraphQL' ) ) {
require_once plugin_dir_path( __FILE__ ) . 'external/wpgraphql.php';
}
/**
* Fires upon plugins_loaded WordPress hook.
*
* CPTUI loads its required files on this hook.
*
* @since 1.3.0
*/
do_action( 'cptui_loaded' );
}
add_action( 'plugins_loaded', 'cptui_loaded' );
/**
* Load our submenus.
*
* @since 1.0.0
*
* @internal
*/
function cptui_includes() {
require_once plugin_dir_path( __FILE__ ) . 'inc/about.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/utility.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/post-types.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/taxonomies.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/listings.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/tools.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/tools-sections/tools-post-types.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/tools-sections/tools-taxonomies.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/tools-sections/tools-get-code.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/tools-sections/tools-debug.php';
require_once plugin_dir_path( __FILE__ ) . 'inc/support.php';
if ( defined( 'WP_CLI' ) && WP_CLI ) {
require_once plugin_dir_path( __FILE__ ) . 'inc/wp-cli.php';
}
}
add_action( 'cptui_loaded', 'cptui_includes' );
/**
* Fire our CPTUI init hook.
*
* @since 1.3.0
*
* @internal Use `cptui_init` hook.
*/
function cptui_init() {
/**
* Fires upon init WordPress hook.
*
* @since 1.3.0
*/
do_action( 'cptui_init' );
}
add_action( 'init', 'cptui_init' );
/**
* Enqueue CPTUI admin styles.
*
* @since 1.0.0
*
* @internal
*/
function cptui_add_styles() {
if ( wp_doing_ajax() ) {
return;
}
$min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
wp_register_script( 'cptui', plugins_url( "build/cptui{$min}.js", __FILE__ ), [ 'jquery', 'jquery-ui-dialog', 'postbox' ], CPTUI_VERSION, true );
wp_register_script( 'dashicons-picker', plugins_url( "build/dashiconsPicker{$min}.js", __FILE__ ), [ 'jquery'], '1.0.0', true );
wp_register_style( 'cptui-css', plugins_url( "build/cptui-styles{$min}.css", __FILE__ ), [ 'wp-jquery-ui-dialog' ], CPTUI_VERSION );
}
add_action( 'admin_enqueue_scripts', 'cptui_add_styles' );
/**
* Register our users' custom post types.
*
* @since 0.5.0
*
* @internal
*/
function cptui_create_custom_post_types() {
$cpts = get_option( 'cptui_post_types', [] );
/**
* Filters an override array of post type data to be registered instead of our saved option.
*
* @since 1.10.0
*
* @param array $value Default override value.
*/
$cpts_override = apply_filters( 'cptui_post_types_override', [] );
if ( empty( $cpts ) && empty( $cpts_override ) ) {
return;
}
// Assume good intent, and we're also not wrecking the option so things are always reversable.
if ( is_array( $cpts_override ) && ! empty( $cpts_override ) ) {
$cpts = $cpts_override;
}
/**
* Fires before the start of the post type registrations.
*
* @since 1.3.0
*
* @param array $cpts Array of post types to register.
*/
do_action( 'cptui_pre_register_post_types', $cpts );
if ( is_array( $cpts ) ) {
foreach ( $cpts as $post_type ) {
if ( ! is_string( $post_type['name'] ) ) {
$post_type['name'] = (string) $post_type['name'];
}
/**
* Filters whether or not to skip registration of the current iterated post type.
*
* Dynamic part of the filter name is the chosen post type slug.
*
* @since 1.7.0
*
* @param bool $value Whether or not to skip the post type.
* @param array $post_type Current post type being registered.
*/
if ( (bool) apply_filters( "cptui_disable_{$post_type['name']}_cpt", false, $post_type ) ) {
continue;
}
/**
* Filters whether or not to skip registration of the current iterated post type.
*
* @since 1.7.0
*
* @param bool $value Whether or not to skip the post type.
* @param array $post_type Current post type being registered.
*/
if ( (bool) apply_filters( 'cptui_disable_cpt', false, $post_type ) ) {
continue;
}
cptui_register_single_post_type( $post_type );
}
}
/**
* Fires after the completion of the post type registrations.
*
* @since 1.3.0
*
* @param array $cpts Array of post types registered.
*/
do_action( 'cptui_post_register_post_types', $cpts );
}
add_action( 'init', 'cptui_create_custom_post_types', 10 ); // Leave on standard init for legacy purposes.
/**
* Helper function to register the actual post_type.
*
* @since 1.0.0
*
* @internal
*
* @param array $post_type Post type array to register. Optional.
* @return null Result of register_post_type.
*/
function cptui_register_single_post_type( $post_type = [] ) {
/**
* Filters the map_meta_cap value.
*
* @since 1.0.0
*
* @param bool $value True.
* @param string $name Post type name being registered.
* @param array $post_type All parameters for post type registration.
*/
$post_type['map_meta_cap'] = apply_filters( 'cptui_map_meta_cap', true, $post_type['name'], $post_type );
if ( empty( $post_type['supports'] ) ) {
$post_type['supports'] = [];
}
/**
* Filters custom supports parameters for 3rd party plugins.
*
* @since 1.0.0
*
* @param array $value Empty array to add supports keys to.
* @param string $name Post type slug being registered.
* @param array $post_type Array of post type arguments to be registered.
*/
$user_supports_params = apply_filters( 'cptui_user_supports_params', [], $post_type['name'], $post_type );
if ( is_array( $user_supports_params ) && ! empty( $user_supports_params ) ) {
if ( is_array( $post_type['supports'] ) ) {
$post_type['supports'] = array_merge( $post_type['supports'], $user_supports_params );
} else {
$post_type['supports'] = [ $user_supports_params ];
}
}
$yarpp = false; // Prevent notices.
if ( ! empty( $post_type['custom_supports'] ) ) {
$custom = explode( ',', $post_type['custom_supports'] );
foreach ( $custom as $part ) {
// We'll handle YARPP separately.
if ( in_array( $part, [ 'YARPP', 'yarpp' ], true ) ) {
$yarpp = true;
continue;
}
$post_type['supports'][] = trim( $part );
}
}
if ( isset( $post_type['supports'] ) && is_array( $post_type['supports'] ) && in_array( 'none', $post_type['supports'], true ) ) {
$post_type['supports'] = false;
}
$labels = [
'name' => $post_type['label'],
'singular_name' => $post_type['singular_label'],
];
$preserved = cptui_get_preserved_keys( 'post_types' );
$preserved_labels = cptui_get_preserved_labels();
foreach ( $post_type['labels'] as $key => $label ) {
if ( ! empty( $label ) ) {
if ( 'parent' === $key ) {
$labels['parent_item_colon'] = $label;
} else {
$labels[ $key ] = $label;
}
} elseif ( empty( $label ) && in_array( $key, $preserved, true ) ) {
$singular_or_plural = ( in_array( $key, array_keys( $preserved_labels['post_types']['plural'] ) ) ) ? 'plural' : 'singular'; // phpcs:ignore.
$label_plurality = ( 'plural' === $singular_or_plural ) ? $post_type['label'] : $post_type['singular_label'];
$labels[ $key ] = sprintf( $preserved_labels['post_types'][ $singular_or_plural ][ $key ], $label_plurality );
}
}
$has_archive = isset( $post_type['has_archive'] ) ? get_disp_boolean( $post_type['has_archive'] ) : false;
if ( $has_archive && ! empty( $post_type['has_archive_string'] ) ) {
$has_archive = $post_type['has_archive_string'];
}
$show_in_menu = get_disp_boolean( $post_type['show_in_menu'] );
if ( ! empty( $post_type['show_in_menu_string'] ) ) {
$show_in_menu = $post_type['show_in_menu_string'];
}
$rewrite = get_disp_boolean( $post_type['rewrite'] );
if ( false !== $rewrite ) {
// Core converts to an empty array anyway, so safe to leave this instead of passing in boolean true.
$rewrite = [];
$rewrite['slug'] = ! empty( $post_type['rewrite_slug'] ) ? $post_type['rewrite_slug'] : $post_type['name'];
$rewrite['with_front'] = true; // Default value.
if ( isset( $post_type['rewrite_withfront'] ) ) {
$rewrite['with_front'] = 'false' === disp_boolean( $post_type['rewrite_withfront'] ) ? false : true;
}
}
$menu_icon = ! empty( $post_type['menu_icon'] ) ? $post_type['menu_icon'] : null;
$register_meta_box_cb = ! empty( $post_type['register_meta_box_cb'] ) ? $post_type['register_meta_box_cb'] : null;
if ( in_array( $post_type['query_var'], [ 'true', 'false', '0', '1' ], true ) ) {
$post_type['query_var'] = get_disp_boolean( $post_type['query_var'] );
}
if ( ! empty( $post_type['query_var_slug'] ) ) {
$post_type['query_var'] = $post_type['query_var_slug'];
}
$menu_position = null;
if ( ! empty( $post_type['menu_position'] ) ) {
$menu_position = (int) $post_type['menu_position'];
}
$delete_with_user = null;
if ( ! empty( $post_type['delete_with_user'] ) ) {
$delete_with_user = get_disp_boolean( $post_type['delete_with_user'] );
}
$capability_type = 'post';
if ( ! empty( $post_type['capability_type'] ) ) {
$capability_type = $post_type['capability_type'];
if ( false !== strpos( $post_type['capability_type'], ',' ) ) {
$caps = array_map( 'trim', explode( ',', $post_type['capability_type'] ) );
if ( count( $caps ) > 2 ) {
$caps = array_slice( $caps, 0, 2 );
}
$capability_type = $caps;
}
}
$public = get_disp_boolean( $post_type['public'] );
if ( ! empty( $post_type['exclude_from_search'] ) ) {
$exclude_from_search = get_disp_boolean( $post_type['exclude_from_search'] );
} else {
$exclude_from_search = false === $public;
}
$queryable = ( ! empty( $post_type['publicly_queryable'] ) && isset( $post_type['publicly_queryable'] ) ) ? get_disp_boolean( $post_type['publicly_queryable'] ) : $public;
if ( empty( $post_type['show_in_nav_menus'] ) ) {
// Defaults to value of public.
$post_type['show_in_nav_menus'] = $public;
}
if ( empty( $post_type['show_in_rest'] ) ) {
$post_type['show_in_rest'] = false;
}
$rest_base = null;
if ( ! empty( $post_type['rest_base'] ) ) {
$rest_base = $post_type['rest_base'];
}
$rest_controller_class = null;
if ( ! empty( $post_type['rest_controller_class'] ) ) {
$rest_controller_class = $post_type['rest_controller_class'];
}
$rest_namespace = null;
if ( ! empty( $post_type['rest_namespace'] ) ) {
$rest_namespace = $post_type['rest_namespace'];
}
$can_export = null;
if ( ! empty( $post_type['can_export'] ) ) {
$can_export = get_disp_boolean( $post_type['can_export'] );
}
$args = [
'labels' => $labels,
'description' => $post_type['description'],
'public' => get_disp_boolean( $post_type['public'] ),
'publicly_queryable' => $queryable,
'show_ui' => get_disp_boolean( $post_type['show_ui'] ),
'show_in_nav_menus' => get_disp_boolean( $post_type['show_in_nav_menus'] ),
'has_archive' => $has_archive,
'show_in_menu' => $show_in_menu,
'delete_with_user' => $delete_with_user,
'show_in_rest' => get_disp_boolean( $post_type['show_in_rest'] ),
'rest_base' => $rest_base,
'rest_controller_class' => $rest_controller_class,
'rest_namespace' => $rest_namespace,
'exclude_from_search' => $exclude_from_search,
'capability_type' => $capability_type,
'map_meta_cap' => $post_type['map_meta_cap'],
'hierarchical' => get_disp_boolean( $post_type['hierarchical'] ),
'can_export' => $can_export,
'rewrite' => $rewrite,
'menu_position' => $menu_position,
'menu_icon' => $menu_icon,
'register_meta_box_cb' => $register_meta_box_cb,
'query_var' => $post_type['query_var'],
'supports' => $post_type['supports'],
'taxonomies' => $post_type['taxonomies'],
];
if ( true === $yarpp ) {
$args['yarpp_support'] = $yarpp;
}
/**
* Filters the arguments used for a post type right before registering.
*
* @since 1.0.0
* @since 1.3.0 Added original passed in values array
*
* @param array $args Array of arguments to use for registering post type.
* @param string $value Post type slug to be registered.
* @param array $post_type Original passed in values for post type.
*/
$args = apply_filters( 'cptui_pre_register_post_type', $args, $post_type['name'], $post_type );
return register_post_type( $post_type['name'], $args );
}
/**
* Register our users' custom taxonomies.
*
* @since 0.5.0
*
* @internal
*/
function cptui_create_custom_taxonomies() {
$taxes = get_option( 'cptui_taxonomies', [] );
/**
* Filters an override array of taxonomy data to be registered instead of our saved option.
*
* @since 1.10.0
*
* @param array $value Default override value.
*/
$taxes_override = apply_filters( 'cptui_taxonomies_override', [] );
if ( empty( $taxes ) && empty( $taxes_override ) ) {
return;
}
// Assume good intent, and we're also not wrecking the option so things are always reversable.
if ( is_array( $taxes_override ) && ! empty( $taxes_override ) ) {
$taxes = $taxes_override;
}
/**
* Fires before the start of the taxonomy registrations.
*
* @since 1.3.0
*
* @param array $taxes Array of taxonomies to register.
*/
do_action( 'cptui_pre_register_taxonomies', $taxes );
if ( is_array( $taxes ) ) {
foreach ( $taxes as $tax ) {
if ( ! is_string( $tax['name'] ) ) {
$tax['name'] = (string) $tax['name'];
}
/**
* Filters whether or not to skip registration of the current iterated taxonomy.
*
* Dynamic part of the filter name is the chosen taxonomy slug.
*
* @since 1.7.0
*
* @param bool $value Whether or not to skip the taxonomy.
* @param array $tax Current taxonomy being registered.
*/
if ( (bool) apply_filters( "cptui_disable_{$tax['name']}_tax", false, $tax ) ) {
continue;
}
/**
* Filters whether or not to skip registration of the current iterated taxonomy.
*
* @since 1.7.0
*
* @param bool $value Whether or not to skip the taxonomy.
* @param array $tax Current taxonomy being registered.
*/
if ( (bool) apply_filters( 'cptui_disable_tax', false, $tax ) ) {
continue;
}
cptui_register_single_taxonomy( $tax );
}
}
/**
* Fires after the completion of the taxonomy registrations.
*
* @since 1.3.0
*
* @param array $taxes Array of taxonomies registered.
*/
do_action( 'cptui_post_register_taxonomies', $taxes );
}
add_action( 'init', 'cptui_create_custom_taxonomies', 9 ); // Leave on standard init for legacy purposes.
/**
* Helper function to register the actual taxonomy.
*
* @since 1.0.0
*
* @internal
*
* @param array $taxonomy Taxonomy array to register. Optional.
* @return null Result of register_taxonomy.
*/
function cptui_register_single_taxonomy( $taxonomy = [] ) {
$labels = [
'name' => $taxonomy['label'],
'singular_name' => $taxonomy['singular_label'],
];
$description = '';
if ( ! empty( $taxonomy['description'] ) ) {
$description = $taxonomy['description'];
}
$preserved = cptui_get_preserved_keys( 'taxonomies' );
$preserved_labels = cptui_get_preserved_labels();
foreach ( $taxonomy['labels'] as $key => $label ) {
if ( ! empty( $label ) ) {
$labels[ $key ] = $label;
} elseif ( empty( $label ) && in_array( $key, $preserved, true ) ) {
$singular_or_plural = ( in_array( $key, array_keys( $preserved_labels['taxonomies']['plural'] ) ) ) ? 'plural' : 'singular'; // phpcs:ignore.
$label_plurality = ( 'plural' === $singular_or_plural ) ? $taxonomy['label'] : $taxonomy['singular_label'];
$labels[ $key ] = sprintf( $preserved_labels['taxonomies'][ $singular_or_plural ][ $key ], $label_plurality );
}
}
$rewrite = get_disp_boolean( $taxonomy['rewrite'] );
if ( false !== get_disp_boolean( $taxonomy['rewrite'] ) ) {
$rewrite = [];
$rewrite['slug'] = ! empty( $taxonomy['rewrite_slug'] ) ? $taxonomy['rewrite_slug'] : $taxonomy['name'];
$rewrite['with_front'] = true;
if ( isset( $taxonomy['rewrite_withfront'] ) ) {
$rewrite['with_front'] = ( 'false' === disp_boolean( $taxonomy['rewrite_withfront'] ) ) ? false : true;
}
$rewrite['hierarchical'] = false;
if ( isset( $taxonomy['rewrite_hierarchical'] ) ) {
$rewrite['hierarchical'] = ( 'true' === disp_boolean( $taxonomy['rewrite_hierarchical'] ) ) ? true : false;
}
}
if ( in_array( $taxonomy['query_var'], [ 'true', 'false', '0', '1' ], true ) ) {
$taxonomy['query_var'] = get_disp_boolean( $taxonomy['query_var'] );
}
if ( true === $taxonomy['query_var'] && ! empty( $taxonomy['query_var_slug'] ) ) {
$taxonomy['query_var'] = $taxonomy['query_var_slug'];
}
$public = ( ! empty( $taxonomy['public'] ) && false === get_disp_boolean( $taxonomy['public'] ) ) ? false : true;
$publicly_queryable = ( ! empty( $taxonomy['publicly_queryable'] ) && false === get_disp_boolean( $taxonomy['publicly_queryable'] ) ) ? false : true;
if ( empty( $taxonomy['publicly_queryable'] ) ) {
$publicly_queryable = $public;
}
$show_admin_column = ( ! empty( $taxonomy['show_admin_column'] ) && false !== get_disp_boolean( $taxonomy['show_admin_column'] ) ) ? true : false;
$show_in_menu = ( ! empty( $taxonomy['show_in_menu'] ) && false !== get_disp_boolean( $taxonomy['show_in_menu'] ) ) ? true : false;
if ( empty( $taxonomy['show_in_menu'] ) ) {
$show_in_menu = get_disp_boolean( $taxonomy['show_ui'] );
}
$show_in_nav_menus = ( ! empty( $taxonomy['show_in_nav_menus'] ) && false !== get_disp_boolean( $taxonomy['show_in_nav_menus'] ) ) ? true : false;
if ( empty( $taxonomy['show_in_nav_menus'] ) ) {
$show_in_nav_menus = $public;
}
$show_tagcloud = ( ! empty( $taxonomy['show_tagcloud'] ) && false !== get_disp_boolean( $taxonomy['show_tagcloud'] ) ) ? true : false;
if ( empty( $taxonomy['show_tagcloud'] ) ) {
$show_tagcloud = get_disp_boolean( $taxonomy['show_ui'] );
}
$show_in_rest = ( ! empty( $taxonomy['show_in_rest'] ) && false !== get_disp_boolean( $taxonomy['show_in_rest'] ) ) ? true : false;
$show_in_quick_edit = ( ! empty( $taxonomy['show_in_quick_edit'] ) && false !== get_disp_boolean( $taxonomy['show_in_quick_edit'] ) ) ? true : false;
$sort = ( ! empty( $taxonomy['sort'] ) && false !== get_disp_boolean( $taxonomy['sort'] ) ) ? true : false;
$rest_base = null;
if ( ! empty( $taxonomy['rest_base'] ) ) {
$rest_base = $taxonomy['rest_base'];
}
$rest_controller_class = null;
if ( ! empty( $taxonomy['rest_controller_class'] ) ) {
$rest_controller_class = $taxonomy['rest_controller_class'];
}
$rest_namespace = null;
if ( ! empty( $taxonomy['rest_namespace'] ) ) {
$rest_namespace = $taxonomy['rest_namespace'];
}
$meta_box_cb = null;
if ( ! empty( $taxonomy['meta_box_cb'] ) ) {
$meta_box_cb = ( false !== get_disp_boolean( $taxonomy['meta_box_cb'] ) ) ? $taxonomy['meta_box_cb'] : false;
}
$default_term = null;
if ( ! empty( $taxonomy['default_term'] ) ) {
$term_parts = explode( ',', $taxonomy['default_term'] );
if ( ! empty( $term_parts[0] ) ) {
$default_term['name'] = trim( $term_parts[0] );
}
if ( ! empty( $term_parts[1] ) ) {
$default_term['slug'] = trim( $term_parts[1] );
}
if ( ! empty( $term_parts[2] ) ) {
$default_term['description'] = trim( $term_parts[2] );
}
}
$args = [
'labels' => $labels,
'label' => $taxonomy['label'],
'description' => $description,
'public' => $public,
'publicly_queryable' => $publicly_queryable,
'hierarchical' => get_disp_boolean( $taxonomy['hierarchical'] ),
'show_ui' => get_disp_boolean( $taxonomy['show_ui'] ),
'show_in_menu' => $show_in_menu,
'show_in_nav_menus' => $show_in_nav_menus,
'show_tagcloud' => $show_tagcloud,
'query_var' => $taxonomy['query_var'],
'rewrite' => $rewrite,
'show_admin_column' => $show_admin_column,
'show_in_rest' => $show_in_rest,
'rest_base' => $rest_base,
'rest_controller_class' => $rest_controller_class,
'rest_namespace' => $rest_namespace,
'show_in_quick_edit' => $show_in_quick_edit,
'sort' => $sort,
'meta_box_cb' => $meta_box_cb,
'default_term' => $default_term,
];
$object_type = ! empty( $taxonomy['object_types'] ) ? $taxonomy['object_types'] : '';
/**
* Filters the arguments used for a taxonomy right before registering.
*
* @since 1.0.0
* @since 1.3.0 Added original passed in values array
* @since 1.6.0 Added $obect_type variable to passed parameters.
*
* @param array $args Array of arguments to use for registering taxonomy.
* @param string $value Taxonomy slug to be registered.
* @param array $taxonomy Original passed in values for taxonomy.
* @param array $object_type Array of chosen post types for the taxonomy.
*/
$args = apply_filters( 'cptui_pre_register_taxonomy', $args, $taxonomy['name'], $taxonomy, $object_type );
return register_taxonomy( $taxonomy['name'], $object_type, $args );
}
/**
* Construct and output tab navigation.
*
* @since 1.0.0
*
* @param string $page Whether it's the CPT or Taxonomy page. Optional. Default "post_types".
* @return string
*/
function cptui_settings_tab_menu( $page = 'post_types' ) {
/**
* Filters the tabs to render on a given page.
*
* @since 1.3.0
*
* @param array $value Array of tabs to render.
* @param string $page Current page being displayed.
*/
$tabs = (array) apply_filters( 'cptui_get_tabs', [], $page );
if ( empty( $tabs['page_title'] ) ) {
return '';
}
$tmpl = '<h1>%s</h1><nav class="nav-tab-wrapper wp-clearfix" aria-label="%s">%s</nav>';
$tab_output = '';
foreach ( $tabs['tabs'] as $tab ) {
$tab_output .= sprintf(
'<a class="%s" href="%s" aria-selected="%s">%s</a>',
implode( ' ', $tab['classes'] ),
$tab['url'],
$tab['aria-selected'],
$tab['text']
);
}
printf(
$tmpl, // phpcs:ignore.
$tabs['page_title'], // phpcs:ignore.
esc_attr__( 'Secondary menu', 'custom-post-type-ui' ), // phpcs:ignore
$tab_output // phpcs:ignore.
);
}
/**
* Convert our old settings to the new options keys.
*
* These are left with standard get_option/update_option function calls for legacy and pending update purposes.
*
* @since 1.0.0
*
* @internal
*
* @return bool Whether or not options were successfully updated.
*/
function cptui_convert_settings() {
if ( wp_doing_ajax() ) {
return;
}
$retval = '';
if ( false === get_option( 'cptui_post_types' ) && ( $post_types = get_option( 'cpt_custom_post_types' ) ) ) { // phpcs:ignore.
$new_post_types = [];
foreach ( $post_types as $type ) {
$new_post_types[ $type['name'] ] = $type; // This one assigns the # indexes. Named arrays are our friend.
$new_post_types[ $type['name'] ]['supports'] = ! empty( $type[0] ) ? $type[0] : []; // Especially for multidimensional arrays.
$new_post_types[ $type['name'] ]['taxonomies'] = ! empty( $type[1] ) ? $type[1] : [];
$new_post_types[ $type['name'] ]['labels'] = ! empty( $type[2] ) ? $type[2] : [];
unset(
$new_post_types[ $type['name'] ][0],
$new_post_types[ $type['name'] ][1],
$new_post_types[ $type['name'] ][2]
); // Remove our previous indexed versions.
}
$retval = update_option( 'cptui_post_types', $new_post_types );
}
if ( false === get_option( 'cptui_taxonomies' ) && ( $taxonomies = get_option( 'cpt_custom_tax_types' ) ) ) { // phpcs:ignore.
$new_taxonomies = [];
foreach ( $taxonomies as $tax ) {
$new_taxonomies[ $tax['name'] ] = $tax; // Yep, still our friend.
$new_taxonomies[ $tax['name'] ]['labels'] = $tax[0]; // Taxonomies are the only thing with.
$new_taxonomies[ $tax['name'] ]['object_types'] = $tax[1]; // "tax" in the name that I like.
unset(
$new_taxonomies[ $tax['name'] ][0],
$new_taxonomies[ $tax['name'] ][1]
);
}
$retval = update_option( 'cptui_taxonomies', $new_taxonomies );
}
if ( ! empty( $retval ) ) {
flush_rewrite_rules();
}
return $retval;
}
add_action( 'admin_init', 'cptui_convert_settings' );
/**
* Return a notice based on conditions.
*
* @since 1.0.0
*
* @param string $action The type of action that occurred. Optional. Default empty string.
* @param string $object_type Whether it's from a post type or taxonomy. Optional. Default empty string.
* @param bool $success Whether the action succeeded or not. Optional. Default true.
* @param string $custom Custom message if necessary. Optional. Default empty string.
* @return bool|string false on no message, else HTML div with our notice message.
*/
function cptui_admin_notices( $action = '', $object_type = '', $success = true, $custom = '' ) {
$class = [];
$class[] = $success ? 'updated' : 'error';
$class[] = 'notice is-dismissible';
$object_type = esc_attr( $object_type );
$messagewrapstart = '<div id="message" class="' . implode( ' ', $class ) . '"><p>';
$message = '';
$messagewrapend = '</p></div>';
if ( 'add' === $action ) {
if ( $success ) {
$message .= sprintf( esc_html__( '%s has been successfully added', 'custom-post-type-ui' ), $object_type );
} else {
$message .= sprintf( esc_html__( '%s has failed to be added', 'custom-post-type-ui' ), $object_type );
}
} elseif ( 'update' === $action ) {
if ( $success ) {
$message .= sprintf( esc_html__( '%s has been successfully updated', 'custom-post-type-ui' ), $object_type );
} else {
$message .= sprintf( esc_html__( '%s has failed to be updated', 'custom-post-type-ui' ), $object_type );
}
} elseif ( 'delete' === $action ) {
if ( $success ) {
$message .= sprintf( esc_html__( '%s has been successfully deleted', 'custom-post-type-ui' ), $object_type );
} else {
$message .= sprintf( esc_html__( '%s has failed to be deleted', 'custom-post-type-ui' ), $object_type );
}
} elseif ( 'import' === $action ) {
if ( $success ) {
$message .= sprintf( esc_html__( '%s has been successfully imported', 'custom-post-type-ui' ), $object_type );
} else {
$message .= sprintf( esc_html__( '%s has failed to be imported', 'custom-post-type-ui' ), $object_type );
}
} elseif ( 'error' === $action ) {
if ( ! empty( $custom ) ) {
$message = $custom;
}
}
if ( $message ) {
/**
* Filters the custom admin notice for CPTUI.
*
* @since 1.0.0
*
* @param string $value Complete HTML output for notice.
* @param string $action Action whose message is being generated.
* @param string $message The message to be displayed.
* @param string $messagewrapstart Beginning wrap HTML.
* @param string $messagewrapend Ending wrap HTML.
*/
return apply_filters( 'cptui_admin_notice', $messagewrapstart . $message . $messagewrapend, $action, $message, $messagewrapstart, $messagewrapend );
}
return false;
}
/**
* Return array of keys needing preserved.
*
* @since 1.0.5
*
* @param string $type Type to return. Either 'post_types' or 'taxonomies'. Optional. Default empty string.
* @return array Array of keys needing preservered for the requested type.
*/
function cptui_get_preserved_keys( $type = '' ) {
$preserved_labels = [
'post_types' => [
'add_new_item',
'edit_item',
'new_item',
'view_item',