/
class-bp-component.php
1478 lines (1286 loc) · 42.5 KB
/
class-bp-component.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
/**
* Component classes.
*
* @package BuddyPress
* @subpackage Core
* @since 1.5.0
*/
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
if ( !class_exists( 'BP_Component' ) ) :
/**
* BuddyPress Component Class.
*
* The BuddyPress component class is responsible for simplifying the creation
* of components that share similar behaviors and routines. It is used
* internally by BuddyPress to create the bundled components, but can be
* extended to create other really neat things.
*
* @since 1.5.0
*/
class BP_Component {
/** Variables *************************************************************/
/**
* Translatable name for the component.
*
* @internal
*
* @var string
*/
public $name = '';
/**
* Unique ID for the component.
*
* @since 1.5.0
* @var string
*/
public $id = '';
/**
* Unique slug for the component, for use in query strings and URLs.
*
* @since 1.5.0
* @var string
*/
public $slug = '';
/**
* Does the component need a top-level directory?
*
* @since 1.5.0
* @var bool
*/
public $has_directory = false;
/**
* Directory's permalink structure for the component.
*
* @since 12.0.0
* @var string
*/
public $directory_permastruct = '';
/**
* List of available rewrite IDs for the component.
*
* @since 12.0.0
* @var array
*/
public $rewrite_ids = array();
/**
* The path to the component's files.
*
* @since 1.5.0
* @var string
*/
public $path = '';
/**
* The WP_Query loop for this component.
*
* @since 1.5.0
* @var WP_Query
*/
public $query = false;
/**
* The current ID of the queried object.
*
* @since 1.5.0
* @var string
*/
public $current_id = '';
/**
* Callback for formatting notifications.
*
* @since 1.5.0
* @var callable
*/
public $notification_callback = '';
/**
* WordPress Toolbar links.
*
* @since 1.5.0
* @var array
*/
public $admin_menu = '';
/**
* Placeholder text for component directory search box.
*
* @since 1.6.0
* @var string
*/
public $search_string = '';
/**
* Root slug for the component.
*
* @since 1.6.0
* @var string
*/
public $root_slug = '';
/**
* Metadata tables for the component (if applicable).
*
* @since 2.0.0
* @var array
*/
public $meta_tables = array();
/**
* Global tables for the component (if applicable).
*
* @since 2.0.0
* @var array
*/
public $global_tables = array();
/**
* Table name.
*
* @since 12.0.0
* @var string
*/
public $table_name = '';
/**
* Query argument for component search URLs.
*
* @since 2.4.0
* @var string
*/
public $search_query_arg = 's';
/**
* An array of globalized data for BP Blocks.
*
* @since 9.0.0
* @var array
*/
public $block_globals = array();
/**
* Menu position of the WP Toolbar's "My Account menu".
*
* @since 1.5.0
* @var int
*/
public $adminbar_myaccount_order = 90;
/**
* An array of feature names.
*
* @since 1.5.0
* @var string[]
*/
public $features = array();
/**
* Component's directory title.
*
* @since 2.0.0
* @var string
*/
public $directory_title = '';
/**
* Component's main nav items.
*
* @since 12.0.0
* @var array
*/
public $main_nav = array();
/**
* Component's main nav sub items.
*
* @since 12.0.0
* @var array
*/
public $sub_nav = array();
/** Methods ***************************************************************/
/**
* Component loader.
*
* @since 1.5.0
* @since 1.9.0 Added $params as a parameter.
* @since 2.3.0 Added $params['features'] as a configurable value.
* @since 2.4.0 Added $params['search_query_arg'] as a configurable value.
*
* @param string $id Unique ID. Letters, numbers, and underscores only.
* @param string $name Unique name. This should be a translatable name, eg.
* __( 'Groups', 'buddypress' ).
* @param string $path The file path for the component's files. Used by {@link BP_Component::includes()}.
* @param array $params {
* Additional parameters used by the component.
* @type int $adminbar_myaccount_order Set the position for our menu under the WP Toolbar's "My Account menu".
* @type array $features An array of feature names. This is used to load additional files from your
* component directory and for feature active checks. eg. array( 'awesome' )
* would look for a file called "bp-{$this->id}-awesome.php" and you could use
* bp_is_active( $this->id, 'awesome' ) to determine if the feature is active.
* @type string $search_query_arg String to be used as the query argument in component search URLs.
* }
*/
public function start( $id = '', $name = '', $path = '', $params = array() ) {
// Internal identifier of component.
$this->id = $id;
// Internal component name.
$this->name = $name;
// Path for includes.
$this->path = $path;
// Miscellaneous component parameters that need to be set early on.
if ( ! empty( $params ) ) {
// Sets the position for our menu under the WP Toolbar's "My Account" menu.
if ( ! empty( $params['adminbar_myaccount_order'] ) ) {
$this->adminbar_myaccount_order = (int) $params['adminbar_myaccount_order'];
}
// Register features.
if ( ! empty( $params['features'] ) ) {
$this->features = array_map( 'sanitize_title', (array) $params['features'] );
}
if ( ! empty( $params['search_query_arg'] ) ) {
$this->search_query_arg = sanitize_title( $params['search_query_arg'] );
}
}
// Make sure the `buddypress()->active_components` global lists all active components.
if ( 'core' !== $this->id && ! isset( buddypress()->active_components[ $this->id ] ) ) {
buddypress()->active_components[ $this->id ] = '1';
}
// Move on to the next step.
$this->setup_actions();
}
/**
* Set up component global variables.
*
* @since 1.5.0
* @since 2.0.0 Adds the `$directory_title` argument to the `$args` parameter.
* @since 9.0.0 Adds the `$block_globals` argument to the `$args` parameter.
* @since 12.0.0 Adds the `$rewrite_ids` argument to the `$args` parameter.
*
* @param array $args {
* All values are optional.
* @type string $slug The component slug. Used to construct certain URLs, such as 'friends' in
* http://example.com/members/joe/friends/. Default: the value of $this->id.
* @type string $root_slug The component root slug. Note that this value is generally unused if the
* component has a root directory (the slug will be overridden by the
* post_name of the directory page). Default: the slug of the directory page
* if one is found, otherwise an empty string.
* @type bool $has_directory Set to true if the component requires an associated WordPress page.
* @type array $rewrite_ids The list of rewrited IDs to use for the component.
* @type string $directory_title The title to use for the directory page.
* @type callable $notification_callback The callable function that formats the component's notifications.
* @type string $search_string The placeholder text for the directory search box. Eg: 'Search Groups...'.
* @type array $global_tables An array of database table names.
* @type array $meta_tables An array of metadata table names.
* @type array $block_globals An array of globalized data for BP Blocks.
* }
*/
public function setup_globals( $args = array() ) {
$r = bp_parse_args(
$args,
array(
'slug' => $this->id,
'root_slug' => '',
'has_directory' => false,
'rewrite_ids' => array(),
'directory_title' => '',
'notification_callback' => '',
'search_string' => '',
'global_tables' => '',
'meta_tables' => '',
'block_globals' => array(),
)
);
/** Slugs ************************************************************
*/
// For all Components except Core.
if ( 'core' !== $this->id ) {
/**
* If a WP directory page exists for the component, it should
* be the default value of 'root_slug'.
*/
if ( isset( buddypress()->pages->{$this->id}->slug ) ) {
$r['root_slug'] = buddypress()->pages->{$this->id}->slug;
}
/**
* Filters the slug to be used for the permalink URI chunk after root.
*
* @since 1.5.0
*
* @param string $value Slug to use in permalink URI chunk.
*/
$this->slug = apply_filters( 'bp_' . $this->id . '_slug', $r['slug'] );
/**
* Filters the slug used for root directory.
*
* @since 1.5.0
*
* @param string $value Root directory slug.
*/
$this->root_slug = apply_filters( 'bp_' . $this->id . '_root_slug', $r['root_slug'] );
/**
* Filters the component's top-level directory if available.
*
* @since 1.5.0
*
* @param bool $value Whether or not there is a top-level directory.
*/
$this->has_directory = apply_filters( 'bp_' . $this->id . '_has_directory', $r['has_directory'] );
$rewrite_ids = bp_parse_args(
/**
* Filters the component's rewrite IDs if available.
*
* @since 12.0.0
*
* @param array $value The list of rewrite IDs for the component.
*/
(array) apply_filters( 'bp_' . $this->id. '_rewrite_ids', $r['rewrite_ids'] ),
array_fill_keys( array_keys( bp_rewrites_get_default_url_chunks() ), '' )
);
if ( array_filter( $rewrite_ids ) ) {
foreach ( $rewrite_ids as $rewrite_id_key => $rewrite_id_value ) {
if ( ! $rewrite_id_value ) {
continue;
}
$this->rewrite_ids[ sanitize_key( $rewrite_id_key ) ] = 'bp_' . str_replace( 'bp_', '', sanitize_key( $rewrite_id_value ) );
}
}
// Set the component's directory permastruct early so that it's available to build links.
if ( true === $this->has_directory && isset( $this->rewrite_ids['directory'] ) ) {
$this->directory_permastruct = $this->root_slug . '/%' . $this->rewrite_ids['directory'] . '%';
}
/**
* Filters the component's directory title.
*
* @since 2.0.0
*
* @param string $value Title to use for the directory.
*/
$this->directory_title = apply_filters( 'bp_' . $this->id . '_directory_title', $r['directory_title'] );
/**
* Filters the placeholder text for search inputs for component.
*
* @since 1.5.0
*
* @param string $value Name to use in search input placeholders.
*/
$this->search_string = apply_filters( 'bp_' . $this->id . '_search_string', $r['search_string'] );
/**
* Filters the callable function that formats the component's notifications.
*
* @since 1.5.0
*
* @param string $value Function callback.
*/
$this->notification_callback = apply_filters( 'bp_' . $this->id . '_notification_callback', $r['notification_callback'] );
// Set the global table names, if applicable.
if ( ! empty( $r['global_tables'] ) ) {
$this->register_global_tables( $r['global_tables'] );
}
// Set the metadata table, if applicable.
if ( ! empty( $r['meta_tables'] ) ) {
$this->register_meta_tables( $r['meta_tables'] );
}
// Register this component in the loaded components array.
buddypress()->loaded_components[ $this->slug ] = $this->id;
}
/**
* Filters the $blocks global value.
*
* @since 9.0.0
*
* @param array $blocks a list of global properties for blocks keyed
* by their corresponding block name.
*/
$block_globals = apply_filters( 'bp_' . $this->id . '_block_globals', $r['block_globals'] );
if ( is_array( $block_globals ) && array_filter( $block_globals ) ) {
foreach ( $block_globals as $block_name => $block_props ) {
$this->block_globals[ $block_name ] = new stdClass();
// Initialize an `items` property for Widget Block occurrences.
$this->block_globals[ $block_name ]->items = array();
// Set the global properties for the Block.
$this->block_globals[ $block_name ]->props = (array) $block_props;
}
}
/**
* Fires at the end of the setup_globals method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.5.0
*/
do_action( 'bp_' . $this->id . '_setup_globals' );
}
/**
* Include required files.
*
* Please note that, by default, this method is fired on the bp_include
* hook, with priority 8. This is necessary so that core components are
* loaded in time to be available to third-party plugins. However, this
* load order means that third-party plugins whose main files are
* loaded at bp_include with priority 10 (as recommended), will not be
* loaded in time for their includes() method to fire automatically.
*
* For this reason, it is recommended that your plugin has its own
* method or function for requiring necessary files. If you must use
* this method, you will have to call it manually in your constructor
* class, ie
* $this->includes();
*
* Note that when you pass an array value like 'actions' to includes,
* it looks for the following three files (assuming your component is
* called 'my_component'):
* - ./actions
* - ./bp-my_component/actions
* - ./bp-my_component/bp-my_component-actions.php
*
* @since 1.5.0
*
*
* @param array $includes An array of file names, or file name chunks,
* to be parsed and then included.
*/
public function includes( $includes = array() ) {
// Bail if no files to include.
if ( ! empty( $includes ) ) {
$slashed_path = trailingslashit( $this->path );
// Loop through files to be included.
foreach ( (array) $includes as $file ) {
$paths = array(
// Passed with no extension.
'bp-' . $this->id . '/bp-' . $this->id . '-' . $file . '.php',
'bp-' . $this->id . '-' . $file . '.php',
'bp-' . $this->id . '/' . $file . '.php',
// Passed with extension.
$file,
'bp-' . $this->id . '-' . $file,
'bp-' . $this->id . '/' . $file,
);
foreach ( $paths as $path ) {
if ( @is_file( $slashed_path . $path ) ) {
require( $slashed_path . $path );
break;
}
}
}
}
/**
* Fires at the end of the includes method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.5.0
*/
do_action( 'bp_' . $this->id . '_includes' );
}
/**
* Late includes method.
*
* Components should include files here only on specific pages using
* conditionals such as {@link bp_is_current_component()}. Intentionally left
* empty.
*
* @since 3.0.0
*/
public function late_includes() {}
/**
* Set up the actions.
*
* @since 1.5.0
*
*/
public function setup_actions() {
// Setup globals.
add_action( 'bp_setup_globals', array( $this, 'setup_globals' ), 10 );
// Set up canonical stack.
add_action( 'bp_setup_canonical_stack', array( $this, 'setup_canonical_stack' ), 10 );
// Include required files. Called early to ensure that BP core
// components are loaded before plugins that hook their loader functions
// to bp_include with the default priority of 10. This is for backwards
// compatibility; henceforth, plugins should register themselves by
// extending this base class.
add_action( 'bp_include', array( $this, 'includes' ), 8 );
// Load files conditionally, based on certain pages.
add_action( 'bp_late_include', array( $this, 'late_includes' ), 10 );
// Generate navigation.
add_action( 'bp_register_nav', array( $this, 'register_nav' ), 9 );
// Setup navigation.
add_action( 'bp_setup_nav', array( $this, 'setup_nav' ), 9 );
// Setup WP Toolbar menus.
add_action( 'bp_setup_admin_bar', array( $this, 'setup_admin_bar' ), $this->adminbar_myaccount_order );
// Setup component title.
add_action( 'bp_setup_title', array( $this, 'setup_title' ), 10 );
// Setup cache groups.
add_action( 'bp_setup_cache_groups', array( $this, 'setup_cache_groups' ), 10 );
// Register post types.
add_action( 'bp_register_post_types', array( $this, 'register_post_types' ), 10 );
// Register post statuses.
add_action( 'bp_register_post_statuses', array( $this, 'register_post_statuses' ), 10 );
// Register taxonomies.
add_action( 'bp_register_taxonomies', array( $this, 'register_taxonomies' ), 10 );
// Add the rewrite tags.
add_action( 'bp_add_rewrite_tags', array( $this, 'add_rewrite_tags' ), 10, 0 );
// Add the rewrite rules.
add_action( 'bp_add_rewrite_rules', array( $this, 'add_rewrite_rules' ), 10, 0 );
// Add the permalink structure.
add_action( 'bp_add_permastructs', array( $this, 'add_permastructs' ), 10 );
// Allow components to parse the main query.
add_action( 'bp_parse_query', array( $this, 'parse_query' ), 10 );
// Generate rewrite rules.
add_action( 'bp_generate_rewrite_rules', array( $this, 'generate_rewrite_rules' ), 10 );
// Register BP REST Endpoints.
if ( bp_rest_in_buddypress() && bp_rest_api_is_available() ) {
add_action( 'bp_rest_api_init', array( $this, 'rest_api_init' ), 10 );
}
// Register BP Blocks.
if ( bp_support_blocks() ) {
add_action( 'bp_blocks_init', array( $this, 'blocks_init' ), 10 );
}
/**
* Fires at the end of the setup_actions method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.5.0
*/
do_action( 'bp_' . $this->id . '_setup_actions' );
}
/**
* Set up the canonical URL stack for this component.
*
* @since 2.1.0
*/
public function setup_canonical_stack() {}
/**
* Registers nav items globalizing them into `BP_Component::$main_nav` & `BP_Component::$sub_nav` properties.
*
* @since 12.0.0
*
* @param array $main_nav Optional. Passed directly to bp_core_new_nav_item().
* See that function for a description.
* @param array $sub_nav Optional. Multidimensional array, each item in
* which is passed to bp_core_new_subnav_item(). See that
* function for a description.
*/
public function register_nav( $main_nav = array(), $sub_nav = array() ) {
if ( isset( $main_nav['slug'] ) ) {
// Always set the component ID.
$this->main_nav['component_id'] = $this->id;
if ( ! isset( $main_nav['rewrite_id'] ) ) {
$this->main_nav['rewrite_id'] = 'bp_member_' . str_replace( '-', '_', $main_nav['slug'] );
} elseif ( ! $main_nav['rewrite_id'] ) {
unset( $main_nav['rewrite_id'] );
}
$this->main_nav = array_merge( $this->main_nav, $main_nav );
// Sub nav items are not required.
if ( ! empty( $sub_nav ) ) {
foreach( (array) $sub_nav as $nav ) {
if ( ! isset( $nav['slug'], $nav['parent_slug'] ) ) {
continue;
}
if ( ! isset( $nav['rewrite_id'] ) ) {
$nav['rewrite_id'] = 'bp_member_' . str_replace( '-', '_', $nav['parent_slug'] ) . '_' . str_replace( '-', '_', $nav['slug'] );
} elseif ( ! $nav['rewrite_id'] ) {
unset( $nav['rewrite_id'] );
}
$this->sub_nav[] = $nav;
}
}
}
}
/**
* Set up component navigation.
*
* @since 1.5.0
* @since 12.0.0 Uses the registered navigations to generate it.
*
* @param array $main_nav Optional. Passed directly to bp_core_new_nav_item().
* See that function for a description.
* @param array $sub_nav Optional. Multidimensional array, each item in
* which is passed to bp_core_new_subnav_item(). See that
* function for a description.
*/
public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
// Use the registered navigations if available.
if ( empty( $main_nav ) && $this->main_nav ) {
// Don't generate navigation if there's no member.
if ( ! is_user_logged_in() && ! bp_is_user() ) {
return;
}
$generate = true;
if ( isset( $this->main_nav['generate'] ) ) {
$generate = is_callable( $this->main_nav['generate'] ) ? call_user_func( $this->main_nav['generate'] ) : (bool) $this->main_nav['generate'];
unset( $this->main_nav['generate'] );
}
if ( bp_displayed_user_has_front_template() ) {
bp_core_new_nav_item(
array(
'name' => _x( 'Home', 'Member Home page', 'buddypress' ),
'slug' => 'front',
'position' => 5,
'screen_function' => 'bp_members_screen_display_profile',
'default_subnav_slug' => 'public',
),
'members'
);
}
if ( 'xprofile' === $this->id ) {
$extra_subnavs = wp_list_filter(
buddypress()->members->sub_nav,
array(
'slug' => 'change-avatar',
'screen_function' => 'bp_members_screen_change_cover_image',
),
'OR'
);
$this->sub_nav = array_merge( $this->sub_nav, $extra_subnavs );
}
// No sub nav items without a main nav item.
if ( $this->main_nav && $generate) {
if ( isset( $this->main_nav['user_has_access_callback'] ) && is_callable( $this->main_nav['user_has_access_callback'] ) ) {
$this->main_nav['show_for_displayed_user'] = call_user_func( $this->main_nav['user_has_access_callback'] );
unset( $this->main_nav['user_has_access_callback'] );
}
bp_core_new_nav_item( $this->main_nav, 'members' );
// Sub nav items are not required.
if ( $this->sub_nav ) {
foreach( (array) $this->sub_nav as $nav ) {
if ( isset( $nav['user_has_access_callback'] ) && is_callable( $nav['user_has_access_callback'] ) ) {
$nav['user_has_access'] = call_user_func( $nav['user_has_access_callback'] );
unset( $nav['user_has_access_callback'] );
}
if ( isset( $nav['generate'] ) ) {
if ( is_callable( $nav['generate'] ) ) {
$generate_sub = call_user_func( $nav['generate'] );
} else {
$generate_sub = (bool) $nav['generate'];
}
unset( $nav['generate'] );
if ( ! $generate_sub ) {
continue;
}
}
bp_core_new_subnav_item( $nav, 'members' );
}
}
}
/*
* If the `$main_nav` is populated, it means a plugin is not registering its navigation using
* `BP_Component::register_nav()` to enjoy the BP Rewrites API slug customization. Let's simply
* preverve backward compatibility in this case.
*/
} elseif ( ! empty( $main_nav ) && ! $this->main_nav ) {
// Always set the component ID.
$main_nav['component_id'] = $this->id;
$this->main_nav = $main_nav;
bp_core_new_nav_item( $main_nav, 'members' );
// Sub nav items are not required.
if ( ! empty( $sub_nav ) ) {
$this->sub_nav = $sub_nav;
foreach( (array) $sub_nav as $nav ) {
bp_core_new_subnav_item( $nav, 'members' );
}
}
}
/**
* Fires at the end of the setup_nav method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.5.0
*/
do_action( 'bp_' . $this->id . '_setup_nav' );
}
/**
* Set up the component entries in the WordPress Admin Bar.
*
* @since 1.5.0
*
* @see WP_Admin_Bar::add_menu() for a description of the syntax
* required by each item in the $wp_admin_nav parameter array.
*
* @global WP_Admin_Bar $wp_admin_bar WordPress object implementing a Toolbar API.
*
* @param array $wp_admin_nav An array of nav item arguments. Each item in this parameter
* array is passed to {@link WP_Admin_Bar::add_menu()}.
* See that method for a description of the required syntax for
* each item.
*/
public function setup_admin_bar( $wp_admin_nav = array() ) {
global $wp_admin_bar;
// Bail if this is an ajax request.
if ( wp_doing_ajax() ) {
return;
}
/**
* Filters the admin navigation passed into setup_admin_bar.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.9.0
*
* @param array $wp_admin_nav Array of navigation items to add.
*/
$wp_admin_nav = apply_filters( 'bp_' . $this->id . '_admin_nav', $wp_admin_nav );
// Do we have Toolbar menus to add?
if ( !empty( $wp_admin_nav ) ) {
// Fill in position if one wasn't passed for backpat.
$pos = 0;
$not_set_pos = 1;
foreach( $wp_admin_nav as $key => $nav ) {
if ( ! isset( $nav['position'] ) ) {
$wp_admin_nav[$key]['position'] = $pos + $not_set_pos;
if ( 9 !== $not_set_pos ) {
++$not_set_pos;
}
} else {
$pos = $nav['position'];
// Reset not set pos to 1.
if ( $pos % 10 === 0 ) {
$not_set_pos = 1;
}
}
}
// Sort admin nav by position.
$wp_admin_nav = bp_sort_by_key( $wp_admin_nav, 'position', 'num' );
// Set this objects menus.
$this->admin_menu = $wp_admin_nav;
// Add each admin menu.
foreach( $this->admin_menu as $admin_menu ) {
$wp_admin_bar->add_node( $admin_menu );
}
}
/**
* Fires at the end of the setup_admin_bar method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.5.0
*/
do_action( 'bp_' . $this->id . '_setup_admin_bar' );
}
/**
* Set up the component title.
*
* @since 1.5.0
*
*/
public function setup_title() {
/**
* Fires in the setup_title method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 1.5.0
*/
do_action( 'bp_' . $this->id . '_setup_title' );
}
/**
* Setup component-specific cache groups.
*
* @since 2.2.0
*
*/
public function setup_cache_groups() {
/**
* Fires in the setup_cache_groups method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 2.2.0
*/
do_action( 'bp_' . $this->id . '_setup_cache_groups' );
}
/**
* Register global tables for the component, so that it may use WordPress's database API.
*
* @since 2.0.0
*
* @param array $tables Table names to register.
*/
public function register_global_tables( $tables = array() ) {
/**
* Filters the global tables for the component, so that it may use WordPress' database API.
*
* This is a dynamic hook that is based on the component string ID.
* It allows for component-specific filtering of table names. To filter
* *all* tables, use the 'bp_core_get_table_prefix' filter instead.
*
* @since 1.6.0
*/
$tables = apply_filters( 'bp_' . $this->id . '_global_tables', $tables );
// Add to the BuddyPress global object.
if ( !empty( $tables ) && is_array( $tables ) ) {
foreach ( $tables as $global_name => $table_name ) {
$this->{$global_name} = $table_name;
}
// Keep a record of the metadata tables in the component.
$this->global_tables = $tables;
}
/**
* Fires at the end of the register_global_tables method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 2.0.0
*/
do_action( 'bp_' . $this->id . '_register_global_tables' );
}
/**
* Register component metadata tables.
*
* Metadata tables are registered in the $wpdb global, for
* compatibility with the WordPress metadata API.
*
* @since 2.0.0
*
* @param array $tables Table names to register.
*/
public function register_meta_tables( $tables = array() ) {
global $wpdb;
/**
* Filters the global meta_tables for the component.
*
* This is a dynamic hook that is based on the component string ID.
* It allows for component-specific filtering of table names. To filter
* *all* tables, use the 'bp_core_get_table_prefix' filter instead.
*
* @since 2.0.0
*/
$tables = apply_filters( 'bp_' . $this->id . '_meta_tables', $tables );
/**
* Add the name of each metadata table to WPDB to allow BuddyPress
* components to play nicely with the WordPress metadata API.
*/
if ( !empty( $tables ) && is_array( $tables ) ) {
foreach( $tables as $meta_prefix => $table_name ) {
$wpdb->{$meta_prefix . 'meta'} = $table_name;
}
// Keep a record of the metadata tables in the component.
$this->meta_tables = $tables;
}
/**
* Fires at the end of the register_meta_tables method inside BP_Component.
*
* This is a dynamic hook that is based on the component string ID.
*
* @since 2.0.0
*/
do_action( 'bp_' . $this->id . '_register_meta_tables' );
}
/**
* Set up the component post types.
*
* @since 1.5.0
*
*/
public function register_post_types() {
/**