class-roles-capabilities.php
19.9 KB
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
<?php
namespace um\core;
// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) exit;
if ( ! class_exists( 'um\core\Roles_Capabilities' ) ) {
/**
* Class Roles_Capabilities
* @package um\core
*/
class Roles_Capabilities {
/**
* Roles_Capabilities constructor.
*/
function __construct() {
add_action( 'wp_roles_init', array( &$this, 'um_roles_init' ), 99999 );
add_action( 'update_option', array( &$this, 'um_on_roles_update' ), 10, 3 );
add_action( 'set_user_role', array( &$this, 'remove_user_cache' ), 10, 1 );
}
/**
* Flush the Cache User Profile on set new user role(s)
*
* @param int $user_id
*/
function remove_user_cache( $user_id ) {
$user = get_userdata( $user_id );
if ( ! is_a( $user, '\WP_User' ) ) {
return;
}
UM()->user()->remove_cache( $user_id );
}
/**
* @param string $option
* @param mixed $old_value
* @param mixed $value
*/
function um_on_roles_update( $option, $old_value, $value ) {
global $wp_roles;
if ( is_object( $wp_roles ) && isset( $wp_roles->role_key ) && $option == $wp_roles->role_key ) {
foreach ( $value as $role_key => $role_data ) {
$role_keys = get_option( 'um_roles', array() );
$role_keys = array_map( function( $item ) {
return 'um_' . $item;
}, $role_keys );
if ( ! empty( $role_keys ) && in_array( $role_key, $role_keys ) ) {
$role_meta = get_option( 'um_role_' . substr( $role_key, 3 ) . '_meta' );
if ( ! isset( $role_meta['wp_capabilities'] ) ) {
$role_meta['wp_capabilities'] = array();
}
if ( ! empty( $role_data['capabilities'] ) && is_array( $role_data['capabilities'] ) ) {
$old_role_caps = ! empty( $old_value[ $role_key ]['capabilities'] ) ? array_keys( $old_value[ $role_key ]['capabilities'] ) : array();
if ( ! empty( $old_role_caps ) ) {
$unset_caps = array_diff( $old_role_caps, array_keys( $role_data['capabilities'] ) );
if ( ! empty( $unset_caps ) ) {
foreach ( $unset_caps as $cap ) {
if ( ! empty( $role_meta['wp_capabilities'][ $cap ] ) ) {
unset( $role_meta['wp_capabilities'][ $cap ] );
}
}
}
}
foreach ( $role_data['capabilities'] as $cap => $grant ) {
if ( $grant ) {
$role_meta['wp_capabilities'][ $cap ] = true;
}
}
}
update_option( 'um_role_' . substr( $role_key, 3 ) . '_meta', $role_meta );
}
}
}
}
/**
* Loop through dynamic roles and add them to the $wp_roles array
*
* @param null|object $wp_roles
* @return null
*/
public function um_roles_init( $wp_roles = null ) {
$role_keys = get_option( 'um_roles', array() );
$um_roles = array_map( array( &$this, 'key_to_role_id_mapping' ), $role_keys );
// Add UM role data to WP Roles.
foreach ( $wp_roles->roles as $role_id => $role_data ) {
// Skip custom UM roles meta here, because it's added below. See: "Add custom UM roles".
if ( in_array( $role_id, $um_roles, true ) ) {
continue;
}
$role_meta = get_option( "um_role_{$role_id}_meta" );
if ( ! empty( $role_meta ) ) {
$wp_roles->roles[ $role_id ] = array_merge( $role_data, $role_meta );
}
}
// Add custom UM roles.
$roles = array();
foreach ( $role_keys as $role_key ) {
$role_meta = get_option( "um_role_{$role_key}_meta" );
if ( ! empty( $role_meta ) ) {
$roles[ 'um_' . $role_key ] = $role_meta;
}
}
if ( empty( $roles ) ) {
return $wp_roles;
}
foreach ( $roles as $role_id => $details ) {
$capabilities = ! empty( $details['wp_capabilities'] ) ? array_keys( $details['wp_capabilities'] ) : array();
$details['capabilities'] = array_fill_keys( array_values( $capabilities ), true );
unset( $details['wp_capabilities'] );
$wp_roles->roles[ $role_id ] = $details;
$wp_roles->role_objects[ $role_id ] = new \WP_Role( $role_id, $details['capabilities'] );
$wp_roles->role_names[ $role_id ] = $details['name'];
}
// Return the modified $wp_roles array
return $wp_roles;
}
public function key_to_role_id_mapping( $role_key ) {
return 'um_' . $role_key;
}
/**
* Check if role is custom
*
* @param $role
* @return bool
*/
public function is_role_custom( $role ) {
// User has roles so look for a UM Role one
$role_keys = get_option( 'um_roles', array() );
if ( empty( $role_keys ) ) {
return false;
}
$um_roles = array_map( array( &$this, 'key_to_role_id_mapping' ), $role_keys );
return in_array( $role, $um_roles, true );
}
/**
* Return a user's main role
*
* @param int $user_id
* @param string $new_role
* @uses get_userdata() To get the user data
* @uses apply_filters() Calls 'um_set_user_role' with the role and user id
* @return string
*/
function set_role( $user_id, $new_role = '' ) {
// Validate user id
$user = get_userdata( $user_id );
// User exists
if ( ! empty( $user ) ) {
// Get users old UM role
$role = UM()->roles()->get_um_user_role( $user_id );
// User already has this role so no new role is set
if ( $new_role === $role || ( ! $this->is_role_custom( $new_role ) && user_can( $user, $new_role ) ) ) {
$new_role = false;
} else {
// Users role is different than the new role
// Remove the old UM role
if ( ! empty( $role ) && $this->is_role_custom( $role ) ) {
$user->remove_role( $role );
}
// Add the new role
if ( ! empty( $new_role ) ) {
$user->add_role( $new_role );
}
/**
* UM hook
*
* @type action
* @title um_when_role_is_set
* @description Action before user role changed
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_when_role_is_set', 'function_name', 10, 1 );
* @example
* <?php
* add_action( 'um_when_role_is_set', 'my_when_role_is_set', 10, 1 );
* function my_when_role_is_set( $user_id ) {
* // your code here
* }
* ?>
*/
do_action( 'um_when_role_is_set', $user_id );
/**
* UM hook
*
* @type action
* @title um_before_user_role_is_changed
* @description Action before user role changed
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_before_user_role_is_changed', 'function_name', 10 );
* @example
* <?php
* add_action( 'um_before_user_role_is_changed', 'my_before_user_role_is_changed', 10 );
* function my_before_user_role_is_changed() {
* // your code here
* }
* ?>
*/
do_action( 'um_before_user_role_is_changed' );
UM()->user()->profile['role'] = $new_role;
/**
* UM hook
*
* @type action
* @title um_member_role_upgrade
* @description Action on user role changed
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"},
* {"var":"$role","type":"string","desc":"User role"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_member_role_upgrade', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_member_role_upgrade', 'my_member_role_upgrade', 10, 2 );
* function my_member_role_upgrade( $old_role, $new_role ) {
* // your code here
* }
* ?>
*/
do_action( 'um_member_role_upgrade', $role, UM()->user()->profile['role'] );
UM()->user()->update_usermeta_info( 'role' );
/**
* UM hook
*
* @type action
* @title um_after_user_role_is_changed
* @description Action after user role changed
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_role_is_changed', 'function_name', 10 );
* @example
* <?php
* add_action( 'um_after_user_role_is_changed', 'my_after_user_role_is_changed', 10 );
* function my_after_user_role_is_changed() {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_role_is_changed' );
/**
* UM hook
*
* @type action
* @title um_after_user_role_is_updated
* @description Action after user role changed
* @input_vars
* [{"var":"$user_id","type":"int","desc":"User ID"},
* {"var":"$role","type":"string","desc":"User role"}]
* @change_log
* ["Since: 2.0"]
* @usage add_action( 'um_after_user_role_is_updated', 'function_name', 10, 2 );
* @example
* <?php
* add_action( 'um_after_user_role_is_updated', 'my_after_user_role_is_updated', 10, 2 );
* function my_after_user_role_is_updated( $user_id, $role ) {
* // your code here
* }
* ?>
*/
do_action( 'um_after_user_role_is_updated', $user_id, $role );
}
} else {
// User does don exist so return false
$new_role = false;
}
/**
* UM hook
*
* @type filter
* @title um_set_user_role
* @description User role was changed
* @input_vars
* [{"var":"$new_role","type":"string","desc":"New role"},
* {"var":"$user_id","type":"int","desc":"User ID"},
* {"var":"$user","type":"array","desc":"Userdata"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_set_user_role', 'function_name', 10, 1 ); ?>
* @example
* <?php
* add_filter( 'um_set_user_role', 'my_set_user_role', 10, 1 );
* function my_set_user_role( $new_role ) {
* // your code here
* return $new_role;
* }
* ?>
*/
return apply_filters( 'um_set_user_role', $new_role, $user_id, $user );
}
/**
* Remove user role
*
* @param $user_id
* @param $role
*/
function remove_role( $user_id, $role ) {
// Validate user id
$user = get_userdata( $user_id );
// User exists
if ( ! empty( $user ) ) {
// Remove role
$user->remove_role( $role );
}
}
/**
* Remove user role
*
* @param $user_id
* @param $role
*/
function set_role_wp( $user_id, $role ) {
// Validate user id
$user = get_userdata( $user_id );
// User exists
if ( ! empty( $user ) ) {
// Remove role
$user->add_role( $role );
}
}
/**
* Get user one of UM roles if it has it
*
* @deprecated since 2.0
* @param int $user_id
* @return bool|mixed
*/
function um_get_user_role( $user_id ) {
return $this->get_um_user_role( $user_id );
}
/**
* @param $user_id
*
* @return array|bool
*/
function get_all_user_roles( $user_id ) {
$user = get_userdata( $user_id );
if ( empty( $user->roles ) ) {
return false;
}
return array_values( $user->roles );
}
/**
* @param $user_id
*
* @return bool|mixed
*/
function get_priority_user_role( $user_id ) {
$user = get_userdata( $user_id );
if ( empty( $user->roles ) ) {
return false;
}
// User has roles so look for a UM Role one
$um_roles_keys = get_option( 'um_roles', array() );
if ( ! empty( $um_roles_keys ) ) {
$um_roles_keys = array_map(
function( $item ) {
return 'um_' . $item;
},
$um_roles_keys
);
}
$orders = array();
foreach ( array_values( $user->roles ) as $userrole ) {
if ( ! empty( $um_roles_keys ) && in_array( $userrole, $um_roles_keys, true ) ) {
$userrole_metakey = substr( $userrole, 3 );
} else {
$userrole_metakey = $userrole;
}
$rolemeta = get_option( "um_role_{$userrole_metakey}_meta", false );
if ( ! $rolemeta ) {
$orders[ $userrole ] = 0;
continue;
}
$orders[ $userrole ] = ! empty( $rolemeta['_um_priority'] ) ? $rolemeta['_um_priority'] : 0;
}
arsort( $orders );
$roles_in_priority = array_keys( $orders );
return array_shift( $roles_in_priority );
}
/**
* Get editable UM user roles
*
* @return array
*/
function get_editable_user_roles() {
$editable_roles = array( 'subscriber' );
// User has roles so look for a UM Role one
$um_roles_keys = get_option( 'um_roles', array() );
if ( ! empty( $um_roles_keys ) && is_array( $um_roles_keys ) ) {
$um_roles_keys = array_map( function( $item ) {
return 'um_' . $item;
}, $um_roles_keys );
$editable_roles = array_merge( $editable_roles, $um_roles_keys );
}
/**
* UM hook
*
* @type filter
* @title um_extend_editable_roles
* @description Extend Editable User Roles
* @input_vars
* [{"var":"$editable_roles","type":"array","desc":"Editable Roles Keys"}]
* @change_log
* ["Since: 2.6.0"]
* @usage add_filter( 'um_extend_editable_roles', 'function_name', 10, 1 );
* @example
* <?php
* add_filter( 'um_extend_editable_roles', 'my_um_extend_editable_roles', 10, 1 );
* function my_um_extend_editable_roles( $editable_roles ) {
* // your code here
* return $editable_roles;
* }
* ?>
*/
$editable_roles = apply_filters( 'um_extend_editable_roles', $editable_roles );
return $editable_roles;
}
/**
* @param $user_id
*
* @return bool|mixed
*/
function get_editable_priority_user_role( $user_id ) {
$user = get_userdata( $user_id );
if ( empty( $user->roles ) )
return false;
// User has roles so look for a UM Role one
$um_roles_keys = get_option( 'um_roles', array() );
if ( ! empty( $um_roles_keys ) ) {
$um_roles_keys = array_map( function( $item ) {
return 'um_' . $item;
}, $um_roles_keys );
}
$orders = array();
foreach ( array_values( $user->roles ) as $userrole ) {
if ( ! empty( $um_roles_keys ) && in_array( $userrole, $um_roles_keys ) ) {
$userrole_metakey = substr( $userrole, 3 );
} else {
$userrole_metakey = $userrole;
}
$rolemeta = get_option( "um_role_{$userrole_metakey}_meta", false );
if ( ! $rolemeta ) {
$orders[ $userrole ] = 0;
continue;
}
$orders[ $userrole ] = ! empty( $rolemeta['_um_priority'] ) ? $rolemeta['_um_priority'] : 0;
}
arsort( $orders );
$roles_in_priority = array_keys( $orders );
$roles_in_priority = array_intersect( $roles_in_priority, $this->get_editable_user_roles() );
return array_shift( $roles_in_priority );
}
/**
* @param $user_id
*
* @return bool|mixed
*/
function get_um_user_role( $user_id ) {
// User has roles so look for a UM Role one
$um_roles_keys = get_option( 'um_roles', array() );
if ( empty( $um_roles_keys ) ) {
return false;
}
$user = get_userdata( $user_id );
if ( empty( $user->roles ) ) {
return false;
}
$um_roles_keys = array_map( function( $item ) {
return 'um_' . $item;
}, $um_roles_keys );
$user_um_roles_array = array_intersect( $um_roles_keys, array_values( $user->roles ) );
if ( empty( $user_um_roles_array ) ) {
return false;
}
return array_shift( $user_um_roles_array );
}
/**
* Get role name by roleID
*
* @param $slug
* @return bool|string
*/
function get_role_name( $slug ) {
$roledata = $this->role_data( $slug );
if ( empty( $roledata['name'] ) ) {
global $wp_roles;
if ( empty( $wp_roles->roles[$slug] ) )
return false;
else
return $wp_roles->roles[$slug]['name'];
}
return $roledata['name'];
}
/**
* Get role data.
*
* @param int $role_id Role ID.
*
* @return array
*/
public function role_data( $role_id ) {
if ( empty( $role_id ) ) {
return array();
}
if ( strpos( $role_id, 'um_' ) === 0 ) {
$role_id = substr( $role_id, 3 );
$role_data = get_option( "um_role_{$role_id}_meta", array() );
}
if ( empty( $role_data ) ) {
$role_data = get_option( "um_role_{$role_id}_meta", array() );
}
if ( ! $role_data ) {
return array();
}
$temp = array();
foreach ( $role_data as $key => $value ) {
if ( strpos( $key, '_um_' ) === 0 ) {
$key = preg_replace( '/_um_/', '', $key, 1 );
}
$temp[ $key ] = $value;
}
/**
* Filters the Ultimate Member related user role data.
*
* @since 2.0
* @hook um_change_role_data
*
* @param {array} $role_data Role data.
* @param {string} $role_id Role ID.
*
* @return {array} Role data.
*
* @example <caption>Set {some_capability_key} capability for subscriber user role.</caption>
* function my_change_role_data( $role_data, $role_id ) {
* // your code here
* if ( 'subscriber' === $role_id ) {
* $role_data['{some_capability_key}'] = true;
* }
* return $role_data;
* }
* add_filter( 'um_change_role_data', 'my_change_role_data', 10, 2 );
*/
return apply_filters( 'um_change_role_data', $temp, $role_id );
}
/**
* Query for UM roles
*
* @param bool $add_default
* @param null $exclude
*
* @return array
*/
function get_roles( $add_default = false, $exclude = null ) {
global $wp_roles;
if ( empty( $wp_roles ) ) {
return array();
}
$roles = $wp_roles->role_names;
if ( $add_default ) {
$roles[0] = $add_default;
}
if ( $exclude ) {
foreach ( $exclude as $role ) {
unset ( $roles[ $role ] );
}
}
$roles = array_map( 'stripslashes', $roles );
return $roles;
}
/**
* Current user can
*
* @param $cap
* @param $user_id
*
* @return bool|int
*/
function um_current_user_can( $cap, $user_id ) {
if ( ! is_user_logged_in() ) {
return false;
}
$return = 1;
um_fetch_user( get_current_user_id() );
$current_user_roles = $this->get_all_user_roles( $user_id );
switch( $cap ) {
case 'edit':
if ( get_current_user_id() == $user_id ) {
if ( um_user( 'can_edit_profile' ) ) {
$return = 1;
} else {
$return = 0;
}
} else {
if ( ! um_user( 'can_access_private_profile' ) && UM()->user()->is_private_profile( $user_id ) ) {
$return = 0;
} else {
if ( ! um_user( 'can_edit_everyone' ) ) {
$return = 0;
} else {
if ( um_user( 'can_edit_roles' ) && ( empty( $current_user_roles ) || count( array_intersect( $current_user_roles, um_user( 'can_edit_roles' ) ) ) <= 0 ) ) {
$return = 0;
} else {
$return = 1;
}
}
}
}
break;
case 'delete':
if ( ! um_user( 'can_delete_everyone' ) )
$return = 0;
elseif ( um_user( 'can_delete_roles' ) && ( empty( $current_user_roles ) || count( array_intersect( $current_user_roles, um_user( 'can_delete_roles' ) ) ) <= 0 ) )
$return = 0;
break;
}
um_fetch_user( $user_id );
return $return;
}
/**
* User can ( role settings )
*
* @param $permission
* @return bool|mixed
*/
function um_user_can( $permission ) {
if ( ! is_user_logged_in() )
return false;
$user_id = get_current_user_id();
$role = UM()->roles()->get_priority_user_role( $user_id );
$permissions = $this->role_data( $role );
/**
* UM hook
*
* @type filter
* @title um_user_permissions_filter
* @description Change User Permissions
* @input_vars
* [{"var":"$permissions","type":"array","desc":"User Permissions"},
* {"var":"$user_id","type":"int","desc":"User ID"}]
* @change_log
* ["Since: 2.0"]
* @usage
* <?php add_filter( 'um_user_permissions_filter', 'function_name', 10, 2 ); ?>
* @example
* <?php
* add_filter( 'um_user_permissions_filter', 'my_user_permissions', 10, 2 );
* function my_user_permissions( $permissions, $user_id ) {
* // your code here
* return $permissions;
* }
* ?>
*/
$permissions = apply_filters( 'um_user_permissions_filter', $permissions, $user_id );
if ( isset( $permissions[ $permission ] ) && is_serialized( $permissions[ $permission ] ) )
return unserialize( $permissions[ $permission ] );
if ( isset( $permissions[ $permission ] ) && is_array( $permissions[ $permission ] ) )
return $permissions[ $permission ];
if ( isset( $permissions[ $permission ] ) && $permissions[ $permission ] == 1 )
return true;
return false;
}
}
}