/
actions.js
614 lines (561 loc) · 15.1 KB
/
actions.js
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
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import apiFetch from '@wordpress/api-fetch';
import { store as interfaceStore } from '@wordpress/interface';
import { store as preferencesStore } from '@wordpress/preferences';
import { speak } from '@wordpress/a11y';
import { store as noticesStore } from '@wordpress/notices';
import { store as blockEditorStore } from '@wordpress/block-editor';
import { store as editorStore } from '@wordpress/editor';
import deprecated from '@wordpress/deprecated';
import { addFilter } from '@wordpress/hooks';
/**
* Internal dependencies
*/
import { getMetaBoxContainer } from '../utils/meta-boxes';
import { store as editPostStore } from '.';
/**
* Returns an action object used in signalling that the user opened an editor sidebar.
*
* @param {?string} name Sidebar name to be opened.
*/
export const openGeneralSidebar =
( name ) =>
( { dispatch, registry } ) => {
const isDistractionFree = registry
.select( preferencesStore )
.get( 'core/edit-post', 'distractionFree' );
if ( isDistractionFree ) {
dispatch.toggleDistractionFree();
}
registry
.dispatch( interfaceStore )
.enableComplementaryArea( editPostStore.name, name );
};
/**
* Returns an action object signalling that the user closed the sidebar.
*/
export const closeGeneralSidebar =
() =>
( { registry } ) =>
registry
.dispatch( interfaceStore )
.disableComplementaryArea( editPostStore.name );
/**
* Returns an action object used in signalling that the user opened a modal.
*
* @deprecated since WP 6.3 use `core/interface` store's action with the same name instead.
*
*
* @param {string} name A string that uniquely identifies the modal.
*
* @return {Object} Action object.
*/
export const openModal =
( name ) =>
( { registry } ) => {
deprecated( "select( 'core/edit-post' ).openModal( name )", {
since: '6.3',
alternative: "select( 'core/interface').openModal( name )",
} );
return registry.dispatch( interfaceStore ).openModal( name );
};
/**
* Returns an action object signalling that the user closed a modal.
*
* @deprecated since WP 6.3 use `core/interface` store's action with the same name instead.
*
* @return {Object} Action object.
*/
export const closeModal =
() =>
( { registry } ) => {
deprecated( "select( 'core/edit-post' ).closeModal()", {
since: '6.3',
alternative: "select( 'core/interface').closeModal()",
} );
return registry.dispatch( interfaceStore ).closeModal();
};
/**
* Returns an action object used in signalling that the user opened the publish
* sidebar.
*
* @return {Object} Action object
*/
export function openPublishSidebar() {
return {
type: 'OPEN_PUBLISH_SIDEBAR',
};
}
/**
* Returns an action object used in signalling that the user closed the
* publish sidebar.
*
* @return {Object} Action object.
*/
export function closePublishSidebar() {
return {
type: 'CLOSE_PUBLISH_SIDEBAR',
};
}
/**
* Returns an action object used in signalling that the user toggles the publish sidebar.
*
* @return {Object} Action object
*/
export function togglePublishSidebar() {
return {
type: 'TOGGLE_PUBLISH_SIDEBAR',
};
}
/**
* Returns an action object used to enable or disable a panel in the editor.
*
* @deprecated
*
* @param {string} panelName A string that identifies the panel to enable or disable.
*
* @return {Object} Action object.
*/
export const toggleEditorPanelEnabled =
( panelName ) =>
( { registry } ) => {
deprecated( "dispatch( 'core/edit-post' ).toggleEditorPanelEnabled", {
since: '6.5',
alternative: "dispatch( 'core/editor').toggleEditorPanelEnabled",
} );
registry.dispatch( editorStore ).toggleEditorPanelEnabled( panelName );
};
/**
* Opens a closed panel and closes an open panel.
*
* @deprecated
*
* @param {string} panelName A string that identifies the panel to open or close.
*/
export const toggleEditorPanelOpened =
( panelName ) =>
( { registry } ) => {
deprecated( "dispatch( 'core/edit-post' ).toggleEditorPanelOpened", {
since: '6.5',
alternative: "dispatch( 'core/editor').toggleEditorPanelOpened",
} );
registry.dispatch( editorStore ).toggleEditorPanelOpened( panelName );
};
/**
* Returns an action object used to remove a panel from the editor.
*
* @deprecated
*
* @param {string} panelName A string that identifies the panel to remove.
*
* @return {Object} Action object.
*/
export const removeEditorPanel =
( panelName ) =>
( { registry } ) => {
deprecated( "dispatch( 'core/edit-post' ).removeEditorPanel", {
since: '6.5',
alternative: "dispatch( 'core/editor').removeEditorPanel",
} );
registry.dispatch( editorStore ).removeEditorPanel( panelName );
};
/**
* Triggers an action used to toggle a feature flag.
*
* @param {string} feature Feature name.
*/
export const toggleFeature =
( feature ) =>
( { registry } ) =>
registry
.dispatch( preferencesStore )
.toggle( 'core/edit-post', feature );
/**
* Triggers an action used to switch editor mode.
*
* @param {string} mode The editor mode.
*/
export const switchEditorMode =
( mode ) =>
( { dispatch, registry } ) => {
registry
.dispatch( preferencesStore )
.set( 'core/edit-post', 'editorMode', mode );
// Unselect blocks when we switch to the code editor.
if ( mode !== 'visual' ) {
registry.dispatch( blockEditorStore ).clearSelectedBlock();
}
if (
mode === 'text' &&
registry
.select( preferencesStore )
.get( 'core/edit-post', 'distractionFree' )
) {
dispatch.toggleDistractionFree();
}
const message =
mode === 'visual'
? __( 'Visual editor selected' )
: __( 'Code editor selected' );
speak( message, 'assertive' );
};
/**
* Triggers an action object used to toggle a plugin name flag.
*
* @param {string} pluginName Plugin name.
*/
export const togglePinnedPluginItem =
( pluginName ) =>
( { registry } ) => {
const isPinned = registry
.select( interfaceStore )
.isItemPinned( 'core/edit-post', pluginName );
registry
.dispatch( interfaceStore )
[ isPinned ? 'unpinItem' : 'pinItem' ](
'core/edit-post',
pluginName
);
};
/**
* Returns an action object used in signaling that a style should be auto-applied when a block is created.
*
* @param {string} blockName Name of the block.
* @param {?string} blockStyle Name of the style that should be auto applied. If undefined, the "auto apply" setting of the block is removed.
*/
export const updatePreferredStyleVariations =
( blockName, blockStyle ) =>
( { registry } ) => {
if ( ! blockName ) {
return;
}
const existingVariations =
registry
.select( preferencesStore )
.get( 'core/edit-post', 'preferredStyleVariations' ) ?? {};
// When the blockStyle is omitted, remove the block's preferred variation.
if ( ! blockStyle ) {
const updatedVariations = {
...existingVariations,
};
delete updatedVariations[ blockName ];
registry
.dispatch( preferencesStore )
.set(
'core/edit-post',
'preferredStyleVariations',
updatedVariations
);
} else {
// Else add the variation.
registry
.dispatch( preferencesStore )
.set( 'core/edit-post', 'preferredStyleVariations', {
...existingVariations,
[ blockName ]: blockStyle,
} );
}
};
/**
* Update the provided block types to be visible.
*
* @param {string[]} blockNames Names of block types to show.
*/
export const showBlockTypes =
( blockNames ) =>
( { registry } ) => {
const existingBlockNames =
registry
.select( preferencesStore )
.get( 'core/edit-post', 'hiddenBlockTypes' ) ?? [];
const newBlockNames = existingBlockNames.filter(
( type ) =>
! (
Array.isArray( blockNames ) ? blockNames : [ blockNames ]
).includes( type )
);
registry
.dispatch( preferencesStore )
.set( 'core/edit-post', 'hiddenBlockTypes', newBlockNames );
};
/**
* Update the provided block types to be hidden.
*
* @param {string[]} blockNames Names of block types to hide.
*/
export const hideBlockTypes =
( blockNames ) =>
( { registry } ) => {
const existingBlockNames =
registry
.select( preferencesStore )
.get( 'core/edit-post', 'hiddenBlockTypes' ) ?? [];
const mergedBlockNames = new Set( [
...existingBlockNames,
...( Array.isArray( blockNames ) ? blockNames : [ blockNames ] ),
] );
registry
.dispatch( preferencesStore )
.set( 'core/edit-post', 'hiddenBlockTypes', [
...mergedBlockNames,
] );
};
/**
* Stores info about which Meta boxes are available in which location.
*
* @param {Object} metaBoxesPerLocation Meta boxes per location.
*/
export function setAvailableMetaBoxesPerLocation( metaBoxesPerLocation ) {
return {
type: 'SET_META_BOXES_PER_LOCATIONS',
metaBoxesPerLocation,
};
}
/**
* Update a metabox.
*/
export const requestMetaBoxUpdates =
() =>
async ( { registry, select, dispatch } ) => {
dispatch( {
type: 'REQUEST_META_BOX_UPDATES',
} );
// Saves the wp_editor fields.
if ( window.tinyMCE ) {
window.tinyMCE.triggerSave();
}
// Additional data needed for backward compatibility.
// If we do not provide this data, the post will be overridden with the default values.
const post = registry.select( editorStore ).getCurrentPost();
const additionalData = [
post.comment_status
? [ 'comment_status', post.comment_status ]
: false,
post.ping_status ? [ 'ping_status', post.ping_status ] : false,
post.sticky ? [ 'sticky', post.sticky ] : false,
post.author ? [ 'post_author', post.author ] : false,
].filter( Boolean );
// We gather all the metaboxes locations data and the base form data.
const baseFormData = new window.FormData(
document.querySelector( '.metabox-base-form' )
);
const activeMetaBoxLocations = select.getActiveMetaBoxLocations();
const formDataToMerge = [
baseFormData,
...activeMetaBoxLocations.map(
( location ) =>
new window.FormData( getMetaBoxContainer( location ) )
),
];
// Merge all form data objects into a single one.
const formData = formDataToMerge.reduce( ( memo, currentFormData ) => {
for ( const [ key, value ] of currentFormData ) {
memo.append( key, value );
}
return memo;
}, new window.FormData() );
additionalData.forEach( ( [ key, value ] ) =>
formData.append( key, value )
);
try {
// Save the metaboxes.
await apiFetch( {
url: window._wpMetaBoxUrl,
method: 'POST',
body: formData,
parse: false,
} );
dispatch.metaBoxUpdatesSuccess();
} catch {
dispatch.metaBoxUpdatesFailure();
}
};
/**
* Returns an action object used to signal a successful meta box update.
*
* @return {Object} Action object.
*/
export function metaBoxUpdatesSuccess() {
return {
type: 'META_BOX_UPDATES_SUCCESS',
};
}
/**
* Returns an action object used to signal a failed meta box update.
*
* @return {Object} Action object.
*/
export function metaBoxUpdatesFailure() {
return {
type: 'META_BOX_UPDATES_FAILURE',
};
}
/**
* Action that changes the width of the editing canvas.
*
* @deprecated
*
* @param {string} deviceType
*/
export const __experimentalSetPreviewDeviceType =
( deviceType ) =>
( { registry } ) => {
deprecated(
"dispatch( 'core/edit-post' ).__experimentalSetPreviewDeviceType",
{
since: '6.5',
version: '6.7',
hint: 'registry.dispatch( editorStore ).setDeviceType',
}
);
registry.dispatch( editorStore ).setDeviceType( deviceType );
};
/**
* Returns an action object used to open/close the inserter.
*
* @deprecated
*
* @param {boolean|Object} value Whether the inserter should be opened (true) or closed (false).
*/
export const setIsInserterOpened =
( value ) =>
( { registry } ) => {
deprecated( "dispatch( 'core/edit-post' ).setIsInserterOpened", {
since: '6.5',
alternative: "dispatch( 'core/editor').setIsInserterOpened",
} );
registry.dispatch( editorStore ).setIsInserterOpened( value );
};
/**
* Returns an action object used to open/close the list view.
*
* @deprecated
*
* @param {boolean} isOpen A boolean representing whether the list view should be opened or closed.
*/
export const setIsListViewOpened =
( isOpen ) =>
( { registry } ) => {
deprecated( "dispatch( 'core/edit-post' ).setIsListViewOpened", {
since: '6.5',
alternative: "dispatch( 'core/editor').setIsListViewOpened",
} );
registry.dispatch( editorStore ).setIsListViewOpened( isOpen );
};
/**
* Returns an action object used to switch to template editing.
*
* @deprecated
*/
export function setIsEditingTemplate() {
deprecated( "dispatch( 'core/edit-post' ).setIsEditingTemplate", {
since: '6.5',
alternative: "dispatch( 'core/editor').setRenderingMode",
} );
return { type: 'NOTHING' };
}
/**
* Switches to the template mode.
*/
export const __unstableSwitchToTemplateMode =
() =>
( { registry } ) => {
registry.dispatch( editorStore ).setRenderingMode( 'template-only' );
};
/**
* Create a block based template.
*
* @deprecated
*/
export function __unstableCreateTemplate() {
deprecated( "dispatch( 'core/edit-post' ).__unstableCreateTemplate", {
since: '6.5',
} );
return { type: 'NOTHING' };
}
let metaBoxesInitialized = false;
/**
* Initializes WordPress `postboxes` script and the logic for saving meta boxes.
*/
export const initializeMetaBoxes =
() =>
( { registry, select, dispatch } ) => {
const isEditorReady = registry
.select( editorStore )
.__unstableIsEditorReady();
if ( ! isEditorReady ) {
return;
}
// Only initialize once.
if ( metaBoxesInitialized ) {
return;
}
const postType = registry.select( editorStore ).getCurrentPostType();
if ( window.postboxes.page !== postType ) {
window.postboxes.add_postbox_toggles( postType );
}
metaBoxesInitialized = true;
// Save metaboxes on save completion, except for autosaves.
addFilter(
'editor.__unstableSavePost',
'core/edit-post/save-metaboxes',
( previous, options ) =>
previous.then( () => {
if ( options.isAutosave ) {
return;
}
if ( ! select.hasMetaBoxes() ) {
return;
}
return dispatch.requestMetaBoxUpdates();
} )
);
dispatch( {
type: 'META_BOXES_INITIALIZED',
} );
};
/**
* Action that toggles Distraction free mode.
* Distraction free mode expects there are no sidebars, as due to the
* z-index values set, you can't close sidebars.
*/
export const toggleDistractionFree =
() =>
( { dispatch, registry } ) => {
const isDistractionFree = registry
.select( preferencesStore )
.get( 'core/edit-post', 'distractionFree' );
if ( ! isDistractionFree ) {
registry.batch( () => {
registry
.dispatch( preferencesStore )
.set( 'core', 'fixedToolbar', true );
registry.dispatch( editorStore ).setIsInserterOpened( false );
registry.dispatch( editorStore ).setIsListViewOpened( false );
dispatch.closeGeneralSidebar();
} );
}
registry.batch( () => {
registry
.dispatch( preferencesStore )
.set(
'core/edit-post',
'distractionFree',
! isDistractionFree
);
registry
.dispatch( noticesStore )
.createInfoNotice(
isDistractionFree
? __( 'Distraction free off.' )
: __( 'Distraction free on.' ),
{
id: 'core/edit-post/distraction-free-mode/notice',
type: 'snackbar',
}
);
} );
};