media.js
36.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
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
/**
* JavaScript for Media Library List and Grid Views, including
* taxonomy filtering and sorting.
*
* @since 1.0.0
*
* @package Media_Library_Organizer
* @author Media Library Organizer
*/
/**
* Define vars for holding:
* - Uploader instance
* - Grid View Taxonomy Filters
* - Grid View Order By Filter
* - Grid View Order Filter
* - Grid View Attachments Browser
*/
var mediaLibraryOrganizerUploader = false, // Uploader instance.
MediaLibraryOrganizerTaxonomyFilter = {}, // Grid View Taxonomy Dropdown Filters.
MediaLibraryOrganizerTaxonomyOrderBy, // Grid View Dropdown Order By Filter.
MediaLibraryOrganizerTaxonomyOrder, // Grid View Dropdown Order Filter.
MediaLibraryOrganizerAttachmentsBrowser; // Grid View Attachments Browser.
/**
* Grid View: Define Order By and Order Defaults on wp.media.query calls, which the Media Library
* uses for Grid Views.
*
* If the query specifies either orderby or order, that is honored.
* If the query is missing either orderby or order, the defaults are used.
*
* For Grid Views in the Edit Page/Post Screens (Classic Editor or Gutenberg), this also sets the correct Order By and Order dropdown values
* based on the User / Plugin Defaults.
*
* Whilst this sets the correct Attachment order at Media > Library in the Grid View, it doesn't set the correct Order By
* and Order doprdown values for the filters on that screen.
*
* @since 1.2.8
*/
function mediaLibraryOrganizerQueryInitialize() {
( function() {
wp.media.query = function( props ) {
return new wp.media.model.Attachments(
null,
{
props: _.extend(
_.defaults(
props || {},
{
orderby: media_library_organizer_media.defaults.orderby,
order: media_library_organizer_media.defaults.order
}
),
{ query: true }
)
}
);
};
/**
* Extend and override wp.media.model.Query to disable query caching, which prevents
* sparodic instances where 'No items found' appears when adding media within Gutenberg.
*/
var Query = wp.media.model.Query;
_.extend(
Query,
{
get: (function(){
/**
* Holds the queries.
*
* @type Array
*/
var queries = [];
/**
* Extend and override wp.media.model.Query to disable query caching, which prevents
* sparodic instances where 'No items found' appears when adding media within Gutenberg.
*
* @returns {Query}
*/
return function( props, options ) {
var args = {},
orderby = Query.orderby,
defaults = Query.defaultProps,
query,
cache = false; // Always disable query.
// Remove the `query` property. This isn't linked to a query,
// this *is* the query.
delete props.query;
delete props.cache;
// Fill default args.
_.defaults( props, defaults );
// Normalize the order.
props.order = props.order.toUpperCase();
if ( 'DESC' !== props.order && 'ASC' !== props.order ) {
props.order = defaults.order.toUpperCase();
}
// Ensure we have a valid orderby value.
if ( ! _.contains( orderby.allowed, props.orderby ) ) {
props.orderby = defaults.orderby;
}
_.each(
[ 'include', 'exclude' ],
function( prop ) {
if ( props[ prop ] && ! _.isArray( props[ prop ] ) ) {
props[ prop ] = [ props[ prop ] ];
}
}
);
// Generate the query `args` object.
// Correct any differing property names.
_.each(
props,
function( value, prop ) {
if ( _.isNull( value ) ) {
return;
}
args[ Query.propmap[ prop ] || prop ] = value;
}
);
// Fill any other default query args.
_.defaults( args, Query.defaultArgs );
// `props.orderby` does not always map directly to `args.orderby`.
// Substitute exceptions specified in orderby.keymap.
args.orderby = orderby.valuemap[ props.orderby ] || props.orderby;
// Disable query caching.
cache = false;
// Search the query cache for a matching query.
if ( cache ) {
query = _.find(
queries,
function( query ) {
return _.isEqual( query.args, args );
}
);
} else {
queries = [];
}
// Otherwise, create a new query and add it to the cache.
if ( ! query ) {
query = new Query(
[],
_.extend(
options || {},
{
props: props,
args: args
}
)
);
queries.push( query );
}
// Fire the grid:query event that Addons can hook into and listen.
wp.media.events.trigger(
'mlo:grid:query',
{
query: query
}
);
return query;
};
}())
}
);
} )( jQuery, _ );
}
/**
* Fetches the uploader instance, and fires events for the life cycle of an attachment being uploaded and deleted
*
* @since 1.2.3
*/
function mediaLibraryOrganizerUploaderInitializeEvents() {
( function( $, _ ) {
if ( typeof wp.Uploader !== 'undefined' ) {
_.extend(
wp.Uploader.prototype,
{
init: function() {
wp.media.events.trigger( 'mlo:grid:attachment:upload:init' );
},
added: function( file_attachment ) {
wp.media.events.trigger( 'mlo:grid:attachment:upload:added', file_attachment );
},
progress: function( file_attachment ) {
wp.media.events.trigger( 'mlo:grid:attachment:upload:progress', file_attachment );
},
success: function( file_attachment ) {
wp.media.events.trigger( 'mlo:grid:attachment:upload:success', file_attachment );
},
error: function( error_message ) {
wp.media.events.trigger( 'mlo:grid:attachment:upload:error', error_message );
},
complete: function() {
wp.media.events.trigger( 'mlo:grid:attachment:upload:complete' );
},
refresh: function() {
wp.media.events.trigger( 'mlo:grid:attachment:upload:refresh' );
}
}
);
}
} )( jQuery, _ );
}
/**
* Grid View: Initializes Taxonomy Filters
*
* @since 1.3.3
*/
function mediaLibraryOrganizerGridViewInitializeTaxonomyFilters() {
( function() {
for ( let taxonomy_name in media_library_organizer_media.taxonomies ) {
mediaLibraryOrganizerGridViewInitializeTaxonomyFilter(
taxonomy_name,
media_library_organizer_media.taxonomies[ taxonomy_name ].terms,
media_library_organizer_media.taxonomies[ taxonomy_name ].taxonomy.labels.all_items,
media_library_organizer_media.labels.unassigned,
media_library_organizer_media.show_attachment_count
);
}
} )( jQuery, _ );
}
/**
* Grid View: Initializes Taxonomy Filter for the given Taxonomy Name
*
* @since 1.3.3
*
* @param string taxonomy_name Taxonomy Name.
* @param array terms Taxonomy Terms.
* @param string all_items_label All Terms Label e.g. "All Media Categories", translated.
* @param string unassigned_items_label Unassigned Terms Label e.g. "Unassigned", translated.
* @param bool show_attachment_count Show Attachment Counts for each Term.
*/
function mediaLibraryOrganizerGridViewInitializeTaxonomyFilter( taxonomy_name, terms, all_items_label, unassigned_items_label, show_attachment_count ) {
( function() {
// Skip if this Filter isn't enabled in the Plugin Settings.
if ( media_library_organizer_media.settings[ taxonomy_name + '_enabled'] == '0' || ! media_library_organizer_media.settings[ taxonomy_name + '_enabled'] ) {
return;
}
// Define Taxonomy Filter.
MediaLibraryOrganizerTaxonomyFilter[ taxonomy_name ] = wp.media.view.AttachmentFilters.extend(
{
id: 'media-attachment-taxonomy-filter-' + taxonomy_name,
/**
* Create Filter
*
* @since 1.0.0
*/
createFilters: function() {
var filters = {};
// Build an array of filters based on the Terms supplied in media_library_organizer_media.terms,
// set by wp_localize_script().
_.each(
terms || {},
function( term, index ) {
var props = {};
props[ taxonomy_name ] = term.slug;
// Build label, depending on whether to include the Attachment count or not.
var label = term.name + ( show_attachment_count === '1' ? ' (' + term.count + ')' : '' );
filters[ index ] = {
text: label,
// Key = WP_Query taxonomy name, which ensures that taxonomy-name=1 is sent
// as part of the search query when the filter is used.
props: props
};
}
);
// Define the 'All' filter.
var props = {};
props[ taxonomy_name ] = '';
filters.all = {
text: all_items_label, // e.g. All Media Categories.
props: props,
priority: 10
};
// Define the 'Unassigned' filter.
var props = {};
props[ taxonomy_name ] = '-1';
filters.unassigned = {
text: unassigned_items_label, // e.g. Unassigned.
props: props,
priority: 10
};
// Set this filter's data to the terms we've just built.
this.filters = filters;
},
/**
* When the selected filter changes, update the Attachment Query properties to match.
*/
change: function() {
var filter = this.filters[ this.el.value ];
if ( filter ) {
this.model.set( filter.props );
// Fire the grid:filter event that Addons can hook into and listen.
wp.media.events.trigger(
'mlo:grid:filter:change:term',
{
taxonomy_name: taxonomy_name,
slug: filter.props[ taxonomy_name ]
}
);
}
},
/**
* Required for the Taxonomy selected option to be defined
* when taxonomy-name is in the $_REQUEST via e.g. Tree View
*/
select: function() {
var model = this.model,
value = 'all',
props = model.toJSON();
// Fire the grid:select event that Addons can hook into and listen.
wp.media.events.trigger(
'mlo:grid:filter:select',
{
props: props
}
);
_.find(
this.filters,
function( filter, id ) {
var equal = _.all(
filter.props,
function( prop, key ) {
return prop === ( _.isUndefined( props[ key ] ) ? null : props[ key ] );
}
);
if ( equal ) {
return value = id;
}
}
);
this.$el.val( value );
}
}
);
} )( jQuery, _ );
}
/**
* Grid View: Initializes Order By Filter
*
* @since 1.3.3
*/
function mediaLibraryOrganizerGridViewInitializeOrderByFilter() {
( function() {
if ( media_library_organizer_media.settings.orderby_enabled == 1 ) {
MediaLibraryOrganizerTaxonomyOrderBy = wp.media.view.AttachmentFilters.extend(
{
id: 'media-attachment-orderby',
/**
* Create Filters
*
* @since 1.0.0
*/
createFilters: function() {
var filters = {};
// Build an array of filters based on the Sorting options supplied in media_library_organizer_media.sorting,
// set by wp_localize_script().
_.each(
media_library_organizer_media.orderby || {},
function( value, key ) {
filters[ key ] = {
text: value,
// Key = WP_Query taxonomy name, which ensures that taxonomy-name=1 is sent
// as part of the search query when the filter is used.
props: {
'orderby': key,
}
};
}
);
// Set this filter's data to the terms we've just built.
this.filters = filters;
},
/**
* This has to be here for the filter dropdown to select the correct Order By
* and Order User / Default. wp.media.view.AttachmentFilters calls this.select
* from initialize, but doesn't seem to call its own select() function.
*/
select: function() {
var model = this.model,
value = 'all',
props = model.toJSON();
_.find(
this.filters,
function( filter, id ) {
var equal = _.all(
filter.props,
function( prop, key ) {
return prop === ( _.isUndefined( props[ key ] ) ? null : props[ key ] );
}
);
if ( equal ) {
return value = id;
}
}
);
this.$el.val( value );
}
}
);
}
} )( jQuery, _ );
}
/**
* Grid View: Initializes Order Filter
*
* @since 1.3.3
*/
function mediaLibraryOrganizerGridViewInitializeOrderFilter() {
( function() {
if ( media_library_organizer_media.settings.order_enabled == 1 ) {
MediaLibraryOrganizerTaxonomyOrder = wp.media.view.AttachmentFilters.extend(
{
id: 'media-attachment-order',
/**
* Create Filter
*
* @since 1.0.0
*/
createFilters: function() {
var filters = {};
// Build an array of filters based on the Sorting options supplied in media_library_organizer_media.sorting,
// set by wp_localize_script().
_.each(
media_library_organizer_media.order || {},
function( value, key ) {
filters[ key ] = {
text: value,
// Key = asc|desc.
props: {
'order': key,
}
};
}
);
// Set this filter's data to the terms we've just built.
this.filters = filters;
},
/**
* This has to be here for the filter dropdown to select the correct Order By
* and Order User / Default. wp.media.view.AttachmentFilters calls this.select
* from initialize, but doesn't seem to call its own select() function.
*/
select: function() {
var model = this.model,
value = 'all',
props = model.toJSON();
_.find(
this.filters,
function( filter, id ) {
var equal = _.all(
filter.props,
function( prop, key ) {
return prop === ( _.isUndefined( props[ key ] ) ? null : props[ key ] );
}
);
if ( equal ) {
return value = id;
}
}
);
this.$el.val( value );
}
}
);
}
} )( jQuery, _ );
}
/**
* Grid View: Adds Taxonomy, Order By and Order Filters to the Toolbar.
*
* @since 1.3.3
*/
function mediaLibraryOrganizerGridViewAddFiltersToToolbar() {
( function() {
var AttachmentsBrowser = wp.media.view.AttachmentsBrowser;
wp.media.view.AttachmentsBrowser = wp.media.view.AttachmentsBrowser.extend(
{
/**
* When the toolbar is created, add our custom filters to it, which
* are rendered as select dropdowns.
*
* @since 1.0.0
*/
createToolbar: function() {
// Make sure to load the original toolbar.
AttachmentsBrowser.prototype.createToolbar.call( this );
// Bail if search is not included in the toolbar, as this means we're on a grid view
// that doesn't display filters, such as Edit Gallery.
if ( ! this.options.search ) {
return;
}
// Define the priority order at which these filters should begin output in the Grid View Toolbar.
var priority = -75;
// Add the taxonomy filters to the toolbar.
// MediaLibraryOrganizerTaxonomyFilter is populated with Taxonomy Filters that are enabled in the Plugin Settings,
// so no need to check media_library_organizer_media.settings.
for ( let taxonomy_name in MediaLibraryOrganizerTaxonomyFilter ) {
this.toolbar.set(
taxonomy_name,
new MediaLibraryOrganizerTaxonomyFilter[ taxonomy_name ](
{
controller: this.controller,
model: this.collection.props,
priority: priority
}
).render()
);
// Increment priority so the order of filters remains the same
// if they're subsequently updated by calling mediaLibraryOrganizerGridViewInitializeTaxonomyFilter().
priority++;
}
// Add the orderby filter to the toolbar.
if ( media_library_organizer_media.settings.orderby_enabled == 1 ) {
this.toolbar.set(
'MediaLibraryOrganizerTaxonomyOrderBy',
new MediaLibraryOrganizerTaxonomyOrderBy(
{
controller: this.controller,
model: this.collection.props,
priority: priority
}
).render()
);
// Increment priority so the order of filters remains the same
// if they're subsequently updated by calling mediaLibraryOrganizerGridViewInitializeTaxonomyFilter().
priority++;
}
// Add the order filter to the toolbar.
if ( media_library_organizer_media.settings.order_enabled == 1 ) {
this.toolbar.set(
'MediaLibraryOrganizerTaxonomyOrder',
new MediaLibraryOrganizerTaxonomyOrder(
{
controller: this.controller,
model: this.collection.props,
priority: priority
}
).render()
);
// Increment priority so the order of filters remains the same
// if they're subsequently updated by calling mediaLibraryOrganizerGridViewInitializeTaxonomyFilter().
priority++;
}
// Fire the mlo:grid:filters:add event that Addons can hook into and add their own Filters now.
wp.media.events.trigger(
'mlo:grid:filters:add',
{
attachments_browser: this,
priority: priority
}
);
// Fire the mlo:grid:bulk_select:enabled event that Addons can hook into and listen
// when Bulk select is enabled by clicking the Bulk Select button.
this.controller.on(
'select:activate',
function() {
wp.media.events.trigger( 'mlo:grid:bulk_select:enabled' );
}
);
// Fire the mlo:grid:bulk_select:disabled event that Addons can hook into and listen
// when Bulk select is disabled by clicking the Cancel button.
this.controller.on(
'select:deactivate',
function() {
wp.media.events.trigger( 'mlo:grid:bulk_select:disabled' );
}
);
// Fire the mlo:grid:attachments:bulk_actions:done event that Addons can hook into and listen
// when a Bulk select action (e.g. Delete) completes.
this.controller.on(
'selection:action:done',
function() {
wp.media.events.trigger( 'mlo:grid:attachments:bulk_actions:done' );
}
);
// Store the toolbar in a var so we can interact with it later.
MediaLibraryOrganizerAttachmentsBrowser = this;
},
createAttachmentsHeading: function() {
// Make sure to load the original attachments heading. Check if we still need this function.
AttachmentsBrowser.prototype.createAttachmentsHeading.call( this );
},
/**
* Set attachment wrapper view top to match the height of the toolbar, so attachments
* are not cut off.
*/
createAttachmentsWrapperView: function() {
// Make sure to load the original attachments wrapper view.
AttachmentsBrowser.prototype.createAttachmentsWrapperView.call( this );
// Set wrapper offset on load.
setTimeout(
function() {
MediaLibraryOrganizerAttachmentsBrowser.attachmentsWrapper.el.style.top = ( MediaLibraryOrganizerAttachmentsBrowser.toolbar.el.clientHeight + 10 ) + 'px';
},
500
);
// Update wrapper offset on window resize.
window.onresize = function() {
MediaLibraryOrganizerAttachmentsBrowser.attachmentsWrapper.el.style.top = ( MediaLibraryOrganizerAttachmentsBrowser.toolbar.el.clientHeight + 10 ) + 'px';
}
},
}
);
} )( jQuery, _ );
}
/**
* Grid View: Initialize Edit Attachment Listeners
*
* @since 1.3.3
*/
function mediaLibraryOrganizerGridViewInitializeEditAttachmentListeners() {
( function( $, _ ) {
/**
* Grid View: Edit Attachment: Show Add New Taxonomy Form.
*/
$( 'body' ).on(
'click',
'table.compat-attachment-fields a.taxonomy-add-new',
function( e ) {
e.preventDefault();
mediaLibraryOrganizerEditAttachmentToggleTaxonomyTermForm( $( this ).data( 'taxonomy' ) );
}
);
/**
* Grid View: Edit Attachment: Add new Taxonomy Term.
*/
$( 'body' ).on(
'click',
'table.compat-attachment-fields div.mlo-taxonomy-term-add-fields input[type=button]',
function( e ) {
e.preventDefault();
mediaLibraryOrganizerEditAttachmentAddTerm(
$( this ).data( 'taxonomy' ),
$( 'input[type=text]', $( this ).parent() ).val()
);
}
);
/**
* Extend wp.media.view.AttachmentCompat to add an Event Listener to the initialize() function.
*
* @since 1.5.0
*/
_.extend(
wp.media.view.AttachmentCompat.prototype,
{
render: function() {
var compat = this.model.get( 'compat' );
if ( ! compat || ! compat.item ) {
return;
}
this.views.detach();
this.$el.html( compat.item );
this.views.render();
// Hacky; the view isn't yet loaded, so we have to wait.
// Frustratingly, trying to extend e.g. wp.media.view.MediaFrame.EditAttachments
// results in numerous JS errors.
var mediaLibraryOrganizerModel = this.model;
setTimeout(
function() {
wp.media.events.trigger(
'mlo:grid:edit-attachment:edit',
{
attachment_id: mediaLibraryOrganizerModel.id, // Attachment ID.
attachment: mediaLibraryOrganizerModel.attributes, // Attachment.
}
);
},
1000
);
return this;
},
}
);
/**
* Extend wp.media.view.Attachment to add an Event Listener to the save() function.
*
* @since 1.3.3
*/
var mediaLibraryOrganizerAttachmentStatus;
_.extend(
wp.media.view.Attachment.prototype,
{
/**
* Fire the mlo:grid:edit-attachment:edited event if the Attachment is saved.
*
* @since 1.3.3
*
* @param {string} status
* @return {wp.media.view.Attachment} Returns itself to allow chaining.
*/
updateSave: function( status ) {
var save = this._save = this._save || { status: 'ready' };
if ( status && status !== save.status ) {
this.$el.removeClass( 'save-' + save.status );
save.status = status;
}
this.$el.addClass( 'save-' + save.status );
// If the save status changed from waiting --> ready/complete, fire an event now
// We check this because this function will be called a lot with repetitive 'ready'
// statuses when an Attachment is first edited.
if ( mediaLibraryOrganizerAttachmentStatus == 'waiting' && ( save.status == 'ready' || save.status == 'complete' ) ) {
// Fire the mlo:grid:edit-attachment:edited event that Addons can hook into and listen.
wp.media.events.trigger(
'mlo:grid:edit-attachment:edited',
{
attachment_id: this.model.id, // Attachment ID.
attachment: this.model.attributes, // Attachment.
changed: this.model.changed, // Attachment Attributes Changed.
taxonomy_term_changed: ( typeof this.model.changed.compat !== 'undefined' ? true : false ), // 'compat' exists when Tax Terms are changed.
}
);
}
mediaLibraryOrganizerAttachmentStatus = save.status;
return this;
},
}
);
/**
* Extend wp.media.view.Attachment.Details to add an Event Listener to the moveFocus() function,
* which is called when an Attachment is Trashed or Deleted.
*
* @since 1.3.3
*/
_.extend(
wp.media.view.Attachment.Details.prototype,
{
moveFocus: function() {
// Fire the mlo:grid:edit-attachment:deleted event that Addons can hook into and listen.
wp.media.events.trigger( 'mlo:grid:edit-attachment:deleted' );
if ( this.previousAttachment.length ) {
this.previousAttachment.focus();
return;
}
if ( this.nextAttachment.length ) {
this.nextAttachment.focus();
return;
}
// Fallback: move focus to the "Select Files" button in the media modal.
if ( this.controller.uploader && this.controller.uploader.$browser ) {
this.controller.uploader.$browser.focus();
return;
}
// Last fallback.
this.moveFocusToLastFallback();
}
}
);
} )( jQuery, _ );
}
/**
* Grid View: Replace the given Taxonomy's Filter, if it exists.
*
* @since 1.3.3
*
* @param string taxonomy_name Taxonomy Name.
* @param array terms Taxonomy Terms.
* @param string all_items_label All Terms Label e.g. "All Media Categories", translated.
* @param string unassigned_items_label Unassigned Terms Label e.g. "Unassigned", translated.
* @param bool show_attachment_count Show Attachment Counts for each Term.
*/
function mediaLibraryOrganizerGridViewReplaceTaxonomyFilter( taxonomy_name, terms, all_items_label, unassigned_items_label, show_attachment_count ) {
( function( $ ) {
// Bail if the Taxonomy isn't enabled as a filter.
if ( ! MediaLibraryOrganizerTaxonomyFilter.hasOwnProperty( taxonomy_name ) ) {
return;
}
// Populate MediaLibraryOrganizerTaxonomyFilter[ taxonomy_name ] class with new Terms.
mediaLibraryOrganizerGridViewInitializeTaxonomyFilter( taxonomy_name, terms, all_items_label, unassigned_items_label, show_attachment_count );
// Render updated Filter in Toolbar.
MediaLibraryOrganizerAttachmentsBrowser.toolbar.set(
taxonomy_name,
new MediaLibraryOrganizerTaxonomyFilter[ taxonomy_name ](
{
controller: MediaLibraryOrganizerAttachmentsBrowser.controller,
model: MediaLibraryOrganizerAttachmentsBrowser.collection.props,
priority: -75
}
).render()
);
} )( jQuery );
}
/**
* Grid View: Replace all Taxonomy Filters by
* - fetching Taxonomies and their Terms via an AJAX call,
* - calling mediaLibraryOrganizerGridViewReplaceTaxonomyFilter() with the updated Term list
*
* @since 1.3.3
*
* @param string taxonomy_name Taxonomy Name.
*/
function mediaLibraryOrganizerGridViewUpdateTaxonomyFilters() {
( function( $ ) {
// Send request.
$.post(
media_library_organizer_media.ajaxurl,
{
'action': media_library_organizer_media.get_taxonomies_terms.action,
'nonce': media_library_organizer_media.get_taxonomies_terms.nonce
},
function( response ) {
// Bail if an error occured.
if ( ! response.success ) {
alert( response.data );
return;
}
// Replace all Taxonomy Filters.
for ( let taxonomy_name in response.data ) {
mediaLibraryOrganizerGridViewReplaceTaxonomyFilter(
response.data[ taxonomy_name ].taxonomy.name,
response.data[ taxonomy_name ].terms,
response.data[ taxonomy_name ].taxonomy.labels.all_items,
media_library_organizer_media.labels.unassigned
);
}
}
);
} )( jQuery );
}
/**
* Grid View: Replace the given Taxonomy's Filter by
* - fetching the list of Terms via an AJAX call,
* - calling mediaLibraryOrganizerGridViewReplaceTaxonomyFilter() with the updated Term list
*
* @since 1.3.3
*
* @param string taxonomy_name Taxonomy Name.
*/
function mediaLibraryOrganizerGridViewUpdateTaxonomyFilter( taxonomy_name ) {
( function( $ ) {
// Send request.
$.post(
media_library_organizer_media.ajaxurl,
{
'action': media_library_organizer_media.get_taxonomy_terms.action,
'nonce': media_library_organizer_media.get_taxonomy_terms.nonce,
'taxonomy_name': taxonomy_name
},
function( response ) {
// Bail if an error occured.
if ( ! response.success ) {
alert( response.data );
return;
}
// Replace Taxonomy Filter.
mediaLibraryOrganizerGridViewReplaceTaxonomyFilter(
response.data.taxonomy.name,
response.data.terms,
response.data.taxonomy.labels.all_items,
media_library_organizer_media.labels.unassigned
);
}
);
} )( jQuery );
}
/**
* List View: Replace the given Taxonomy's Filter with the supplied <select> HTML
*
* @since 1.3.3
*
* @param string taxonomy_name Taxonomy Name.
* @param string html <select> HTML.
* @param int selected_term Currently selected / viewed Taxonomy Term (if any).
*/
function mediaLibraryOrganizerListViewReplaceTaxonomyFilter( taxonomy_name, html, selected_term ) {
( function( $ ) {
// Replace <select> Taxonomy dropdown to reflect changes.
$( 'select#' + taxonomy_name ).replaceWith( html );
if ( selected_term.length > 0 ) {
$( 'select#' + taxonomy_name ).val( selected_term );
}
} )( jQuery );
}
/**
* List View: Update Attachment Terms for Attachments in the List.
*
* @since 1.3.3
*
* @param string taxonomy_name Taxonomy Name.
* @param WP_Term old_term Old Term (either the Term that was edited or deleted), WP_Term structure.
* @param WP_Term new_term New Term (either the New Term information after editing, or false if deleted.
*/
function mediaLibraryOrganizerListViewUpdateAttachmentTerms( taxonomy_name, old_term, new_term ) {
( function( $ ) {
$( 'td.taxonomy-' + taxonomy_name + ' a' ).each(
function() {
// If this Term matches the one just updated, update it in the DOM.
if ( $( this ).text() == old_term.name ) {
// If new_term is false, old_term was deleted, so remove it from this Attachment.
if ( ! new_term ) {
$( this ).remove();
} else {
$( this ).text( new_term.name );
$( this ).attr( 'href', 'upload.php?taxonomy=' + taxonomy_name + '&term=' + new_term.slug );
}
}
}
);
// Remove leading and trailing commas which may appear as a result of updating/removing a Term.
$( 'td.taxonomy-' + taxonomy_name ).each(
function() {
$( this ).html( $( this ).html().replace( /(^\s*,)|(,\s*$)/g, '' ) );
}
);
} )( jQuery );
}
/**
* Grid View: Taxonomy Term: Show or Hide the 'Add New' Form
*/
function mediaLibraryOrganizerEditAttachmentToggleTaxonomyTermForm( taxonomy_name ) {
( function( $ ) {
if ( $( '.mlo-taxonomy-term-add-fields.' + taxonomy_name ).hasClass( 'hidden' ) ) {
$( '.mlo-taxonomy-term-add-fields.' + taxonomy_name ).removeClass( 'hidden' );
} else {
$( '.mlo-taxonomy-term-add-fields.' + taxonomy_name ).addClass( 'hidden' );
}
} )( jQuery );
}
/**
* Grid View: Taxonomy Term: Clear the Taxonomy Term Form's value.
*/
function mediaLibraryOrganizerEditAttachmentResetTaxonomyTermForm( taxonomy_name ) {
( function( $ ) {
$( '.mlo-taxonomy-term-add-fields.' + taxonomy_name + 'input[type=text]' ).val( '' );
} )( jQuery );
}
/**
* Grid View: Edit Attachment: Add Term.
*/
function mediaLibraryOrganizerEditAttachmentAddTerm( taxonomy_name, term_name, parent_term_id ) {
( function( $ ) {
// Build args.
var args = {
'action': media_library_organizer_media.create_term.action,
'nonce': media_library_organizer_media.create_term.nonce,
'taxonomy_name': taxonomy_name,
'term_name': term_name,
'term_parent_id': parent_term_id
};
// Send request.
$.post(
media_library_organizer_media.ajaxurl,
args,
function( response ) {
// Bail if an error occured.
if ( ! response.success ) {
alert( response.data );
return;
}
// Fire the mlo:grid:edit-attachmentadded:term event that Addons can hook into and listen.
wp.media.events.trigger( 'mlo:grid:edit-attachment:added:term', response.data );
// Add the Term to the list of Terms.
$( 'ul#' + response.data.term.taxonomy + 'checklist' ).prepend( response.data.checkbox );
// Reset the form.
mediaLibraryOrganizerEditAttachmentResetTaxonomyTermForm( taxonomy_name );
// Trigger a save of the Attachment, so the Attachment is assigned to the newly created Term that's checked.
$( 'ul#' + response.data.term.taxonomy + 'checklist li:first input[type="checkbox"]' ).trigger( 'change' );
}
);
} )( jQuery );
}
/**
* Refreshes the grid view to show an up to date version, based on
* any additions, changes or deletions of Attachments.
*
* @since 1.4.0
*/
function mediaLibraryOrganizerGridViewRefresh() {
if ( typeof wp.media.frame.library !== 'undefined' ) {
wp.media.frame.library.props.set( {ignore: (+ new Date())} );
} else {
wp.media.frame.content.get().collection.props.set( {ignore: (+ new Date())} );
}
}
/**
* Update multipart_params when the uploader is first initialized.
*
* @since 1.2.3
*/
wp.media.events.on(
'mlo:grid:attachment:upload:init',
function() {
// Fetch wp.media.frame.uploader, so we persist it when the user switches
// between grid view and inline editing in grid view.
if ( ! mediaLibraryOrganizerUploader && typeof wp.media.frame.uploader !== 'undefined' ) {
mediaLibraryOrganizerUploader = wp.media.frame.uploader;
}
if ( mediaLibraryOrganizerUploader && typeof mediaLibraryOrganizerUploader.uploader !== 'undefined' ) {
var selected_terms = {};
for ( let taxonomy_name in media_library_organizer_media.taxonomies ) {
selected_terms[ taxonomy_name ] = media_library_organizer_media.taxonomies[ taxonomy_name ].selected_term;
}
mediaLibraryOrganizerUploader.uploader.uploader.settings.multipart_params.media_library_organizer = selected_terms;
}
}
);
/**
* Update multipart_params when a Taxonomy filter is changed,
* so that any files uploaded will be assigned to the Taxonomy Term
* chosen in the Taxonomy filter.
*
* @since 1.2.3
*
* @param obj atts Attributes.
*/
wp.media.events.on(
'mlo:grid:filter:change:term',
function( atts ) {
if ( mediaLibraryOrganizerUploader && typeof mediaLibraryOrganizerUploader.uploader !== 'undefined' ) {
mediaLibraryOrganizerUploader.uploader.uploader.settings.multipart_params.media_library_organizer[ atts.taxonomy_name ] = atts.slug;
}
}
);
/**
* Grid View: When an attachment completes successful upload to the Grid View, refresh the Grid View.
*
* @since 1.2.3
*
* @param obj attachment Uploaded Attachment.
*/
wp.media.events.on(
'mlo:grid:attachment:upload:success',
function( attachment ) {
mediaLibraryOrganizerGridViewRefresh();
}
);
/**
* Grid View: When an attachment is edited in the Grid View, and has a Taxonomy Term added to it using the
* inline 'Add New' option, reload the Taxonomy Filter.
*
* @since 1.3.3
*
* @param obj atts Attributes.
*/
wp.media.events.on(
'mlo:grid:edit-attachment:added:term',
function( atts ) {
// Replace Taxonomy Filter to reflect changes.
mediaLibraryOrganizerGridViewReplaceTaxonomyFilter(
atts.taxonomy.name,
atts.terms,
atts.taxonomy.labels.all_items,
media_library_organizer_media.labels.unassigned
);
}
);
/**
* Grid View: When Taxonomy Term(s) are assigned or unassigned to an Attachment in the Grid View:
* - reload the Taxonomy Filter for the Taxonomy where changes were made
* - reload the underlying Grid View, so that if viewing by Taxonomy Term and the Attachment
* was removed from said Taxonomy Term, this is reflected in the grid
*
* @since 1.3.3
*
* @param obj atts Attributes.
*/
wp.media.events.on(
'mlo:grid:edit-attachment:edited',
function( atts ) {
( function( $ ) {
// Bail if no Taxonomy Terms were changed in the Attachment.
if ( ! atts.taxonomy_term_changed ) {
return;
}
// Update Taxonomy Filters.
mediaLibraryOrganizerGridViewUpdateTaxonomyFilters();
// Refresh Grid View.
mediaLibraryOrganizerGridViewRefresh();
} )( jQuery );
}
);
/**
* Grid View: When an attachment is deleted in the Grid View > Edit Attachment modal,
* reload all Taxonomy Filters so their Term Counts are updated.
*
* @since 1.3.3
*
* @param obj atts Attributes.
*/
wp.media.events.on(
'mlo:grid:edit-attachment:deleted',
function( atts ) {
mediaLibraryOrganizerGridViewUpdateTaxonomyFilters();
}
);
/**
* Grid View: When Bulk select is disabled i.e. either Deletion completed or the user clicked Cancel,
* reload all Taxonomy Filters so their Term Counts are updated.
*
* We don't do this on mlo:grid:attachments:bulk_actions:done, as we might still be in Bulk select mode,
* therefore reloading the Taxonomy Filters isn't necessary as they're not being displayed.
*
* @since 1.3.3.
*/
wp.media.events.on(
'mlo:grid:bulk_select:disabled',
function() {
mediaLibraryOrganizerGridViewUpdateTaxonomyFilters();
}
);
/**
* Main function to call initialization functions in this
* file, covering
* - Registering various wp.media.events that can be listened to by this Plugin and Addons
* - Registering Taxonomy, Order by and Order Filters
* - Adding Filters to the Toolbar
* - wp.media.query fixes
*/
function mediaLibraryOrganizerInitialize() {
// Initialize Order By and Order Defaults on wp.media.query calls.
mediaLibraryOrganizerQueryInitialize();
// Initialize Uploader Instance Events.
mediaLibraryOrganizerUploaderInitializeEvents();
// Initialize Grid View Taxonomy Filters.
mediaLibraryOrganizerGridViewInitializeTaxonomyFilters();
// Initialize Grid View Order By Filter.
mediaLibraryOrganizerGridViewInitializeOrderByFilter();
// Initialize Grid View Order Filter.
mediaLibraryOrganizerGridViewInitializeOrderFilter();
// Add Grid View Filters to Toolbar.
mediaLibraryOrganizerGridViewAddFiltersToToolbar();
// Initialize Grid View Edit Attachment Listeners.
mediaLibraryOrganizerGridViewInitializeEditAttachmentListeners();
// Initialize List View Selectize.
jQuery( document ).ready(
function( $ ) {
if ( typeof mediaLibraryOrganizerSelectizeInit !== 'undefined' ) {
mediaLibraryOrganizerSelectizeInit();
}
}
);
}
// Finally, initialize Media Library Organizer.
mediaLibraryOrganizerInitialize();