blocks.php
44.4 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
<?php
/**
* The ACF Blocks PHP code.
*
* @package ACF
*/
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
// Register store.
acf_register_store( 'block-types' );
acf_register_store( 'block-cache' );
acf_register_store( 'block-meta-values' );
// Register block.json support handlers.
add_filter( 'block_type_metadata', 'acf_add_block_namespace' );
add_filter( 'block_type_metadata_settings', 'acf_handle_json_block_registration', 99, 2 );
add_action( 'acf_block_render_template', 'acf_block_render_template', 10, 6 );
/**
* Prefix block names for ACF blocks registered through block.json
*
* @since 6.0.0
*
* @param array $metadata The block metadata array.
* @return array The original array with a prefixed block name if it's an ACF block.
*/
function acf_add_block_namespace( $metadata ) {
if ( acf_is_acf_block_json( $metadata ) ) {
// If the block doesn't already have a namespace, append ACF's.
if ( strpos( $metadata['name'], '/' ) === false ) {
$metadata['name'] = 'acf/' . acf_slugify( $metadata['name'] );
}
}
return $metadata;
}
/**
* Handle an ACF block registered through block.json
*
* @since 6.0.0
*
* @param array $settings The compiled block settings.
* @param array $metadata The raw json metadata.
*
* @return array Block registration settings with ACF required additions.
*/
function acf_handle_json_block_registration( $settings, $metadata ) {
if ( ! acf_is_acf_block_json( $metadata ) ) {
return $settings;
}
// Setup ACF defaults.
$settings = wp_parse_args(
$settings,
array(
'render_template' => false,
'render_callback' => false,
'enqueue_style' => false,
'enqueue_script' => false,
'enqueue_assets' => false,
'post_types' => array(),
'uses_context' => array(),
'supports' => array(),
'attributes' => array(),
'acf_block_version' => 2,
'api_version' => 2,
'validate' => true,
'validate_on_load' => true,
'use_post_meta' => false,
)
);
// Add user provided attributes to ACF's required defaults.
$settings['attributes'] = wp_parse_args(
acf_get_block_type_default_attributes( $metadata ),
$settings['attributes']
);
// Add default ACF 'supports' settings.
$settings['supports'] = wp_parse_args(
$settings['supports'],
array(
'align' => true,
'html' => false,
'mode' => true,
'jsx' => true,
'multiple' => true,
)
);
// Add default ACF 'uses_context' settings.
$settings['uses_context'] = array_values(
array_unique(
array_merge(
$settings['uses_context'],
array(
'postId',
'postType',
)
)
)
);
// Map custom ACF properties from the ACF key, with localization.
$property_mappings = array(
'renderCallback' => 'render_callback',
'renderTemplate' => 'render_template',
'mode' => 'mode',
'blockVersion' => 'acf_block_version',
'postTypes' => 'post_types',
'validate' => 'validate',
'validateOnLoad' => 'validate_on_load',
'usePostMeta' => 'use_post_meta',
);
$textdomain = ! empty( $metadata['textdomain'] ) ? $metadata['textdomain'] : 'acf';
$i18n_schema = get_block_metadata_i18n_schema();
foreach ( $property_mappings as $key => $mapped_key ) {
if ( isset( $metadata['acf'][ $key ] ) ) {
unset( $settings[ $key ] );
$settings[ $mapped_key ] = $metadata['acf'][ $key ];
if ( $textdomain && isset( $i18n_schema->$key ) ) {
$settings[ $mapped_key ] = translate_settings_using_i18n_schema( $i18n_schema->$key, $settings[ $key ], $textdomain );
}
}
}
// Add the block name and registration path to settings.
$settings['name'] = $metadata['name'];
$settings['path'] = dirname( $metadata['file'] );
// Prevent blocks that usePostMeta from being nested or saving multiple.
if ( ! empty( $settings['use_post_meta'] ) ) {
$settings['parent'] = array( 'core/post-content' );
$settings['supports']['multiple'] = false;
}
acf_get_store( 'block-types' )->set( $metadata['name'], $settings );
add_action( 'enqueue_block_editor_assets', 'acf_enqueue_block_assets' );
// Ensure our render callback is used.
$settings['render_callback'] = 'acf_render_block_callback';
return $settings;
}
/**
* Check if a block.json block is an ACF block.
*
* @since 6.0.0
*
* @param array $metadata The raw block metadata array.
* @return boolean
*/
function acf_is_acf_block_json( $metadata ) {
return ( isset( $metadata['acf'] ) && $metadata['acf'] );
}
/**
* Registers a block type.
*
* @date 18/2/19
* @since 5.8.0
*
* @param array $block The block settings.
* @return (array|false)
*/
function acf_register_block_type( $block ) {
// Validate block type settings.
$block = acf_validate_block_type( $block );
/**
* Filters the arguments for registering a block type.
*
* @since 5.8.9
*
* @param array $block The array of arguments for registering a block type.
*/
$block = apply_filters( 'acf/register_block_type_args', $block );
// Require name.
if ( ! $block['name'] ) {
$message = __( 'Block type name is required.', 'acf' );
_doing_it_wrong( __FUNCTION__, $message, '5.8.0' ); //phpcs:ignore -- escape not required.
return false;
}
// Bail early if already exists.
if ( acf_has_block_type( $block['name'] ) ) {
/* translators: The name of the block type */
$message = sprintf( __( 'Block type "%s" is already registered.', 'acf' ), $block['name'] );
_doing_it_wrong( __FUNCTION__, $message, '5.8.0' ); //phpcs:ignore -- escape not required.
return false;
}
// Set ACF required attributes.
$block['attributes'] = acf_get_block_type_default_attributes( $block );
if ( ! isset( $block['api_version'] ) ) {
$block['api_version'] = 2;
}
if ( ! isset( $block['acf_block_version'] ) ) {
$block['acf_block_version'] = 1;
}
// Add to storage.
acf_get_store( 'block-types' )->set( $block['name'], $block );
// Overwrite callback for WordPress registration.
$block['render_callback'] = 'acf_render_block_callback';
// Register block type in WP.
if ( function_exists( 'register_block_type' ) ) {
register_block_type(
$block['name'],
$block
);
}
// Register action.
add_action( 'enqueue_block_editor_assets', 'acf_enqueue_block_assets' );
// Return block.
return $block;
}
/**
* See acf_register_block_type().
*
* @date 18/2/19
* @since 5.7.12
*
* @param array $block The block settings.
* @return (array|false)
*/
function acf_register_block( $block ) {
return acf_register_block_type( $block );
}
/**
* Returns true if a block type exists for the given name.
*
* @since 5.7.12
*
* @param string $name The block type name.
* @return boolean
*/
function acf_has_block_type( $name ) {
return acf_get_store( 'block-types' )->has( $name );
}
/**
* Returns an array of all registered block types.
*
* @since 5.7.12
*
* @return array
*/
function acf_get_block_types() {
return acf_get_store( 'block-types' )->get();
}
/**
* Returns a block type for the given name.
*
* @since 5.7.12
*
* @param string $name The block type name.
* @return (array|null)
*/
function acf_get_block_type( $name ) {
return acf_get_store( 'block-types' )->get( $name );
}
/**
* Removes a block type for the given name.
*
* @since 5.7.12
*
* @param string $name The block type name.
* @return void
*/
function acf_remove_block_type( $name ) {
acf_get_store( 'block-types' )->remove( $name );
}
/**
* Returns an array of default attribute settings for a block type.
*
* @date 19/11/18
* @since 5.8.0
*
* @param array $block_type A block configuration array.
* @return array
*/
function acf_get_block_type_default_attributes( $block_type ) {
$attributes = array(
'name' => array(
'type' => 'string',
'default' => '',
),
'data' => array(
'type' => 'object',
'default' => array(),
),
'align' => array(
'type' => 'string',
'default' => '',
),
'mode' => array(
'type' => 'string',
'default' => '',
),
);
foreach ( acf_get_block_back_compat_attribute_key_array() as $new => $old ) {
if ( isset( $block_type['supports'][ $old ] ) ) {
$block_type['supports'][ $new ] = $block_type['supports'][ $old ];
unset( $block_type['supports'][ $old ] );
}
}
if ( ! empty( $block_type['supports']['alignText'] ) ) {
$attributes['alignText'] = array(
'type' => 'string',
'default' => '',
);
}
if ( ! empty( $block_type['supports']['alignContent'] ) ) {
$attributes['alignContent'] = array(
'type' => 'string',
'default' => '',
);
}
if ( ! empty( $block_type['supports']['fullHeight'] ) ) {
$attributes['fullHeight'] = array(
'type' => 'boolean',
'default' => '',
);
}
// For each of ACF's block attributes, check if the user's block attributes contains a default value we should use.
if ( isset( $block_type['attributes'] ) && is_array( $block_type['attributes'] ) ) {
foreach ( array_keys( $attributes ) as $key ) {
if ( isset( $block_type['attributes'][ $key ] ) && is_array( $block_type['attributes'][ $key ] ) && isset( $block_type['attributes'][ $key ]['default'] ) ) {
$attributes[ $key ]['default'] = $block_type['attributes'][ $key ]['default'];
}
}
}
return $attributes;
}
/**
* Validates a block type ensuring all settings exist.
*
* @since 5.8.0
*
* @param array $block The block settings.
* @return array
*/
function acf_validate_block_type( $block ) {
// Add default settings.
$block = wp_parse_args(
$block,
array(
'name' => '',
'title' => '',
'description' => '',
'category' => 'common',
'icon' => '',
'mode' => 'preview',
'keywords' => array(),
'supports' => array(),
'post_types' => array(),
'uses_context' => array(),
'render_template' => false,
'render_callback' => false,
'enqueue_style' => false,
'enqueue_script' => false,
'enqueue_assets' => false,
)
);
// Generate name with prefix.
if ( $block['name'] ) {
$block['name'] = 'acf/' . acf_slugify( $block['name'] );
}
// Add default 'supports' settings.
$block['supports'] = wp_parse_args(
$block['supports'],
array(
'align' => true,
'html' => false,
'mode' => true,
)
);
// Add default 'uses_context' settings.
$block['uses_context'] = wp_parse_args(
$block['uses_context'],
array(
'postId',
'postType',
)
);
// Correct "Experimental" flags.
if ( isset( $block['supports']['__experimental_jsx'] ) ) {
$block['supports']['jsx'] = $block['supports']['__experimental_jsx'];
}
// Return block.
return $block;
}
/**
* Prepares a block for use in render_callback by merging in all settings and attributes.
*
* @since 5.8.0
*
* @param array $block The block props.
* @return array|boolean
*/
function acf_prepare_block( $block ) {
// Bail early if no name.
if ( ! isset( $block['name'] ) ) {
return false;
}
// Ensure a block ID is always prefixed with `block_` for meta.
$block['id'] = acf_ensure_block_id_prefix( $block['id'] );
// Get block type and return false if doesn't exist.
$block_type = acf_get_block_type( $block['name'] );
if ( ! $block_type ) {
return false;
}
// Prevent protected attributes being overridden.
$protected = array(
'render_template',
'render_callback',
'enqueue_script',
'enqueue_style',
'enqueue_assets',
'post_types',
'use_post_meta',
);
$block = array_diff_key( $block, array_flip( $protected ) );
// Generate default attributes.
$attributes = array();
foreach ( acf_get_block_type_default_attributes( $block_type ) as $k => $v ) {
$attributes[ $k ] = $v['default'];
}
// Merge together arrays in order of least to most specific.
$block = array_merge( $block_type, $attributes, $block );
// Add backward compatibility attributes.
$block = acf_add_back_compat_attributes( $block );
// Return block.
return $block;
}
/**
* Add backwards compatible attribute values.
*
* @since 6.0.0
*
* @param array $block The original block.
* @return array Modified block array with backwards compatibility attributes.
*/
function acf_add_back_compat_attributes( $block ) {
foreach ( acf_get_block_back_compat_attribute_key_array() as $new => $old ) {
if ( ! empty( $block[ $new ] ) || ( isset( $block[ $new ] ) && ! isset( $block[ $old ] ) ) ) {
$block[ $old ] = $block[ $new ];
}
}
return $block;
}
/**
* Get back compat new values and old values.
*
* @since 6.0.0
*
* @return array back compat key array.
*/
function acf_get_block_back_compat_attribute_key_array() {
return array(
'fullHeight' => 'full_height',
'alignText' => 'align_text',
'alignContent' => 'align_content',
);
}
/**
* The render callback for all ACF blocks.
*
* @date 28/10/20
* @since 5.9.2
*
* @param array $attributes The block attributes.
* @param string $content The block content.
* @param WP_Block $wp_block The block instance (since WP 5.5).
* @return string The block HTML.
*/
function acf_render_block_callback( $attributes, $content = '', $wp_block = null ) {
$is_preview = false;
$post_id = get_the_ID();
// Set preview flag to true when rendering for the block editor.
if ( is_admin() && acf_is_block_editor() ) {
$is_preview = true;
}
// If ACF's block save method hasn't been called yet, try to initialize a default block.
if ( empty( $attributes['name'] ) && ! empty( $wp_block->name ) ) {
$attributes['name'] = $wp_block->name;
}
// Return rendered block HTML.
return acf_rendered_block( $attributes, $content, $is_preview, $post_id, $wp_block );
}
/**
* Returns the rendered block HTML.
*
* @date 28/2/19
* @since 5.7.13
*
* @param array $attributes The block attributes.
* @param string $content The block content.
* @param boolean $is_preview Whether or not the block is being rendered for editing preview.
* @param integer $post_id The current post being edited or viewed.
* @param WP_Block $wp_block The block instance (since WP 5.5).
* @param array $context The block context array.
* @param boolean $is_ajax_render Whether or not this is an ACF AJAX render.
* @return string The block HTML.
*/
function acf_rendered_block( $attributes, $content = '', $is_preview = false, $post_id = 0, $wp_block = null, $context = false, $is_ajax_render = false ) {
$mode = isset( $attributes['mode'] ) ? $attributes['mode'] : 'auto';
$form = ( 'edit' === $mode && $is_preview );
// If context is available from the WP_Block class object and we have no context of our own, use that.
if ( empty( $context ) && ! empty( $wp_block->context ) ) {
$context = $wp_block->context;
}
// Check if we need to generate a block ID.
$force_new_id = false;
if ( acf_block_uses_post_meta( $attributes ) && ! empty( $attributes['id'] ) && empty( $attributes['data'] ) ) {
$force_new_id = true;
}
$attributes['id'] = acf_get_block_id( $attributes, $context, $force_new_id );
// Check if we've already got a cache of this block ID and return it to save rendering if we're in the backend.
if ( $is_preview ) {
$cached_block = acf_get_store( 'block-cache' )->get( $attributes['id'] );
if ( $cached_block ) {
if ( $form ) {
if ( $cached_block['form'] ) {
return $cached_block['html'];
}
} elseif ( ! $cached_block['form'] ) {
return $cached_block['html'];
}
}
}
ob_start();
$validation = false;
if ( $form ) {
// Load the block form since we're in edit mode.
// Set flag for post REST cleanup of media enqueue count during preloads.
acf_set_data( 'acf_did_render_block_form', true );
$block = acf_prepare_block( $attributes );
$block = acf_add_block_meta_values( $block, $post_id );
acf_setup_meta( $block['data'], $block['id'], true );
if ( ! empty( $block['validate'] ) ) {
$validation = acf_get_block_validation_state( $block, false, false, true );
}
$fields = acf_get_block_fields( $block );
if ( $fields ) {
acf_prefix_fields( $fields, "acf-{$block['id']}" );
echo '<div class="acf-block-fields acf-fields" data-block-id="' . esc_attr( $block['id'] ) . '">';
acf_render_fields( $fields, acf_ensure_block_id_prefix( $block['id'] ), 'div', 'field' );
echo '</div>';
} else {
echo acf_get_empty_block_form_html( $attributes['name'] ); //phpcs:ignore -- escaped in function.
}
} else {
// Capture block render output.
acf_render_block( $attributes, $content, $is_preview, $post_id, $wp_block, $context );
if ( $is_preview && ! $is_ajax_render ) {
/**
* If we're in preloaded preview, we need to get the validation state for a preview too.
* Because the block render resets meta once it's finished to not pollute $post_id, we need to redo that process here.
*/
$block = acf_prepare_block( $attributes );
$block = acf_add_block_meta_values( $block, $post_id );
acf_setup_meta( $block['data'], $block['id'], true );
if ( ! empty( $block['validate'] ) ) {
$validation = acf_get_block_validation_state( $block, false, false, true );
}
}
}
$html = ob_get_clean();
$html = is_string( $html ) ? $html : '';
// Replace <InnerBlocks /> placeholder on front-end, or if we're rendering an ACF block inside another ACF block template.
if ( ! $is_preview || doing_action( 'acf_block_render_template' ) ) {
// Escape "$" character to avoid "capture group" interpretation.
$content = str_replace( '$', '\$', $content );
// Wrap content in our acf-inner-container wrapper if necessary.
if ( $wp_block && $wp_block->block_type->acf_block_version > 1 && apply_filters( 'acf/blocks/wrap_frontend_innerblocks', true, $attributes['name'] ) ) {
// Check for a class (or className) provided in the template to become the InnerBlocks wrapper class.
$matches = array();
if ( preg_match( '/<InnerBlocks(?:[^<]+?)(?:class|className)=(?:["\']\W+\s*(?:\w+)\()?["\']([^\'"]+)[\'"]/', $html, $matches ) ) {
$class = isset( $matches[1] ) ? $matches[1] : 'acf-innerblocks-container';
} else {
$class = 'acf-innerblocks-container';
}
$content = '<div class="' . $class . '">' . $content . '</div>';
}
$html = preg_replace( '/<InnerBlocks([\S\s]*?)\/>/', $content, $html );
}
$block_cache = array(
'form' => $form,
'html' => $html,
);
if ( $is_preview && $validation ) {
// If we're in the preview, also store the validation status in the block cache.
$block_cache['validation'] = $validation;
}
// Store in cache for preloading if we're in the backend.
acf_get_store( 'block-cache' )->set(
$attributes['id'],
$block_cache
);
// Prevent edit forms being output to rest endpoints.
if ( $form && acf_get_data( 'acf_inside_rest_call' ) && apply_filters( 'acf/blocks/prevent_edit_forms_on_rest_endpoints', true ) ) {
return '';
}
return $html;
}
/**
* Renders the block HTML.
*
* @since 5.7.12
*
* @param array $attributes The block attributes.
* @param string $content The block content.
* @param boolean $is_preview Whether or not the block is being rendered for editing preview.
* @param integer $post_id The current post being edited or viewed.
* @param WP_Block $wp_block The block instance (since WP 5.5).
* @param array $context The block context array.
* @return void|string
*/
function acf_render_block( $attributes, $content = '', $is_preview = false, $post_id = 0, $wp_block = null, $context = false ) {
// Prepare block ensuring all settings and attributes exist.
$block = acf_prepare_block( $attributes );
if ( ! $block ) {
return '';
}
// Find post_id if not defined.
if ( ! $post_id ) {
$post_id = get_the_ID();
}
// Enqueue block type assets.
acf_enqueue_block_type_assets( $block );
$block = acf_add_block_meta_values( $block, $post_id );
// Setup postdata allowing get_field() to work.
acf_setup_meta( $block['data'], $block['id'], true );
// Call render_callback.
if ( is_callable( $block['render_callback'] ) ) {
call_user_func( $block['render_callback'], $block, $content, $is_preview, $post_id, $wp_block, $context );
// Or include template.
} elseif ( $block['render_template'] ) {
do_action( 'acf_block_render_template', $block, $content, $is_preview, $post_id, $wp_block, $context );
}
// Reset postdata.
acf_reset_meta( $block['id'] );
}
/**
* Locate and include an ACF block's template.
*
* @since 6.0.4
*
* @param array $block The block props.
*/
function acf_block_render_template( $block, $content, $is_preview, $post_id, $wp_block, $context ) {
// Locate template.
if ( isset( $block['path'] ) && file_exists( $block['path'] . '/' . $block['render_template'] ) ) {
$path = $block['path'] . '/' . $block['render_template'];
} elseif ( file_exists( $block['render_template'] ) ) {
$path = $block['render_template'];
} else {
$path = locate_template( $block['render_template'] );
}
// Include template.
if ( file_exists( $path ) ) {
include $path;
} elseif ( $is_preview ) {
echo acf_esc_html( apply_filters( 'acf/blocks/template_not_found_message', '<p>' . __( 'The render template for this ACF Block was not found', 'acf' ) . '</p>' ) );
}
}
/**
* Returns an array of all fields for the given block.
*
* @date 24/10/18
* @since 5.8.0
*
* @param array $block The block props.
* @return array
*/
function acf_get_block_fields( $block ) {
$fields = array();
// We need at least a block name to check.
if ( empty( $block['name'] ) ) {
return $fields;
}
// Get field groups for this block.
$field_groups = acf_get_field_groups(
array(
'block' => $block['name'],
)
);
// Loop over results and append fields.
if ( $field_groups ) {
foreach ( $field_groups as $field_group ) {
$fields = array_merge( $fields, acf_get_fields( $field_group ) );
}
}
return $fields;
}
/**
* Enqueues and localizes block scripts and styles.
*
* @since 5.7.13
*
* @return void
*/
function acf_enqueue_block_assets() {
// Localize text.
acf_localize_text(
array(
'Switch to Edit' => __( 'Switch to Edit', 'acf' ),
'Switch to Preview' => __( 'Switch to Preview', 'acf' ),
'Change content alignment' => __( 'Change content alignment', 'acf' ),
'Error previewing block' => __( 'An error occurred when loading the preview for this block.', 'acf' ),
'Error loading block form' => __( 'An error occurred when loading the block in edit mode.', 'acf' ),
/* translators: %s: Block type title */
'%s settings' => __( '%s settings', 'acf' ),
)
);
// Get block types.
$block_types = array_map(
function ( $block ) {
// Render Callback may contain a incompatible class for JSON encoding. Turn it into a boolean for the frontend.
$block['render_callback'] = ! empty( $block['render_callback'] );
return $block;
},
acf_get_block_types()
);
// Localize data.
acf_localize_data(
array(
'blockTypes' => array_values( $block_types ),
'postType' => get_post_type(),
)
);
// Enqueue script.
$min = defined( 'ACF_DEVELOPMENT_MODE' ) && ACF_DEVELOPMENT_MODE ? '' : '.min';
$blocks_js_path = acf_get_url( "assets/build/js/pro/acf-pro-blocks{$min}.js" );
wp_enqueue_script( 'acf-blocks', $blocks_js_path, array( 'acf-input', 'wp-blocks' ), ACF_VERSION, true );
// Enqueue block assets.
array_map( 'acf_enqueue_block_type_assets', $block_types );
// During the edit screen loading, WordPress renders all blocks in its own attempt to preload data.
// Retrieve any cached block HTML and include this in the localized data.
if ( acf_get_setting( 'preload_blocks' ) ) {
$preloaded_blocks = acf_get_store( 'block-cache' )->get_data();
acf_localize_data(
array(
'preloadedBlocks' => $preloaded_blocks,
)
);
}
}
/**
* Enqueues scripts and styles for a specific block type.
*
* @since 5.7.13
*
* @param array $block_type The block type settings.
* @return void
*/
function acf_enqueue_block_type_assets( $block_type ) {
// Generate handle from name.
$handle = 'block-' . acf_slugify( $block_type['name'] );
// Enqueue style.
if ( $block_type['enqueue_style'] ) {
wp_enqueue_style( $handle, $block_type['enqueue_style'], array(), ACF_VERSION, 'all' );
}
// Enqueue script.
if ( $block_type['enqueue_script'] ) {
wp_enqueue_script( $handle, $block_type['enqueue_script'], array(), ACF_VERSION, true );
}
// Enqueue assets callback.
if ( $block_type['enqueue_assets'] && is_callable( $block_type['enqueue_assets'] ) ) {
call_user_func( $block_type['enqueue_assets'], $block_type );
}
}
/**
* Handles the ajax request for block data.
*
* @since 5.7.13
*
* @return void
*/
function acf_ajax_fetch_block() {
// Validate ajax request.
if ( ! acf_verify_ajax() ) {
wp_send_json_error();
}
// Get request args.
$args = acf_request_args(
array(
'post_id' => 0,
'clientId' => null,
'query' => array(),
)
);
// Verify capability.
if ( ! empty( $args['post_id'] ) && is_numeric( $args['post_id'] ) ) {
// Editing a normal post - we can verify if the user has access to that post.
if ( ! acf_current_user_can_edit_post( (int) $args['post_id'] ) ) {
wp_send_json_error();
}
} else {
// Could be editing a widget, using the site editor, etc.
$render_capability = apply_filters( 'acf/blocks/render_capability', 'edit_theme_options', $args['post_id'] );
if ( ! current_user_can( $render_capability ) ) {
wp_send_json_error();
}
}
$args['block'] = isset( $_REQUEST['block'] ) ? $_REQUEST['block'] : false; //phpcs:ignore -- requires auth; designed to contain unescaped html.
$args['context'] = isset( $_REQUEST['context'] ) ? $_REQUEST['context'] : array(); //phpcs:ignore -- requires auth; designed to contain unescaped html.
$block = $args['block'];
$query = $args['query'];
$client_id = $args['clientId'];
$raw_context = $args['context'];
$post_id = $args['post_id'];
// Bail early if no block.
if ( ! $block ) {
wp_send_json_error();
}
// Unslash and decode $_POST data for block and context.
$block = wp_unslash( $block );
$block = json_decode( $block, true );
$context = false;
if ( ! empty( $raw_context ) ) {
$raw_context = wp_unslash( $raw_context );
$raw_context = json_decode( $raw_context, true );
if ( is_array( $raw_context ) ) {
$context = $raw_context;
// Check if a postId is set in the context, otherwise try and use it the default post_id.
$post_id = isset( $context['postId'] ) ? intval( $context['postId'] ) : intval( $args['post_id'] );
}
}
// Check if clientId should become $block['id'].
if ( empty( $block['id'] ) && ! empty( $client_id ) ) {
$block['id'] = $client_id;
}
// Prepare block ensuring all settings and attributes exist.
$block = acf_prepare_block( $block );
$block = acf_add_block_meta_values( $block, $post_id );
if ( ! $block ) {
wp_send_json_error();
}
// Load field defaults when first previewing a block.
$first_preview = false;
if ( ! empty( $query['preview'] ) && ! $block['data'] ) {
$fields = acf_get_block_fields( $block );
foreach ( $fields as $field ) {
$block['data'][ "_{$field['name']}" ] = $field['key'];
}
$first_preview = true;
}
// Setup postdata allowing form to load meta.
acf_setup_meta( $block['data'], $block['id'], true );
// Setup main postdata for post_id.
global $post;
//phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- required for block template rendering.
$post = get_post( $post_id );
setup_postdata( $post );
// Vars.
$response = array( 'clientId' => $client_id );
// Check if we've recieved serialised form data
$use_post_data = false;
if ( ! empty( $block['data'] ) && is_array( $block['data'] ) ) {
// Ensure we've got field keys posted.
$valid_field_keys = array_filter( array_keys( $block['data'] ), 'acf_is_field_key' );
if ( ! empty( $valid_field_keys ) ) {
$use_post_data = true;
}
}
$query['validate'] = ( ! empty( $query['validate'] ) && ( $query['validate'] === 'true' || $query['validate'] === true ) );
if ( ! empty( $query['validate'] ) || ! empty( $block['validate'] ) ) {
$response['validation'] = acf_get_block_validation_state( $block, $first_preview, $use_post_data );
}
// Query form.
if ( ! empty( $query['form'] ) ) {
// Load fields for form.
$fields = acf_get_block_fields( $block );
// Prefix field inputs to avoid multiple blocks using the same name/id attributes.
acf_prefix_fields( $fields, "acf-{$block['id']}" );
if ( $fields ) {
// Start Capture.
ob_start();
// Render.
echo '<div class="acf-block-fields acf-fields" data-block-id="' . esc_attr( $block['id'] ) . '">';
acf_render_fields( $fields, $block['id'], 'div', 'field' );
echo '</div>';
// Store Capture.
$response['form'] = ob_get_clean();
} else {
// There are no fields on this block.
$response['form'] = acf_get_empty_block_form_html( $block['name'] ); //phpcs:ignore -- escaped in function.
}
}
// Query preview.
if ( ! empty( $query['preview'] ) ) {
// Render_callback vars.
$content = '';
$is_preview = true;
// Render and store HTML.
$response['preview'] = acf_rendered_block( $block, $content, $is_preview, $post_id, null, $context, true );
}
// Send response.
wp_send_json_success( $response );
}
// Register ajax action.
acf_register_ajax( 'fetch-block', 'acf_ajax_fetch_block' );
/**
* Render the empty block form for when a block has no fields assigned.
*
* @since 6.0.0
*
* @param string $block_name The block name current being rendered.
* @return string The html that makes up a block form with no fields.
*/
function acf_get_empty_block_form_html( $block_name ) {
$message = __( 'This block contains no editable fields.', 'acf' );
if ( acf_current_user_can_admin() ) {
$message .= ' ';
$message .= sprintf(
/* translators: %s: an admin URL to the field group edit screen */
__( 'Assign a <a href="%s" target="_blank">field group</a> to add fields to this block.', 'acf' ),
admin_url( 'edit.php?post_type=acf-field-group' )
);
}
$message = apply_filters( 'acf/blocks/no_fields_assigned_message', $message, $block_name );
if ( ! is_string( $message ) ) {
$message = '';
}
if ( empty( $message ) ) {
return acf_esc_html( '<div class="acf-empty-block-fields"></div>' );
} else {
return acf_esc_html( '<div class="acf-block-fields acf-fields acf-empty-block-fields">' . $message . '</div>' );
}
}
/**
* Parse content that may contain HTML block comments and saves ACF block meta.
*
* @since 5.7.13
*
* @param string $text Content that may contain HTML block comments.
* @return string
*/
function acf_parse_save_blocks( $text = '' ) {
// Search text for dynamic blocks and modify attrs.
return addslashes(
preg_replace_callback(
'/<!--\s+wp:(?P<name>[\S]+)\s+(?P<attrs>{[\S\s]+?})\s+(?P<void>\/)?-->/',
'acf_parse_save_blocks_callback',
stripslashes( $text )
)
);
}
// Hook into saving process.
add_filter( 'content_save_pre', 'acf_parse_save_blocks', 5, 1 );
/**
* Callback used in preg_replace to modify ACF Block comment.
*
* @since 5.7.13
*
* @param array $matches The preg matches.
* @return string
*/
function acf_parse_save_blocks_callback( $matches ) {
// Defaults.
$name = isset( $matches['name'] ) ? $matches['name'] : '';
$attrs = isset( $matches['attrs'] ) ? json_decode( $matches['attrs'], true ) : '';
$void = isset( $matches['void'] ) ? $matches['void'] : '';
// Bail early if missing data or not an ACF Block.
if ( ! $name || ! $attrs || ! acf_has_block_type( $name ) ) {
return $matches[0];
}
// Check if we need to generate a block ID.
$block_id = acf_ensure_block_id_prefix( acf_get_block_id( $attrs ) );
if ( ! empty( $attrs['data'] ) ) {
if ( acf_block_uses_post_meta( $attrs ) ) {
// Block ID is used later to retrieve & save values.
$attrs['id'] = $block_id;
// Cache the values until we have a post ID and can save.
$store = acf_get_store( 'block-meta-values' );
$store->set( $block_id, $attrs['data'] );
// No need to store values in post content.
unset( $attrs['data'] );
} else {
// Convert "data" to "meta".
// No need to check if already in meta format. Local Meta will do this for us.
$attrs['data'] = acf_setup_meta( $attrs['data'], $block_id );
}
}
/**
* Filters the block attributes before saving.
*
* @since 5.7.14
*
* @param array $attrs The block attributes.
*/
$attrs = apply_filters( 'acf/pre_save_block', $attrs );
// Gutenberg expects a specific encoding format.
$attrs = acf_serialize_block_attributes( $attrs );
return '<!-- wp:' . $name . ' ' . $attrs . ' ' . $void . '-->';
}
/**
* Return or generate a block ID.
*
* @since 6.0.0
*
* @param array $attributes A block attributes array.
* @param array $context The block context array, defaults to an empty array.
* @param boolean $force If we should generate a new block ID even if one exists.
* @return string A block ID.
*/
function acf_get_block_id( $attributes, $context = array(), $force = false ) {
$context = is_array( $context ) ? $context : array();
ksort( $context );
$attributes['_acf_context'] = $context;
if ( empty( $attributes['id'] ) || $force ) {
unset( $attributes['id'] );
// Remove all empty string values as they're not present in JS hash building.
foreach ( $attributes as $key => $value ) {
if ( '' === $value ) {
unset( $attributes[ $key ] );
}
}
// Check if data is empty and remove it if so to match JS hash building.
if ( isset( $attributes['data'] ) && empty( $attributes['data'] ) ) {
unset( $attributes['data'] );
}
ksort( $attributes );
return md5( wp_json_encode( $attributes, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ) );
}
return $attributes['id'];
}
/**
* Ensure a block ID always has a block_ prefix for post meta internals.
*
* @since 6.0.0
*
* @param string $block_id A possibly non-prefixed block ID.
* @return string A prefixed block ID.
*/
function acf_ensure_block_id_prefix( $block_id ) {
if ( substr( $block_id, 0, 6 ) === 'block_' ) {
return $block_id;
}
return 'block_' . $block_id;
}
/**
* This directly copied from the WordPress core `serialize_block_attributes()` function.
*
* We need this in order to make sure that block attributes are stored in a way that is
* consistent with how Gutenberg sends them over from JS, and so that things like wp_kses()
* work as expected. Copied from core to get around a bug that was fixed in 5.8.1 or on the off chance
* that folks are still using WP 5.3 or below.
*
* TODO: Remove this when we refactor `acf_parse_save_blocks_callback()` to use `serialize_block()`,
* or when we're confident that folks aren't using WP versions prior to 5.8.
*
* @since 5.12
*
* @param array $block_attributes Attributes object.
* @return string Serialized attributes.
*/
function acf_serialize_block_attributes( $block_attributes ) {
$encoded_attributes = wp_json_encode( $block_attributes, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );
$encoded_attributes = preg_replace( '/--/', '\\u002d\\u002d', $encoded_attributes );
$encoded_attributes = preg_replace( '/</', '\\u003c', $encoded_attributes );
$encoded_attributes = preg_replace( '/>/', '\\u003e', $encoded_attributes );
$encoded_attributes = preg_replace( '/&/', '\\u0026', $encoded_attributes );
// Regex: /\\"/.
$encoded_attributes = preg_replace( '/\\\\"/', '\\u0022', $encoded_attributes );
return $encoded_attributes;
}
/**
* Handle validating a block's fields and return the validity, and any errors.
*
* This function can use values loaded into Local Meta, which means they have to be
* converted back to the data format before they can be validated.
*
* @since 6.3
*
* @param array $block An array of the block's data attribute.
* @param boolean $using_defaults True if the block is currently being generated with default values. Default false.
* @param boolean $use_post_data True if we should validate the POSTed data rather than local meta values. Default false.
* @param boolean $on_load True if we're validating as part of a render. This is essentially the same as a first load. Default false.
* @return array An array containing a valid boolean, and an errors array.
*/
function acf_get_block_validation_state( $block, $using_defaults = false, $use_post_data = false, $on_load = false ) {
$block_id = $block['id'];
if ( $on_load && empty( $block['validate_on_load'] ) ) {
// If we're in a page load render, and validate on load is false, skip validation.
$errors = false;
} elseif ( $use_post_data ) {
$errors = acf_validate_block_from_post_data( $block );
} elseif ( $using_defaults || empty( $block['data'] ) ) {
// If data is empty or it's first preview, load the default fields for this block so we can get a required validation state from the current field set.
// Treat as "on load" if it's the first render of a block.
if ( empty( $block['validate_on_load'] ) ) {
$errors = false;
} else {
$errors = acf_validate_block_from_local_meta( $block_id, acf_get_block_fields( $block ), true );
}
} else {
$errors = acf_validate_block_from_local_meta( $block_id, get_field_objects( $block_id, false ), false );
}
return array(
'valid' => empty( $errors ),
'errors' => $errors,
);
}
/**
* Handle the specific validation for a block from POSTed values.
*
* @since 6.3.1
*
* @param array $block The block object containing the POSTed values and other block data
* @return array|boolean An array containing the validation errors, or false if there are no errors.
*/
function acf_validate_block_from_post_data( $block ) {
acf_reset_validation_errors();
acf_validate_values( $block['data'], "acf-{$block['id']}" );
$errors = acf_get_validation_errors();
return $errors;
}
/**
* Handle the specific validation for a block from local meta.
*
* This function uses the values loaded into Local Meta, which means they have to be
* converted back to the data format because they can be validated.
*
* @since 6.3.1
*
* @param string $block_id The block ID.
* @param array $field_objects The field objects in local meta to be validated.
* @param boolean $using_defaults True if this is the first load of the block, when special validation may apply.
* @return array|boolean An array containing the validation errors, or false if there are no errors.
*/
function acf_validate_block_from_local_meta( $block_id, $field_objects, $using_defaults = false ) {
if ( empty( $field_objects ) ) {
return false;
}
$using_loaded_meta = false;
if ( acf_get_data( $block_id . '_loaded_meta_values' ) ) {
$using_loaded_meta = true;
}
acf_reset_validation_errors();
foreach ( $field_objects as $field ) {
// Skip for nested fields - these don't work correctly on initial load of a saved block.
if ( ! empty( $field['sub_fields'] ) ) {
continue;
}
// If we're using default values, or loaded meta we may have values which are about to be populated at field render, so shouldn't raise errors here.
if ( $using_defaults || $using_loaded_meta ) {
// Fields with conditional logic applied shouldn't be validated during first load as conditionals aren't respected.
if ( ! empty( $field['conditional_logic'] ) ) {
continue;
}
// If we've got a empty value with a default value set and it's first load, don't produce a validation error as it will be substituted on render.
if ( $field['required'] && empty( $field['value'] ) && ! empty( $field['default_value'] ) ) {
continue;
}
// If we're loading a few radio or select-like fields, without allow null, HTML will automatically select the first value on render, so skip here.
if ( $field['required'] && in_array( $field['type'], array( 'radio', 'button_group', 'select' ), true ) && ! $field['allow_null'] ) {
continue;
}
}
$key = $field['key'];
$value = $field['value'];
acf_validate_value( $value, $field, "acf-{$block_id}[{$key}]" );
}
return acf_get_validation_errors();
}
/**
* Set ACF data before a rest call if media scripts have not been enqueued yet for after REST reset.
*
* @date 07/06/22
* @since 6.0
*
* @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response The WordPress response object.
* @return mixed
*/
function acf_set_after_rest_media_enqueue_reset_flag( $response ) {
global $wp_actions;
acf_set_data( 'acf_inside_rest_call', true );
acf_set_data( 'acf_should_reset_media_enqueue', empty( $wp_actions['wp_enqueue_media'] ) );
acf_set_data( 'acf_did_render_block_form', false );
return $response;
}
add_filter( 'rest_request_before_callbacks', 'acf_set_after_rest_media_enqueue_reset_flag' );
/**
* Reset wp_enqueue_media action count after REST call so it can happen inside the main execution if required.
*
* @date 07/06/22
* @since 6.0
*
* @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response The WordPress response object.
* @return mixed
*/
function acf_reset_media_enqueue_after_rest( $response ) {
acf_set_data( 'acf_inside_rest_call', false );
if ( acf_get_data( 'acf_should_reset_media_enqueue' ) && acf_get_data( 'acf_did_render_block_form' ) ) {
global $wp_actions;
//phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- no other option here as this works around a breaking WordPress change with REST preload scopes.
$wp_actions['wp_enqueue_media'] = 0;
}
return $response;
}
add_filter( 'rest_request_after_callbacks', 'acf_reset_media_enqueue_after_rest' );
/**
* Checks if the provided block is configured to save/load post meta.
*
* @since 6.3
*
* @param array $block The block to check.
* @return boolean
*/
function acf_block_uses_post_meta( $block ): bool {
if ( ! empty( $block['name'] ) && ! isset( $block['use_post_meta'] ) ) {
$block = acf_get_block_type( $block['name'] );
}
return ! empty( $block['use_post_meta'] );
}
/**
* Loads ACF field values from the post meta if the block is configured to do so.
*
* @since 6.3
*
* @param array $block The block to get values for.
* @param integer $post_id The ID of the post to retrieve meta from.
* @return array
*/
function acf_add_block_meta_values( $block, $post_id ) {
// Bail if the block already has data (i.e. previewing an update).
if ( ! is_array( $block ) || ! empty( $block['data'] ) ) {
return $block;
}
// Bail if block doesn't load from meta.
if ( ! acf_block_uses_post_meta( $block ) ) {
return $block;
}
// Bail if we don't have a post ID or block ID.
if ( empty( $post_id ) || empty( $block['id'] ) ) {
return $block;
}
$fields = acf_get_block_fields( $block );
if ( empty( $fields ) ) {
return $block;
}
$values = array();
$store = acf_get_store( 'values' );
$block_id = acf_ensure_block_id_prefix( $block['id'] );
foreach ( $fields as $field ) {
$value = acf_get_value( $post_id, $field );
// Make sure we got a value (i.e. $allow_load = true).
if ( ! $store->has( "{$post_id}:{$field['name']}" ) ) {
continue;
}
$store->set( "{$block_id}:{$field['name']}", $value );
$values[ $field['name'] ] = $value;
$values[ '_' . $field['name'] ] = $field['key']; // TODO: Is there a better way to generate this?
}
$block['data'] = $values;
acf_set_data( $block_id . '_loaded_meta_values', true );
return $block;
}
/**
* Stores ACF field values in post meta for any blocks configured to do so.
*
* @since 6.3
*
* @param integer $post_id The ID of the post being saved.
* @param WP_Post $post The post object.
* @return void
*/
function acf_save_block_meta_values( $post_id, $post ) {
$meta_values = acf_get_block_meta_values_to_save( $post->post_content );
if ( empty( $meta_values ) ) {
return;
}
// Save values for any post meta blocks.
acf_save_post( $post_id, $meta_values );
}
add_action( 'save_post', 'acf_save_block_meta_values', 10, 2 );
/**
* Iterates over blocks in post content and retrieves values
* that need to be saved to post meta.
*
* @since 6.3
*
* @param string $content The content saved for the post.
* @return array An array containing the field values that need to be saved.
*/
function acf_get_block_meta_values_to_save( $content = '' ) {
$meta_values = array();
// Bail early if not in a format we expect or if it has no blocks.
if ( ! is_string( $content ) || empty( $content ) || ! has_blocks( $content ) ) {
return $meta_values;
}
$blocks = parse_blocks( $content );
// Bail if no blocks to save.
if ( ! is_array( $blocks ) || empty( $blocks ) ) {
return $meta_values;
}
foreach ( $blocks as $block ) {
// Verify this is an ACF block that should save to meta.
if ( ! acf_block_uses_post_meta( $block['attrs'] ) ) {
continue;
}
// We need a block ID to retrieve the values from cache.
$block_id = ! empty( $block['attrs']['id'] ) ? $block['attrs']['id'] : false;
if ( ! $block_id ) {
continue;
}
// Verify that we have values for this block.
$store = acf_get_store( 'block-meta-values' );
if ( ! $store->has( $block_id ) ) {
continue;
}
// Get the values and remove from cache.
$block_values = $store->get( $block_id );
$store->remove( $block_id );
$meta_values = array_merge( $meta_values, $block_values );
}
return $meta_values;
}