ld-reports.php
59.3 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
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
<?php
/**
* Learndash Reports functions
*
* @since 2.3.0
*
* @package LearnDash\Reports
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Gets the list of user data.
*
* This function is a wrapper to the `WP_User_Query` function provided by WordPress.
*
* @since 2.3.0
*
* @param array $query_args Optional. The `WP_User_query` arguments. Default empty array.
*
* @return array An array of user query results.
*/
function learndash_get_users_query( $query_args = array() ) {
$default_args = array(
'fields' => 'ID',
);
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters the query arguments for getting users.
*
* @param array $query_args An array of user query arguments.
*/
$query_args = apply_filters( 'learndash_get_users_query_args', $query_args );
if ( ! empty( $query_args ) ) {
$user_query = new WP_User_Query( $query_args );
return $user_query->get_results();
}
return array();
}
/**
* Gets the list of user IDs for the report.
*
* This function will determine the list of users the current user can see. For example for
* group leader, it will show the only user within the leader's groups. For admin, it will
* show all users.
*
* @since 2.3.0
*
* @param int $user_id Optional. User ID. Defaults to the current user ID. Default 0.
* @param array $query_args Optional. User query arguments. Default empty array.
*
* @return array An array of user IDs.
*/
function learndash_get_report_user_ids( $user_id = 0, $query_args = array() ) {
if ( empty( $user_id ) ) {
// If the current user is not able to be determined. Then abort.
if ( ! is_user_logged_in() ) {
return;
}
$user_id = get_current_user_id();
}
$default_args = array(
'fields' => 'ID',
'orderby' => 'display_name',
'order' => 'ASC',
);
$query_args = wp_parse_args( $query_args, $default_args );
if ( learndash_is_admin_user( $user_id ) ) {
if ( LearnDash_Settings_Section::get_section_setting( 'LearnDash_Settings_Section_General_Admin_User', 'reports_include_admin_users' ) != 'yes' ) {
$query_args['role__not_in'] = 'administrator';
}
} elseif ( learndash_is_group_leader_user( $user_id ) ) {
$include_user_ids = learndash_get_group_leader_groups_users( $user_id );
// Even though we have the users ids from the learndash_get_group_leader_groups_users() we need to validate them
// by running them against the WP_User_Query.
if ( ! empty( $include_user_ids ) ) {
$query_args['include'] = $include_user_ids;
}
} else {
$query_args['include'] = array( $user_id );
}
/**
* Filters the query arguments for getting users for the report.
*
* @param array $query_args Query arguments.
*/
$query_args = apply_filters( 'learndash_get_report_users_query_args', $query_args );
$report_user_ids = learndash_get_users_query( $query_args );
/**
* Filters list of get report user ids.
*
* @param array|null $report_user_ids An array of report user ids.
*/
return apply_filters( 'learndash_get_report_user_ids', $report_user_ids );
}
/**
* Gets the count of active/published courses.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get the course count. Default empty array.
* @param string $return_field Optional. The `WP_Query` field to return. Default 'found_posts'.
*
* @return mixed Returns the `WP_Query` object if the return_field is empty
* otherwise the specified `WP_Query` return field.
*/
function learndash_get_courses_count( $query_args = array(), $return_field = 'found_posts' ) {
$return = 0;
$default_args = array(
'post_type' => 'sfwd-courses',
'post_status' => 'publish',
'fields' => 'ids',
);
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters courses count query arguments.
*
* @param array $query_args An array of course count query arguments.
*/
$query_args = apply_filters( 'learndash_courses_count_args', $query_args );
if ( 'found_posts' == $return_field ) {
$query_args['posts_per_page'] = 1;
$query_args['paged'] = 1;
}
if ( ( is_array( $query_args ) ) && ( ! empty( $query_args ) ) ) {
$query = new WP_Query( $query_args );
if ( $query instanceof WP_Query ) {
if ( ( ! empty( $return_field ) ) && ( property_exists( $query, $return_field ) ) ) {
$return = $query->$return_field;
} else {
$return = $query;
}
}
}
return $return;
}
/**
* Gets the count of pending sfwd-assignment posts.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get the pending assignments count. Default empty array.
* @param string $return_field Optional. The `WP_Query` field to return. Default 'found_posts'.
*
* @return mixed Returns the `WP_Query` object if the return_field is empty
* otherwise the specified `WP_Query` return field.
*/
function learndash_get_assignments_pending_count( $query_args = array(), $return_field = 'found_posts' ) {
$return = 0;
$default_args = array(
'post_type' => 'sfwd-assignment',
'post_status' => 'publish',
'fields' => 'ids',
'meta_query' => array(
array(
'key' => 'approval_status',
'compare' => 'NOT EXISTS',
),
),
);
// added logic for non-admin user like group leaders who will only see a sub-set of assignments.
$user_id = get_current_user_id();
if ( learndash_is_group_leader_user( $user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $user_id );
$user_ids = array();
$course_ids = array();
if ( ! empty( $group_ids ) && is_array( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_users = learndash_get_groups_user_ids( $group_id );
if ( ! empty( $group_users ) && is_array( $group_users ) ) {
foreach ( $group_users as $group_user_id ) {
$user_ids[ $group_user_id ] = $group_user_id;
}
}
$group_course_ids = learndash_group_enrolled_courses( $group_id );
if ( ( ! empty( $group_course_ids ) ) && ( is_array( $group_course_ids ) ) ) {
$course_ids = array_merge( $course_ids, $group_course_ids );
}
}
} else {
return $return;
}
if ( ! empty( $course_ids ) && count( $course_ids ) ) {
$default_args['meta_query'][] = array(
'key' => 'course_id',
'value' => $course_ids,
'compare' => 'IN',
);
} else {
return $return;
}
if ( ! empty( $user_ids ) && count( $user_ids ) ) {
$default_args['author__in'] = $user_ids;
} else {
return $return;
}
}
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters pending assignments count query arguments.
*
* @param array $query_args An array of pending assignment count query arguments.
*/
$query_args = apply_filters( 'learndash_get_assignments_pending_count_query_args', $query_args );
if ( 'found_posts' == $return_field ) {
$query_args['posts_per_page'] = 1;
$query_args['paged'] = 1;
}
if ( ( is_array( $query_args ) ) && ( ! empty( $query_args ) ) ) {
$query = new WP_Query( $query_args );
if ( ( ! empty( $return_field ) ) && ( property_exists( $query, $return_field ) ) ) {
$return = $query->$return_field;
} else {
$return = $query;
}
}
return $return;
}
/**
* Gets the link to admin assignments(sfwd-assignment) posts listing.
*
* @param array $link_args Optional. The query arguments to get the link. Default empty array.
*
* @since 2.3.0
*
* @return string The URL to assignment admin page with filters.
*/
function learndash_admin_get_assignments_listing_link( $link_args = array() ) {
$default_args = array(
'post_type' => 'sfwd-assignment',
'post_status' => 'all',
);
$link_args = wp_parse_args( $link_args, $default_args );
// Just in case someone tried to insert action/actions triggers. Remove them.
if ( isset( $link_args['action'] ) ) {
unset( $link_args['action'] );
}
if ( isset( $link_args['action2'] ) ) {
unset( $link_args['action2'] );
}
// Then remove any empty items. Less URL space.
foreach ( $link_args as $l_key => $l_val ) {
if ( '' == $l_val ) {
unset( $link_args[ $l_key ] );
}
}
if ( ! empty( $link_args ) ) {
return add_query_arg( $link_args, admin_url( 'edit.php' ) );
}
return '';
}
/**
* Gets the link to admin pending assignments(sfwd-assignment) posts listing.
*
* @since 2.3.0
*
* @return string The URL to pending assignments admin page with filters.
*/
function learndash_admin_get_assignments_pending_listing_link() {
return learndash_admin_get_assignments_listing_link( 'approval_status=0' );
}
/**
* Gets the count of pending Essays(sfwd-essays) posts.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get the pending essays count. Default empty array.
* @param string $return_field Optional. The `WP_Query` field to return. Default 'found_posts'.
*
* @return mixed Returns the `WP_Query` object if the return_field is empty
* otherwise the specified `WP_Query` return field.
*/
function learndash_get_essays_pending_count( $query_args = array(), $return_field = 'found_posts' ) {
$return = 0;
$default_args = array(
'post_type' => 'sfwd-essays',
'post_status' => 'not_graded',
'fields' => 'ids',
);
// added logic for non-admin user like group leaders who will only see a sub-set of assignments.
$user_id = get_current_user_id();
if ( learndash_is_group_leader_user( $user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $user_id );
$user_ids = array();
$course_ids = array();
if ( ! empty( $group_ids ) && is_array( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_users = learndash_get_groups_user_ids( $group_id );
if ( ! empty( $group_users ) && is_array( $group_users ) ) {
foreach ( $group_users as $group_user_id ) {
$user_ids[ $group_user_id ] = $group_user_id;
}
}
$group_course_ids = learndash_group_enrolled_courses( $group_id );
if ( ( ! empty( $group_course_ids ) ) && ( is_array( $group_course_ids ) ) ) {
$course_ids = array_merge( $course_ids, $group_course_ids );
}
}
} else {
return $return;
}
if ( ! empty( $course_ids ) && count( $course_ids ) ) {
$default_args['meta_query'][] = array(
'key' => 'course_id',
'value' => $course_ids,
'compare' => 'IN',
);
} else {
return $return;
}
if ( ! empty( $user_ids ) && count( $user_ids ) ) {
$default_args['author__in'] = $user_ids;
} else {
return $return;
}
}
$query_args = wp_parse_args( $query_args, $default_args );
/**
* Filters pending essays count query arguments.
*
* @param array $query_args An array of pending essays count query arguments.
*/
$query_args = apply_filters( 'learndash_get_essays_pending_count_query_args', $query_args );
if ( 'found_posts' == $return_field ) {
$query_args['posts_per_page'] = 1;
$query_args['paged'] = 1;
}
if ( ( is_array( $query_args ) ) && ( ! empty( $query_args ) ) ) {
$query = new WP_Query( $query_args );
if ( ( ! empty( $return_field ) ) && ( property_exists( $query, $return_field ) ) ) {
$return = $query->$return_field;
} else {
$return = $query;
}
}
return $return;
}
/**
* Gets the link to admin Essays(sfwd-essays) posts listing.
*
* @param array $link_args An array of arguments to override or supplement query string. Default empty array.
*
* @since 2.3.0
*
* @return string The URL to essays admin page with filters.
*/
function learndash_admin_get_essays_listing_link( $link_args = array() ) {
$default_args = array(
'post_type' => 'sfwd-essays',
'post_status' => 'all',
);
$link_args = wp_parse_args( $link_args, $default_args );
// Just in case someone tried to insert action/actions triggers. Remove them.
if ( isset( $link_args['action'] ) ) {
unset( $link_args['action'] );
}
if ( isset( $link_args['action2'] ) ) {
unset( $link_args['action2'] );
}
// Then remove any empty items. Less URL space.
foreach ( $link_args as $l_key => $l_val ) {
if ( '' == $l_val ) {
unset( $link_args[ $l_key ] );
}
}
if ( ! empty( $link_args ) ) {
return add_query_arg( $link_args, admin_url( 'edit.php' ) );
}
return '';
}
/**
* Gets the link to admin pending Essays(sfwd-essays) posts listing.
*
* @since 2.3.0
*
* @return string The URL to essays admin page with filters.
*/
function learndash_admin_get_essays_pending_listing_link() {
return learndash_admin_get_essays_listing_link( 'post_status=not_graded' );
}
/**
* Gets the count of users in the system.
*
* This will automatically exclude the count of the 'administrator' role.
*
* @since 2.3.0
*
* @param array $user_query_args Optional. The `WP_User_Query` query arguments. Default empty array.
*
* @return int The count of users excluding admins.
*/
function learndash_students_enrolled_count( $user_query_args = array() ) {
$return_total_users = 0;
$default_args = array(
'role__not_in' => 'Administrator',
'count_total' => true,
'fields' => 'ID',
);
/**
* Filters students enrolled count query arguments.
*
* @param array $query_args An array of students enrolled count query arguments.
*/
$user_query_args = apply_filters(
'learndash_students_enrolled_count_qrgs', // cspell:disable-line.
wp_parse_args( $user_query_args, $default_args )
);
if ( ! empty( $user_query_args ) ) {
$user_query = new WP_User_Query( $user_query_args );
$return_total_users = $user_query->get_total();
}
return $return_total_users;
}
/**
* Gets the list or count of group users for a group leader.
*
* @param int $user_id Optional. Group leader user ID. Defaults to the current user ID. Default 0.
* @param boolean $by_group Optional. Whether to get user IDs or count sorted by group. Default false.
* @param boolean $totals_only Optional. Whether to get the only count of users. Default false.
*
* @return int|array An array of user IDs or user count.
*/
function learndash_get_group_leader_groups_users( $user_id = 0, $by_group = false, $totals_only = false ) {
if ( false == $by_group ) {
if ( true == $totals_only ) {
$user_ids = 0;
} else {
$user_ids = array();
}
} else {
if ( true == $totals_only ) {
$user_ids = array();
} else {
$user_ids = 0;
}
}
if ( empty( $user_id ) ) {
// If the current user is not able to be determined. Then abort.
if ( ! is_user_logged_in() ) {
return;
}
$user_id = get_current_user_id();
}
if ( learndash_is_group_leader_user( $user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $user_id );
if ( ! empty( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_user_ids = learndash_get_groups_user_ids( $group_id );
if ( true == $by_group ) {
if ( true == $totals_only ) {
$user_ids[ $group_id ] = count( $group_user_ids );
} else {
$user_ids[ $group_id ] = $group_user_ids;
}
} else {
if ( true == $totals_only ) {
$user_ids += count( $group_user_ids );
} else {
$user_ids = array_merge( $user_ids, $group_user_ids );
}
}
}
}
}
if ( ! empty( $user_ids ) ) {
if ( false == $by_group ) {
$user_ids = array_unique( $user_ids );
}
}
return $user_ids;
}
/**
* Gets the list or count of group courses for a group leader.
*
* @param int $group_leader_user_id Optional. Group leader user ID. Defaults to the current user ID. Default 0.
* @param boolean $by_group Optional. Whether to get user IDs or count sorted by group. Default false.
* @param boolean $totals_only Optional. Whether to get the only count of courses. Default false.
*
* @return int|array An array of user IDs or user count.
*/
function learndash_get_group_leader_groups_courses( $group_leader_user_id = 0, $by_group = false, $totals_only = false ) {
if ( false == $by_group ) {
if ( true == $totals_only ) {
$course_ids = 0;
} else {
$course_ids = array();
}
} else {
if ( true == $totals_only ) {
$course_ids = array();
} else {
$course_ids = 0;
}
}
if ( empty( $group_leader_user_id ) ) {
$group_leader_user_id = get_current_user_id();
}
if ( learndash_is_group_leader_user( $group_leader_user_id ) ) {
$group_ids = learndash_get_administrators_group_ids( $group_leader_user_id );
if ( ! empty( $group_ids ) ) {
foreach ( $group_ids as $group_id ) {
$group_course_ids = learndash_group_enrolled_courses( $group_id );
if ( true == $by_group ) {
if ( true == $totals_only ) {
$course_ids[ $group_id ] = count( $group_course_ids );
} else {
$course_ids[ $group_id ] = $group_course_ids;
}
} else {
if ( true == $totals_only ) {
$course_ids += count( $group_course_ids );
} else {
$course_ids = array_merge( $course_ids, $group_course_ids );
}
}
}
}
}
if ( ! empty( $course_ids ) ) {
if ( false == $by_group ) {
$course_ids = array_unique( $course_ids );
}
}
return $course_ids;
}
/**
* Queries the user activity for the report.
*
* This function will query the new learndash_course_user_activity table for user/course Activity.
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global array $learndash_post_types An array of learndash post types.
*
* @since 2.3.0
*
* @param array $query_args Optional. The query arguments to get user activity. Default empty array.
* @param int $current_user_id Optional. The user to run the query as. Defaults to the current user. Default 0.
*
* @return array Returns user activity query results.
*/
function learndash_reports_get_activity( $query_args = array(), $current_user_id = 0 ) {
global $wpdb, $learndash_post_types;
$activity_results = array();
$activity_status_has_null = false;
$defaults = array(
// array or comma lst of group ids to use in query. Default is all groups.
'group_ids' => '',
// array or comma list of course.
'course_ids' => '',
'course_ids_action' => 'IN',
// array or comma list of course, lesson, topic, etc. Default is all posts.
'post_ids' => '',
'post_ids_action' => 'IN',
// array or comma list of LD specific post types. See $learndash_post_types for possible values.
'post_types' => '',
// array or comma list of post statuses. See $learndash_post_types for possible values.
'post_status' => '',
// array or comma list of user ids. Defaults to all user ids.
'user_ids' => '',
'user_ids_action' => 'IN',
// An array of activity_type values to filter. Default is all types.
'activity_types' => '',
// An array of activity_status values to filter. Possible values 'NOT_STARTED' , 'IN_PROGRESS', 'COMPLETED'.
// This field is converted into a boolean value later (line 796).
'activity_status' => '',
// controls number of items to return for request. Pass 0 for ALL items.
'per_page' => 10,
// Used in combination with 'per_page' to set the page set of items to return.
'paged' => 1,
// order by fields AND order (DESC, ASC) combined to allow multiple fields and directions.
'orderby_order' => 'GREATEST(ld_user_activity.activity_started, ld_user_activity.activity_completed) DESC',
// Search value. See 'search_context' for specifying search fields.
's' => '',
// Limit search to 'post_title' OR 'display_name'. If empty will include both.
's_context' => '',
// start and/or end time filtering. Should be date format strings 'YYYY-MM-DD HH:mm:ss' or 'YYYY-MM-DD'.
'time_start' => 0,
'time_end' => 0,
// Indicators to tell the logic if the values passed via 'time_start' and 'time_end' are GMT or local (timezone offset).
'time_start_is_gmt' => false,
'time_end_is_gmt' => false,
// date values returned from the query will be a gmt timestamp int. If the 'date_format' value is provided
// a new field will be include 'activity_date_time_formatted' using the format specifiers provided in this field.
/** This filter is documented in includes/ld-misc-functions.php */
'date_format' => apply_filters( 'learndash_date_time_formats', get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) ),
'include_meta' => true,
'meta_fields' => array(),
// controls if the queries are actually executed. You can pass in true or 1 to have the logic tested without running the actual query.
'dry_run' => 0,
// Suppress ALL filters. This include both the query_args and query_str filters.
'suppress_filters_all' => 0,
// If the 'suppress_filters_all' is NOT set you can set this to control just filters for the final query_args.
'suppress_filters_query_args' => 0,
// If the 'suppress_filters_all' is NOT set you can set this to control just filters for the final query_str.
'suppress_filters_query_str' => 0,
);
if ( empty( $current_user_id ) ) {
if ( ! is_user_logged_in() ) {
return $activity_results;
}
$current_user_id = get_current_user_id();
}
$query_args = wp_parse_args( $query_args, $defaults );
// We save a copy of the original query_args to compare after we have filled in some default values.
$query_args_org = $query_args;
// Clean the group_ids arg.
if ( '' !== $query_args['group_ids'] ) {
if ( ! is_array( $query_args['group_ids'] ) ) {
$query_args['group_ids'] = explode( ',', $query_args['group_ids'] );
}
$query_args['group_ids'] = array_map( 'trim', $query_args['group_ids'] );
} else {
$query_args['group_ids'] = array();
}
// Clean the course_ids arg.
if ( '' !== $query_args['course_ids'] ) {
if ( ! is_array( $query_args['course_ids'] ) ) {
$query_args['course_ids'] = explode( ',', $query_args['course_ids'] );
}
$query_args['course_ids'] = array_map( 'trim', $query_args['course_ids'] );
} else {
$query_args['course_ids'] = array();
}
// Clean the post_ids arg.
if ( '' !== $query_args['post_ids'] ) {
if ( ! is_array( $query_args['post_ids'] ) ) {
$query_args['post_ids'] = explode( ',', $query_args['post_ids'] );
}
$query_args['post_ids'] = array_map( 'trim', $query_args['post_ids'] );
} else {
$query_args['post_ids'] = array();
}
// Clean the post_types arg.
if ( '' !== $query_args['post_types'] ) {
if ( is_string( $query_args['post_types'] ) ) {
$query_args['post_types'] = explode( ',', $query_args['post_types'] );
}
$query_args['post_types'] = array_map( 'trim', $query_args['post_types'] );
$query_args['post_types'] = array_intersect( $query_args['post_types'], $learndash_post_types );
} else {
// If not provides we set this to our internal defined learndash_post_types.
$query_args['post_types'] = $learndash_post_types;
}
// Clean the post_status arg.
if ( '' !== $query_args['post_status'] ) {
if ( is_string( $query_args['post_status'] ) ) {
$query_args['post_status'] = explode( ',', $query_args['post_status'] );
}
$query_args['post_status'] = array_map( 'trim', $query_args['post_status'] );
} else {
$query_args['post_status'] = array();
}
// Clean the user_ids arg.
if ( '' !== $query_args['user_ids'] ) {
if ( ! is_array( $query_args['user_ids'] ) ) {
$query_args['user_ids'] = explode( ',', $query_args['user_ids'] );
}
$query_args['user_ids'] = array_map( 'trim', $query_args['user_ids'] );
} else {
$query_args['user_ids'] = array();
}
if ( '' !== $query_args['activity_types'] ) {
if ( is_string( $query_args['activity_types'] ) ) {
$query_args['activity_types'] = explode( ',', $query_args['activity_types'] );
}
$query_args['activity_types'] = array_map( 'trim', $query_args['activity_types'] );
} else {
$query_args['activity_types'] = array();
}
if ( '' !== $query_args['activity_status'] ) {
if ( is_string( $query_args['activity_status'] ) ) {
$query_args['activity_status'] = explode( ',', $query_args['activity_status'] );
}
$query_args['activity_status'] = array_map( 'trim', $query_args['activity_status'] );
$not_started_idx = array_search( 'NOT_STARTED', $query_args['activity_status'], true );
if ( false !== $not_started_idx ) {
$activity_status_has_null = true;
unset( $query_args['activity_status'][ $not_started_idx ] );
}
foreach ( $query_args['activity_status'] as $idx => $value ) {
if ( 'COMPLETED' == $value ) {
$query_args['activity_status'][ $idx ] = '1';
} else {
$query_args['activity_status'][ $idx ] = '0';
}
}
} else {
$query_args['activity_status'] = array();
}
// Sanitize values.
$query_args['user_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['user_ids'] ) );
$query_args['post_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['post_ids'] ) );
$query_args['group_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['group_ids'] ) );
$query_args['course_ids'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['course_ids'] ) );
$query_args['post_status'] = array_unique( LDLMS_DB::escape_string_array( $query_args['post_status'] ) );
$query_args['post_types'] = array_unique( LDLMS_DB::escape_string_array( $query_args['post_types'] ) );
$query_args['activity_status'] = array_unique( LDLMS_DB::escape_numeric_array( $query_args['activity_status'] ) );
$query_args['activity_types'] = array_unique( LDLMS_DB::escape_string_array( $query_args['activity_types'] ) );
if ( empty( $query_args['group_ids'] ) && empty( $query_args['post_ids'] ) && empty( $query_args['user_ids'] ) ) {
// If no filters were provided.
// If the view user is a group leader we just return all the activity for all the managed users.
if ( learndash_is_group_leader_user( $current_user_id ) ) {
$query_args['user_ids'] = learndash_get_group_leader_groups_users( $current_user_id );
}
} else {
if ( ! learndash_is_group_leader_user( $current_user_id ) ) {
if ( learndash_is_admin_user( $current_user_id ) ) {
// If the group_ids parameter is passed in we need to determine the course_ids contains in the group_ids.
if ( ! empty( $query_args['group_ids'] ) ) {
$query_args['post_ids'] = learndash_get_groups_courses_ids( $current_user_id, $query_args['group_ids'] );
}
} else {
/**
* If the user if not a group leader and not admin then abort until we have added support for those roles.
* return $activity_results;
*/
if ( empty( $query_args['user_ids'] ) ) {
$query_args['user_ids'] = array( get_current_user_id() );
}
if ( empty( $query_args['post_ids'] ) ) {
$query_args['post_ids'] = learndash_user_get_enrolled_courses( get_current_user_id() );
if ( empty( $query_args['post_ids'] ) ) {
return $activity_results;
}
}
}
}
}
// We need a timestamp (long int) for the query. Most likely there will be a date string passed to up.
$time_items = array( 'time_start', 'time_end' );
foreach ( $time_items as $time_item ) {
if ( ! empty( $query_args[ $time_item ] ) ) {
if ( ! is_string( $query_args[ $time_item ] ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$time_yymmdd = date( 'Y-m-d H:i:s', $query_args[ $time_item ] );
} else {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$time_yymmdd = date( 'Y-m-d H:i:s', strtotime( $query_args[ $time_item ] ) );
}
if ( true != $query_args[ $time_item . '_is_gmt' ] ) {
$time_yymmdd = get_gmt_from_date( $time_yymmdd );
}
$time_yymmdd = strtotime( $time_yymmdd );
if ( $time_yymmdd ) {
$query_args[ $time_item . '_gmt_timestamp' ] = $time_yymmdd;
}
}
}
// Check that the start and end dates are not backwards.
if ( ( isset( $query_args['time_start_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_start_gmt_timestamp'] ) )
&& ( isset( $query_args['time_end_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_end_gmt_timestamp'] ) ) ) {
if ( $query_args['time_start_gmt_timestamp'] > $query_args['time_end_gmt_timestamp'] ) {
$time_save = $query_args['time_start_gmt_timestamp'];
$query_args['time_start_gmt_timestamp'] = $query_args['time_end_gmt_timestamp'];
$query_args['time_end_gmt_timestamp'] = $time_save;
}
}
if ( ( true != $query_args['suppress_filters_all'] ) && ( true != $query_args['suppress_filters_query_args'] ) ) {
/**
* Filters query arguments for getting user activity.
*
* @param array $query_args An array query arguments for getting user activity.
*/
$query_args = apply_filters( 'learndash_get_activity_query_args', $query_args );
}
$sql_str_fields = '
users.ID as user_id,
users.display_name as user_display_name,
users.user_email as user_email,
posts.ID as post_id,
posts.post_title post_title,
posts.post_type as post_type,
ld_user_activity.activity_id as activity_id,
ld_user_activity.course_id as activity_course_id,
ld_user_activity.activity_type as activity_type,
ld_user_activity.activity_started as activity_started,
ld_user_activity.activity_completed as activity_completed,
ld_user_activity.activity_updated as activity_updated,
ld_user_activity.activity_status as activity_status';
$sql_str_tables = ' FROM ' . $wpdb->users . ' as users ';
// Some funky logic on the activity status. If the 'activity_status' is empty of the activity has NULL means we are looking for the
// 'NOT_STARTED'. In order to find users that have not started courses we need to do the INNER JOIN on the wp_posts table. This
// means for every combination of users AND posts (courses) we will fill out row. This can be expensive when you have thousands
// of users and courses.
if ( ( empty( $query_args['activity_status'] ) ) || ( true === $activity_status_has_null )
&& ( ( ! empty( $query_args['post_ids'] ) ) || ( ! empty( $query_args['user_ids'] ) ) ) ) {
$sql_str_joins = ' INNER JOIN ' . $wpdb->posts . ' as posts ';
$sql_str_joins .= ' LEFT JOIN ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' as ld_user_activity ON users.ID=ld_user_activity.user_id AND posts.ID=ld_user_activity.post_id ';
if ( ! empty( $query_args['activity_types'] ) ) {
$sql_str_joins .= ' AND (ld_user_activity.activity_type IS NULL OR ld_user_activity.activity_type IN (' . "'" . implode( "','", $query_args['activity_types'] ) . "'" . ') )';
}
} else {
$sql_str_joins = ' LEFT JOIN ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' as ld_user_activity ON users.ID=ld_user_activity.user_id ';
$sql_str_joins .= ' LEFT JOIN ' . $wpdb->posts . ' as posts ON posts.ID=ld_user_activity.post_id ';
}
$sql_str_where = ' WHERE 1=1 ';
if ( ! empty( $query_args['user_ids'] ) ) {
$sql_str_where .= ' AND users.ID ' . $query_args['user_ids_action'] . ' (' . implode( ',', $query_args['user_ids'] ) . ') ';
}
if ( ! empty( $query_args['post_ids'] ) ) {
$sql_str_where .= ' AND posts.ID ' . $query_args['post_ids_action'] . ' (' . implode( ',', $query_args['post_ids'] ) . ') ';
}
if ( ! empty( $query_args['post_status'] ) ) {
$sql_str_where .= ' AND posts.post_status IN (' . "'" . implode( "','", $query_args['post_status'] ) . "'" . ') ';
}
if ( ! empty( $query_args['post_types'] ) ) {
$sql_str_where .= ' AND posts.post_type IN (' . "'" . implode( "','", $query_args['post_types'] ) . "'" . ') ';
}
if ( true !== $activity_status_has_null ) {
if ( ! empty( $query_args['activity_types'] ) ) {
$sql_str_where .= ' AND ld_user_activity.activity_type IN (' . "'" . implode( "','", $query_args['activity_types'] ) . "'" . ') ';
}
if ( ! empty( $query_args['activity_status'] ) ) {
$sql_str_where .= ' AND ld_user_activity.activity_status IN (' . implode( ',', $query_args['activity_status'] ) . ') ';
}
} else {
if ( ! empty( $query_args['activity_status'] ) ) {
$sql_str_where .= ' AND (ld_user_activity.activity_status IS NULL OR ld_user_activity.activity_status IN (' . "'" . implode( "','", $query_args['activity_status'] ) . "'" . ') ) ';
} else {
$sql_str_where .= ' AND ( ld_user_activity.activity_status IS NULL OR ld_user_activity.activity_started = 0 ) ';
}
}
if ( ! empty( $query_args['course_ids'] ) ) {
$sql_str_where .= ' AND ld_user_activity.course_id ' . $query_args['course_ids_action'] . ' (' . implode( ',', $query_args['course_ids'] ) . ') ';
}
if ( ( isset( $query_args['time_start_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_start_gmt_timestamp'] ) ) && ( isset( $query_args['time_end_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_end_gmt_timestamp'] ) ) ) {
$sql_str_where .= ' AND ( ';
// This is an old code. We will never get here. activity_status is converted to boolean before this. See line 795.
if ( array_intersect( array( 'NOT_STARTED', 'IN_PROGRESS' ), $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= '(ld_user_activity.activity_started BETWEEN ' . $query_args['time_start_gmt_timestamp'] . ' AND ' . $query_args['time_end_gmt_timestamp'] . ') ';
$sql_str_where .= ' OR ';
$sql_str_where .= '(ld_user_activity.activity_updated BETWEEN ' . $query_args['time_start_gmt_timestamp'] . ' AND ' . $query_args['time_end_gmt_timestamp'] . ') ';
}
if ( in_array( 'COMPLETED', $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
if ( count( $query_args_org['activity_status'] ) > 1 || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= ' OR ';
}
$sql_str_where .= '(ld_user_activity.activity_completed BETWEEN ' . $query_args['time_start_gmt_timestamp'] . ' AND ' . $query_args['time_end_gmt_timestamp'] . ') ';
}
$sql_str_where .= ' ) ';
} elseif ( ( isset( $query_args['time_start_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_start_gmt_timestamp'] ) ) ) {
$sql_str_where .= ' AND ( ';
// This is an old code. We will never get here. activity_status is converted to boolean before this. See line 795.
if ( array_intersect( array( 'NOT_STARTED', 'IN_PROGRESS' ), $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= 'ld_user_activity.activity_started >= ' . $query_args['time_start_gmt_timestamp'] . ' OR ld_user_activity.activity_updated >= ' . $query_args['time_start_gmt_timestamp'];
}
if ( in_array( 'COMPLETED', $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
if ( count( $query_args_org['activity_status'] ) > 1 || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= ' OR ';
}
$sql_str_where .= 'ld_user_activity.activity_completed >= ' . $query_args['time_start_gmt_timestamp'];
}
$sql_str_where .= ' ) ';
} elseif ( ( isset( $query_args['time_end_gmt_timestamp'] ) ) && ( ! empty( $query_args['time_end_gmt_timestamp'] ) ) ) {
$sql_str_where .= ' AND ( ';
// This is an old code. We will never get here. activity_status is converted to boolean before this. See line 795.
if ( array_intersect( array( 'NOT_STARTED', 'IN_PROGRESS' ), $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= '(ld_user_activity.activity_started > 0 AND ld_user_activity.activity_started <= ' . $query_args['time_end_gmt_timestamp'] . ') OR ( ld_user_activity.activity_updated > 0 AND ld_user_activity.activity_updated <= ' . $query_args['time_end_gmt_timestamp'] . ')';
}
if ( in_array( 'COMPLETED', $query_args_org['activity_status'] ) || empty( $query_args_org['activity_status'] ) ) {
if ( count( $query_args_org['activity_status'] ) > 1 || empty( $query_args_org['activity_status'] ) ) {
$sql_str_where .= ' OR ';
}
$sql_str_where .= '( ld_user_activity.activity_completed > 0 AND ld_user_activity.activity_completed <= ' . $query_args['time_end_gmt_timestamp'] . ' )';
}
$sql_str_where .= ' ) ';
}
if ( ! empty( $query_args['s'] ) ) {
if ( 'post_title' == $query_args['s_context'] ) {
$sql_str_where .= " AND posts.post_title LIKE '" . $query_args['s'] . "' ";
} elseif ( 'display_name' == $query_args['s_context'] ) {
$sql_str_where .= " AND users.display_name LIKE '" . $query_args['s'] . "' ";
} else {
$sql_str_where .= " AND (posts.post_title LIKE '" . $query_args['s'] . "' OR users.display_name LIKE '" . $query_args['s'] . "') ";
}
}
if ( ! empty( $query_args['orderby_order'] ) ) {
$sql_str_order = ' ORDER BY ' . $query_args['orderby_order'] . ' ';
} else {
$sql_str_order = '';
}
if ( ! empty( $query_args['per_page'] ) ) {
if ( empty( $query_args['paged'] ) ) {
$query_args['paged'] = 1;
}
$sql_str_limit = ' LIMIT ' . $query_args['per_page'] . ' OFFSET ' . ( abs( intval( $query_args['paged'] ) ) - 1 ) * $query_args['per_page'];
} else {
$sql_str_limit = '';
}
if ( ( true != $query_args['suppress_filters_all'] ) && ( true != $query_args['suppress_filters_query_str'] ) ) {
/**
* Filters user activity query fields.
*
* @param string $sql_query_fields User activity query fields with valid sql syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_fields = apply_filters( 'learndash_user_activity_query_fields', $sql_str_fields, $query_args );
/**
* Filters tables and joins to be used for user activity query. The `from` part of the query with valid SQL syntax.
*
* @param string $sql_query_from The `from` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_tables = apply_filters( 'learndash_user_activity_query_tables', $sql_str_tables, $query_args );
/**
* Filters the joins for the user activity query.
*
* @param string $sql_query_where The `where` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_joins = apply_filters( 'learndash_user_activity_query_joins', $sql_str_joins, $query_args );
/**
* Filters the where condition of the user activity query.
*
* @param string $sql_query_where The `where` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_where = apply_filters( 'learndash_user_activity_query_where', $sql_str_where, $query_args );
/**
* Filters the order by part of the user activity query.
*
* @param string $sql_query_where The `ORDER BY` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_order = apply_filters( 'learndash_user_activity_query_order', $sql_str_order, $query_args );
/**
* Filters the limit part of the user activity query.
*
* @param string $sql_query_where The `limit` part of the SQL query with valid SQL syntax.
* @param array $query_args An array of user query arguments.
*/
$sql_str_limit = apply_filters( 'learndash_user_activity_query_limit', $sql_str_limit, $query_args );
}
$sql_str = 'SELECT ' . $sql_str_fields . $sql_str_tables . $sql_str_joins . $sql_str_where . $sql_str_order . $sql_str_limit;
if ( true != $query_args['suppress_filters_query_str'] ) {
/**
* Filters the user activity SQL query string.
*
* @param string $sql_str User activity SQL query string.
* @param array $query_args An array of user query arguments.
*/
$sql_str = apply_filters( 'learndash_user_activity_query_str', $sql_str, $query_args );
}
$activity_results['query_str'] = $sql_str;
$activity_results['query_args'] = $query_args;
$activity_results['results'] = array();
$activity_results['pager'] = array();
$activity_results['pager']['total_items'] = 0;
$activity_results['pager']['per_page'] = intval( $query_args['per_page'] );
$activity_results['pager']['total_pages'] = 0;
if ( ( ! empty( $sql_str ) ) && ( 1 != $query_args['dry_run'] ) ) {
$activity_query_results = $wpdb->get_results( $sql_str ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( ( ! is_wp_error( $activity_query_results ) ) && ( count( $activity_query_results ) ) ) {
$activity_results['results'] = $activity_query_results;
// Need to convert the item date. Actually add a new property which is the formatted date.
foreach ( $activity_results['results'] as &$result_item ) {
// There are three date fields we need format.
// 1. activity_started.
if ( ( property_exists( $result_item, 'activity_started' ) ) && ( ! empty( $result_item->activity_started ) ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$result_item->activity_started_formatted = get_date_from_gmt( date( 'Y-m-d H:i:s', $result_item->activity_started ), $query_args['date_format'] );
}
// 2. activity_completed.
if ( ( property_exists( $result_item, 'activity_completed' ) ) && ( ! empty( $result_item->activity_completed ) ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$result_item->activity_completed_formatted = get_date_from_gmt( date( 'Y-m-d H:i:s', $result_item->activity_completed ), $query_args['date_format'] );
}
// 3. activity_completed
if ( ( property_exists( $result_item, 'activity_updated' ) ) && ( ! empty( $result_item->activity_updated ) ) ) {
// phpcs:ignore: WordPress.DateTime.RestrictedFunctions.date_date
$result_item->activity_updated_formatted = get_date_from_gmt( date( 'Y-m-d H:i:s', $result_item->activity_updated ), $query_args['date_format'] );
}
if ( true == $query_args['include_meta'] ) {
$result_item->activity_meta = learndash_get_activity_meta_fields( $result_item->activity_id, $query_args['meta_fields'] );
}
}
} else {
$activity_results['results_error'] = $activity_query_results;
}
}
if ( ( 1 != $query_args['dry_run'] ) && ( isset( $activity_results['results'] ) ) && ( ! empty( $activity_results['results'] ) ) && ( ! empty( $query_args['per_page'] ) ) ) {
$query_str_count = 'SELECT SQL_CALC_FOUND_ROWS count(*) as count ' . $sql_str_tables . $sql_str_joins . ' ' . $sql_str_where;
$activity_query_count = $wpdb->get_row( $query_str_count ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( ( ! is_wp_error( $activity_query_count ) ) && ( property_exists( $activity_query_count, 'count' ) ) ) {
$activity_results['pager'] = array();
$activity_results['pager']['total_items'] = absint( $activity_query_count->count );
$activity_results['pager']['per_page'] = absint( $query_args['per_page'] );
if ( $activity_results['pager']['total_items'] > 0 ) {
$activity_results['pager']['total_pages'] = ceil( intval( $activity_results['pager']['total_items'] ) / intval( $activity_results['pager']['per_page'] ) );
$activity_results['pager']['total_pages'] = absint( $activity_results['pager']['total_pages'] );
} else {
$activity_results['pager']['total_pages'] = 0;
}
} else {
$activity_results['pager_error'] = $activity_query_count;
}
}
return $activity_results;
}
/**
* Gets the user's course progress for the report.
*
* @since 2.3.0
*
* @param int $course_id Optional. The ID of the course to get user progress. Default 0.
* @param array $user_query_args Optional. The ID of the user to get progress. Default empty array.
* @param array $activity_query_args Optional. The query arguments to get the user activity. Default empty array.
*
* @return array Returns user course progress results.
*/
function learndash_report_course_users_progress( $course_id = 0, $user_query_args = array(), $activity_query_args = array() ) {
$course_user_progress_data = array();
if ( ! empty( $course_id ) ) {
// If the user_ids was not passed from the caller then we need to do that work.
if ( ( ! isset( $activity_query_args['user_ids'] ) ) || ( empty( $activity_query_args['user_ids'] ) ) ) {
$course_user_query = learndash_get_users_for_course( intval( $course_id ), $user_query_args );
if ( $course_user_query instanceof WP_User_Query ) {
$activity_query_args['user_ids'] = $course_user_query->get_results();
}
}
if ( ! empty( $activity_query_args['user_ids'] ) ) {
$activity_query_defaults = array(
'post_ids' => intval( $course_id ),
'post_types' => 'sfwd-courses',
'activity_types' => 'course',
'activity_status' => '',
'orderby_order' => 'users.display_name, posts.post_title',
'date_format' => 'F j, Y H:i:s',
'paged' => 1,
'per_page' => 10,
);
$activity_query_args = wp_parse_args( $activity_query_args, $activity_query_defaults );
$activity = learndash_reports_get_activity( $activity_query_args );
$report_course = get_post( $course_id );
if ( ! empty( $activity['results'] ) ) {
$course_user_progress_data = $activity;
}
}
}
return $course_user_progress_data;
}
/**
* Clears user activity by user id and activity type for the report.
*
* @since 2.5.0
*
* @param int $user_id Optional. The ID of the user to delete activity. Default 0.
* @param array $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*/
function learndash_report_clear_user_activity_by_types( $user_id = 0, $activity_types = '' ) {
$activity_ids = learndash_report_get_activity_by_user_id( $user_id, $activity_types );
if ( ! empty( $activity_ids ) ) {
learndash_report_clear_by_activity_ids( $activity_ids );
}
}
/**
* Clears post activity by post id and activity type for the report.
*
* @since 2.5.0
*
* @param int $post_id Optional. The ID of the post to delete activity. Default 0.
* @param array $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*/
function learndash_report_clear_post_activity_by_types( $post_id = 0, $activity_types = '' ) {
$activity_ids = learndash_report_get_activity_by_post_id( $post_id, $activity_types );
if ( ! empty( $activity_ids ) ) {
learndash_report_clear_by_activity_ids( $activity_ids );
}
}
/**
* Deletes the activity rows by activity ID for the report.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*
* @param array $activity_ids Optional. An array of activity IDs. Default empty.
*/
function learndash_report_clear_by_activity_ids( $activity_ids = array() ) {
global $wpdb;
if ( ! empty( $activity_ids ) ) {
$activity_ids = array_map( 'absint', $activity_ids );
$wpdb->query(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'DELETE FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity_meta' ) ) . ' WHERE activity_id IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_ids ) . ')',
LDLMS_DB::escape_IN_clause_values( $activity_ids )
)
);
$wpdb->query(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare, WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'DELETE FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE activity_id IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_ids ) . ')',
LDLMS_DB::escape_IN_clause_values( $activity_ids )
)
);
}
}
/**
* Removes the mismatched user activities.
*
* Compares user_id field from report activity DB table to WP users rows.
* Entries not found in report activity will be removed.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*/
function learndash_activity_clear_mismatched_users() {
global $wpdb;
$process_users = $wpdb->get_col(
'SELECT DISTINCT lua.user_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . " as lua LEFT JOIN {$wpdb->usermeta} as um1 ON lua.user_id = um1.user_id AND um1.meta_key = '{$wpdb->prefix}capabilities' LEFT JOIN {$wpdb->users} as users ON lua.user_id = users.ID WHERE 1=1 AND ( um1.meta_key IS NULL OR users.ID is NULL )"
);
if ( ! empty( $process_users ) ) {
foreach ( $process_users as $user_id ) {
learndash_report_clear_user_activity_by_types( $user_id );
}
}
}
/**
* Removes the mismatched post activities.
*
* Compares post_id field from report activity DB table to WP posts rows.
* Entries not found in report activity will be removed.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*/
function learndash_activity_clear_mismatched_posts() {
global $wpdb;
$process_posts = $wpdb->get_col(
'SELECT DISTINCT ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . '.post_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' LEFT JOIN ' . $wpdb->posts . ' ON ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . '.post_id=' . $wpdb->posts . '.ID WHERE ' . $wpdb->posts . '.ID is NULL'
);
if ( ! empty( $process_posts ) ) {
foreach ( $process_posts as $post_id ) {
learndash_report_clear_post_activity_by_types( $post_id );
}
}
}
/**
* Gets the list of activities by user ID for the report.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*
* @param int $user_id Optional. The ID of the user to get activities. Default 0.
* @param array|string $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*
* @return array|void Returns an array of activity IDs.
*/
function learndash_report_get_activity_by_user_id( $user_id = 0, $activity_types = '' ) {
global $wpdb;
if ( empty( $user_id ) ) {
return;
}
$activity_ids = array();
if ( empty( $activity_types ) ) {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id = %d',
$user_id
)
);
} else {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id = %d AND activity_type IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_types ) . ')',
array_merge( array( $user_id ), LDLMS_DB::escape_IN_clause_values( $activity_types ) )
)
);
}
return array_map( 'absint', $activity_ids );
}
/**
* Gets the list of activities by post id for the report.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.5.0
*
* @param int $post_id Optional. The ID of the post to get activities. Default 0.
* @param array|strings $activity_types Optional. The type of the activity to delete. Any combination of the
* following: 'access', 'course', 'lesson', 'topic', 'quiz'. Default empty.
*
* @return array|void Returns an array of activity IDs.
*/
function learndash_report_get_activity_by_post_id( $post_id = 0, $activity_types = '' ) {
global $wpdb;
if ( empty( $post_id ) ) {
return;
}
$activity_ids = array();
if ( empty( $activity_types ) ) {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE post_id = %d',
$post_id
)
);
} else {
$activity_ids = $wpdb->get_col(
$wpdb->prepare(
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- IN clause
'SELECT activity_id FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE post_id = %d AND activity_type IN (' . LDLMS_DB::escape_IN_clause_placeholders( $activity_types ) . ')',
array_merge( array( $post_id ), LDLMS_DB::escape_IN_clause_values( $activity_types ) )
)
);
}
return array_map( 'absint', $activity_ids );
}
/**
* Gets the users course progress for the report.
*
* @since 2.3.0
*
* @param int $user_id Optional. User ID to get course list. Default 0.
* @param array $course_query_args Optional. The query arguments to get the list of user enrolled courses. Default empty array.
* @param array $activity_query_args Optional. The query arguments to get the the user activities. Default empty array.
*
* @return array If course query and activity query is successful this should be a multi-dimensional array showing 'results', 'pager', 'query_args', 'query_str'
*/
function learndash_report_user_courses_progress( $user_id = 0, $course_query_args = array(), $activity_query_args = array() ) {
$user_courses_progress_data = array();
if ( empty( $user_id ) ) {
if ( ! is_user_logged_in() ) {
return $user_courses_progress_data;
}
$user_id = get_current_user_id();
}
// If the post_ids (Course ids) was not passed from the caller then we need to do that work.
if ( ( ! isset( $activity_query_args['post_ids'] ) ) || ( empty( $activity_query_args['post_ids'] ) ) ) {
$activity_query_args['post_ids'] = learndash_user_get_enrolled_courses( intval( $user_id ), $course_query_args );
}
if ( ! empty( $activity_query_args['post_ids'] ) ) {
$activity_query_defaults = array(
'user_ids' => intval( $user_id ),
'post_types' => 'sfwd-courses',
'activity_types' => 'course',
'activity_status' => '',
'orderby_order' => 'users.display_name, posts.post_title',
'date_format' => 'F j, Y H:i:s',
'paged' => 1,
'per_page' => 10,
);
$activity_query_args = wp_parse_args( $activity_query_args, $activity_query_defaults );
$report_user = get_user_by( 'id', $user_id );
$activity = learndash_reports_get_activity( $activity_query_args );
if ( ! empty( $activity['results'] ) ) {
$user_courses_progress_data = $activity;
}
}
return $user_courses_progress_data;
}
/**
* Gets the user quiz attempts activity.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.3.0
*
* @param int $user_id Optional. The ID of the user to get quiz attempts. Default 0.
* @param int $quiz_id Optional. The ID of the quiz to get attempts. Default 0.
*
* @return array|void An array of quiz attempt activity IDs.
*/
function learndash_get_user_quiz_attempts( $user_id = 0, $quiz_id = 0 ) {
global $wpdb;
if ( ( ! empty( $user_id ) ) || ( ! empty( $quiz_id ) ) ) {
return $wpdb->get_results(
$wpdb->prepare( 'SELECT activity_id, activity_started, activity_completed FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id = %d AND post_id = %d AND activity_type = %s ORDER BY activity_id, activity_started ASC', $user_id, $quiz_id, 'quiz' )
);
}
}
/**
* Gets the count of user quiz attempts.
*
* @since 2.3.0
*
* @param int $user_id The ID of the user to get quiz attempts.
* @param int $quiz_id The ID of the quiz to get attempts.
*
* @return int|void The count of quiz attempts.
*/
function learndash_get_user_quiz_attempts_count( $user_id, $quiz_id ) {
$quiz_attempts = learndash_get_user_quiz_attempts( $user_id, $quiz_id );
if ( ( ! empty( $quiz_attempts ) ) && ( is_array( $quiz_attempts ) ) ) {
return count( $quiz_attempts );
}
}
/**
* Gets the time spent by user on the quiz.
*
* Total of each started/complete time set.
*
* @since 2.3.0
*
* @param int $user_id The ID of the user to get quiz time spent.
* @param int $quiz_id The ID of the quiz to get time spent.
*
* @return int The total number of seconds spent on a quiz.
*/
function learndash_get_user_quiz_attempts_time_spent( $user_id, $quiz_id ) {
$total_time_spent = 0;
$attempts = learndash_get_user_quiz_attempts( $user_id, $quiz_id );
if ( ( ! empty( $attempts ) ) && ( is_array( $attempts ) ) ) {
foreach ( $attempts as $attempt ) {
$total_time_spent += ( $attempt->activity_completed - $attempt->activity_started );
}
}
return $total_time_spent;
}
/**
* Gets the user course attempts activity.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @since 2.3.0
*
* @param int $user_id Optional. The ID of the user to get course attempts. Default 0.
* @param int $course_id Optional. The ID of the course to get attempts. Default 0.
*
* @return array|void An array of activity IDs and timestamps or quizzes found.
*/
function learndash_get_user_course_attempts( $user_id = 0, $course_id = 0 ) {
global $wpdb;
if ( ( ! empty( $user_id ) ) || ( ! empty( $course_id ) ) ) {
return $wpdb->get_results(
$wpdb->prepare( 'SELECT activity_id, activity_started, activity_completed, activity_updated FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity' ) ) . ' WHERE user_id=%d AND post_id=%d and activity_type=%s ORDER BY activity_id, activity_started ASC', $user_id, $course_id, 'course' )
);
}
}
/**
* Gets the time spent by user in the course.
*
* Total of each started/complete time set.
*
* @since 2.3.0
*
* @param int $user_id Optional. The ID of the user to get course time spent. Default 0.
* @param int $course_id Optional. The ID of the course to get time spent. Default 0.
*
* @return int Total number of seconds spent.
*/
function learndash_get_user_course_attempts_time_spent( $user_id = 0, $course_id = 0 ) {
$total_time_spent = 0;
$attempts = learndash_get_user_course_attempts( $user_id, $course_id );
// We should only ever have one entry for a user+course_id. But still we are returned an array of objects.
if ( ( ! empty( $attempts ) ) && ( is_array( $attempts ) ) ) {
foreach ( $attempts as $attempt ) {
if ( ! empty( $attempt->activity_completed ) ) {
// If the Course is complete then we take the time as the completed - started times.
$total_time_spent += ( $attempt->activity_completed - $attempt->activity_started );
} else {
// But if the Course is not complete we calculate the time based on the updated timestamp
// This is updated on the course for each lesson, topic, quiz.
$total_time_spent += ( $attempt->activity_updated - $attempt->activity_started );
}
}
}
return $total_time_spent;
}
/**
* Gets the activity meta fields.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $activity_id Optional. The ID of the activity to get meta fields. Default 0.
* @param array $activity_meta_keys Optional. The array of meta field keys to get. Default empty array.
*
* @return array
*/
function learndash_get_activity_meta_fields( $activity_id = 0, $activity_meta_keys = array() ) {
global $wpdb;
$activity_meta = array();
if ( ! empty( $activity_id ) ) {
$activity_meta_raw = $wpdb->get_results(
$wpdb->prepare( 'SELECT activity_meta_key, activity_meta_value FROM ' . esc_sql( LDLMS_DB::get_table_name( 'user_activity_meta' ) ) . ' WHERE activity_id = %d', $activity_id )
);
// If we have some rows returned we want to restructure the meta to be proper key => value array pairs.
if ( ! empty( $activity_meta_raw ) ) {
foreach ( $activity_meta_raw as $activity_meta_item ) {
if ( ( empty( $activity_meta_keys ) ) || ( in_array( $activity_meta_item->activity_meta_key, $activity_meta_keys, true ) ) ) {
$activity_meta[ $activity_meta_item->activity_meta_key ] = $activity_meta_item->activity_meta_value;
}
}
}
}
return $activity_meta;
}
/**
* Calculate the human readable time spent on activity.
*
* @since 2.3.0
* @since 2.3.0.3 Use `human_time_diff` function for output.
*
* @param int $activity_started The start timestamp to compare. Default 0.
* @param int $activity_completed The completed timestamp to compare. Default 0.
* @param int $minimum_diff Optional. The minimum difference between started and completed time. Default 60.
*
* @return string The human readable time difference.
*/
function learndash_get_activity_human_time_diff( $activity_started = 0, $activity_completed = 0, $minimum_diff = 60 ) {
if ( empty( $activity_started ) ) {
return;
}
if ( empty( $activity_completed ) ) {
return;
}
$activity_diff = abs( $activity_completed - $activity_started );
if ( $activity_diff < $minimum_diff ) {
return;
}
return human_time_diff( $activity_started, $activity_completed );
}