admin-field-group.php
19.1 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
<?php
/**
* ACF Admin Field Group Class
*
* @class acf_admin_field_group
*
* @package ACF
* @subpackage Admin
*/
if ( ! class_exists( 'acf_admin_field_group' ) ) {
/**
* ACF Admin Field Group Class
*
* All the logic for editing a field group
*/
class acf_admin_field_group {
/**
* This function will setup the class functionality
*
* @since 5.0.0
*
* @return void
*/
public function __construct() {
// actions.
add_action( 'current_screen', array( $this, 'current_screen' ) );
add_action( 'save_post', array( $this, 'save_post' ), 10, 2 );
// ajax.
add_action( 'wp_ajax_acf/field_group/render_field_settings', array( $this, 'ajax_render_field_settings' ) );
add_action( 'wp_ajax_acf/field_group/render_location_rule', array( $this, 'ajax_render_location_rule' ) );
add_action( 'wp_ajax_acf/field_group/move_field', array( $this, 'ajax_move_field' ) );
// filters.
add_filter( 'post_updated_messages', array( $this, 'post_updated_messages' ) );
add_filter( 'use_block_editor_for_post_type', array( $this, 'use_block_editor_for_post_type' ), 10, 2 );
}
/**
* Prevents the block editor from loading when editing an ACF field group.
*
* @since 5.8.0
*
* @param bool $use_block_editor Whether the post type can be edited or not. Default true.
* @param string $post_type The post type being checked.
* @return bool
*/
public function use_block_editor_for_post_type( $use_block_editor, $post_type ) {
if ( $post_type === 'acf-field-group' ) {
return false;
}
return $use_block_editor;
}
/**
* This function will customize the message shown when editing a field group
*
* @since 5.0.0
*
* @param array $messages Post type messages.
* @return $messages
*/
public function post_updated_messages( $messages ) {
// append to messages.
$messages['acf-field-group'] = array(
0 => '', // Unused. Messages start at index 1.
1 => __( 'Field group updated.', 'acf' ),
2 => __( 'Field group updated.', 'acf' ),
3 => __( 'Field group deleted.', 'acf' ),
4 => __( 'Field group updated.', 'acf' ),
5 => false, // field group does not support revisions.
6 => __( 'Field group published.', 'acf' ),
7 => __( 'Field group saved.', 'acf' ),
8 => __( 'Field group submitted.', 'acf' ),
9 => __( 'Field group scheduled for.', 'acf' ),
10 => __( 'Field group draft updated.', 'acf' ),
);
// return.
return $messages;
}
/**
* This function is fired when loading the admin page before HTML has been rendered.
*
* @since 5.0.0
*
* @return void
*/
public function current_screen() {
// validate screen.
if ( ! acf_is_screen( 'acf-field-group' ) ) {
return;
}
// disable filters to ensure ACF loads raw data from DB.
acf_disable_filters();
// enqueue scripts.
acf_enqueue_scripts();
// actions.
add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
add_action( 'acf/input/admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
add_action( 'acf/input/admin_head', array( $this, 'admin_head' ) );
add_action( 'acf/input/form_data', array( $this, 'form_data' ) );
add_action( 'acf/input/admin_footer', array( $this, 'admin_footer' ) );
// filters.
add_filter( 'acf/input/admin_l10n', array( $this, 'admin_l10n' ) );
}
/**
* Modifies the admin body class.
*
* @since 6.0.0
*
* @param string $classes Space-separated list of CSS classes.
* @return string
*/
public function admin_body_class( $classes ) {
$classes .= ' acf-admin-single-field-group';
return $classes;
}
/**
* This action is run after post query but before any admin script / head actions.
* It is a good place to register all actions.
*
* @since 5.0.0
*
* @return void
*/
public function admin_enqueue_scripts() {
// no autosave.
wp_dequeue_script( 'autosave' );
// custom scripts.
wp_enqueue_style( 'acf-field-group' );
wp_enqueue_script( 'acf-field-group' );
// localize text.
acf_localize_text(
array(
'The string "field_" may not be used at the start of a field name' => __( 'The string "field_" may not be used at the start of a field name', 'acf' ),
'This field cannot be moved until its changes have been saved' => __( 'This field cannot be moved until its changes have been saved', 'acf' ),
'Field group title is required' => __( 'Field group title is required', 'acf' ),
'Move field group to trash?' => __( 'Move field group to trash?', 'acf' ),
'No toggle fields available' => __( 'No toggle fields available', 'acf' ),
'Move Custom Field' => __( 'Move Custom Field', 'acf' ),
'Close modal' => __( 'Close modal', 'acf' ),
'Field moved to other group' => __( 'Field moved to other group', 'acf' ),
'Checked' => __( 'Checked', 'acf' ),
'(no label)' => __( '(no label)', 'acf' ),
'(this field)' => __( '(this field)', 'acf' ),
'copy' => __( 'copy', 'acf' ),
'or' => __( 'or', 'acf' ),
'Show this field group if' => __( 'Show this field group if', 'acf' ),
'Null' => __( 'Null', 'acf' ),
// Conditions.
'Has any value' => __( 'Has any value', 'acf' ),
'Has no value' => __( 'Has no value', 'acf' ),
'Value is equal to' => __( 'Value is equal to', 'acf' ),
'Value is not equal to' => __( 'Value is not equal to', 'acf' ),
'Value matches pattern' => __( 'Value matches pattern', 'acf' ),
'Value contains' => __( 'Value contains', 'acf' ),
'Value is greater than' => __( 'Value is greater than', 'acf' ),
'Value is less than' => __( 'Value is less than', 'acf' ),
'Selection is greater than' => __( 'Selection is greater than', 'acf' ),
'Selection is less than' => __( 'Selection is less than', 'acf' ),
// Pro-only fields.
'Repeater (Pro only)' => __( 'Repeater (Pro only)', 'acf' ),
'Flexibly Content (Pro only)' => __( 'Flexible Content (Pro only)', 'acf' ),
'Clone (Pro only)' => __( 'Clone (Pro only)', 'acf' ),
'Gallery (Pro only)' => __( 'Gallery (Pro only)', 'acf' ),
)
);
// localize data.
acf_localize_data(
array(
'fieldTypes' => acf_get_field_types_info(),
)
);
// 3rd party hook.
do_action( 'acf/field_group/admin_enqueue_scripts' );
}
/**
* This function will setup all functionality for the field group edit page to work
*
* @since 3.1.8
*
* @return void
*/
public function admin_head() {
// global.
global $post, $field_group;
// set global var.
$field_group = acf_get_field_group( $post->ID );
// metaboxes.
add_meta_box( 'acf-field-group-fields', __( 'Fields', 'acf' ), array( $this, 'mb_fields' ), 'acf-field-group', 'normal', 'high' );
if ( ! defined( 'ACF_PRO' ) || ! ACF_PRO ) {
add_meta_box( 'acf-field-group-pro-features', 'ACF PRO', array( $this, 'mb_pro_features' ), 'acf-field-group', 'normal', 'high' );
}
add_meta_box( 'acf-field-group-options', __( 'Settings', 'acf' ), array( $this, 'mb_options' ), 'acf-field-group', 'normal', 'high' );
// actions.
add_action( 'post_submitbox_misc_actions', array( $this, 'post_submitbox_misc_actions' ), 10, 0 );
add_action( 'edit_form_after_title', array( $this, 'edit_form_after_title' ), 10, 0 );
// filters.
add_filter( 'screen_settings', array( $this, 'screen_settings' ), 10, 1 );
add_filter( 'get_user_option_screen_layout_acf-field-group', array( $this, 'screen_layout' ), 10, 1 );
// 3rd party hook.
do_action( 'acf/field_group/admin_head' );
}
/**
* This action will allow ACF to render metaboxes after the title
*
* @date 17/08/13
*
* @return void
*/
public function edit_form_after_title() {
// globals.
global $post;
// render post data.
acf_form_data(
array(
'screen' => 'field_group',
'post_id' => $post->ID,
'delete_fields' => 0,
'validation' => 0,
)
);
}
/**
* This function will add extra HTML to the acf form data element
*
* @since 5.3.8
*
* @param array $args Arguments array to pass through to action.
* @return void
*/
public function form_data( $args ) {
// do action.
do_action( 'acf/field_group/form_data', $args );
}
/**
* This function will append extra l10n strings to the acf JS object
*
* @since 5.3.8
*
* @param array $l10n The array of translated strings.
* @return $l10n
*/
public function admin_l10n( $l10n ) {
return apply_filters( 'acf/field_group/admin_l10n', $l10n );
}
/**
* Admin footer third party hook support
*
* @since 5.3.2
*
* @return void
*/
public function admin_footer() {
// 3rd party hook
do_action( 'acf/field_group/admin_footer' );
}
/**
* Screen settings html output
*
* @since 3.6.0
*
* @param string $html Current screen settings HTML.
* @return string $html
*/
public function screen_settings( $html ) {
$show_field_keys = acf_get_user_setting( 'show_field_keys' ) ? 'checked="checked"' : '';
$show_field_settings_tabs = acf_get_user_setting( 'show_field_settings_tabs', true ) ? 'checked="checked"' : '';
$hide_field_settings_tabs = apply_filters( 'acf/field_group/disable_field_settings_tabs', false );
$html .= '<div id="acf-append-show-on-screen" class="acf-hidden">';
$html .= '<label for="acf-field-key-hide"><input id="acf-field-key-hide" type="checkbox" value="1" name="show_field_keys" ' . $show_field_keys . ' /> ' . __( 'Field Keys', 'acf' ) . '</label>';
if ( ! $hide_field_settings_tabs ) {
$html .= '<label for="acf-field-settings-tabs"><input id="acf-field-settings-tabs" type="checkbox" value="1" name="show_field_settings_tabs" ' . $show_field_settings_tabs . ' />' . __( 'Field Settings Tabs', 'acf' ) . '</label>';
}
$html .= '</div>';
return $html;
}
/**
* Sets the "Edit Field Group" screen to use a one-column layout.
*
* @param int $columns Number of columns for layout.
*
* @return int
*/
public function screen_layout( $columns = 0 ) {
return 1;
}
/**
* This function will customize the publish metabox
*
* @since 5.2.9
*
* @return void
*/
public function post_submitbox_misc_actions() {
global $field_group;
$status_label = $field_group['active'] ? _x( 'Active', 'post status', 'acf' ) : _x( 'Inactive', 'post status', 'acf' );
?>
<script type="text/javascript">
(function($) {
$('#post-status-display').html( '<?php echo esc_html( $status_label ); ?>' );
})(jQuery);
</script>
<?php
}
/**
* This function will save all the field group data
*
* @since 1.0.0
*
* @param int $post_id The post ID.
* @param WP_Post $post The post object.
*
* @return $post_id (int)
*/
public function save_post( $post_id, $post ) {
// do not save if this is an auto save routine.
if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
return $post_id;
}
// bail early if not acf-field-group.
if ( $post->post_type !== 'acf-field-group' ) {
return $post_id;
}
// only save once! WordPress save's a revision as well.
if ( wp_is_post_revision( $post_id ) ) {
return $post_id;
}
// verify nonce.
if ( ! acf_verify_nonce( 'field_group' ) ) {
return $post_id;
}
// Bail early if request came from an unauthorised user.
if ( ! current_user_can( acf_get_setting( 'capability' ) ) ) {
return $post_id;
}
// disable filters to ensure ACF loads raw data from DB.
acf_disable_filters();
// save fields.
if ( ! empty( $_POST['acf_fields'] ) ) {
// loop.
foreach ( $_POST['acf_fields'] as $field ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitized when saved.
if ( ! isset( $field['key'] ) ) {
continue;
}
// vars.
$specific = false;
$save = acf_extract_var( $field, 'save' );
// only saved field if has changed.
if ( $save == 'meta' ) {
$specific = array(
'menu_order',
'post_parent',
);
}
// set parent.
if ( ! $field['parent'] ) {
$field['parent'] = $post_id;
}
// save field.
acf_update_field( $field, $specific );
}
}
// delete fields.
if ( $_POST['_acf_delete_fields'] ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitized below.
// clean.
$ids = explode( '|', $_POST['_acf_delete_fields'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitized below.
$ids = array_map( 'intval', $ids );
// loop.
foreach ( $ids as $id ) {
// bai early if no id.
if ( ! $id ) {
continue;
}
// delete.
acf_delete_field( $id );
}
}
// add args.
$_POST['acf_field_group']['ID'] = $post_id;
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitized when saved.
$_POST['acf_field_group']['title'] = $_POST['post_title'];
// save field group.
acf_update_field_group( $_POST['acf_field_group'] );
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
return $post_id;
}
/**
* This function will render the HTML for the medtabox 'acf-field-group-fields'
*
* @since 5.0.0
*
* @return void
*/
public function mb_fields() {
// global.
global $field_group;
// get fields.
$view = array(
'fields' => acf_get_fields( $field_group ),
'parent' => 0,
);
// load view.
acf_get_view( 'field-group-fields', $view );
}
/**
* This function will render the HTML for the metabox 'acf-field-group-pro-features'
*
* @since 6.0.0
*
* @return void
*/
public function mb_pro_features() {
// load view.
acf_get_view( 'field-group-pro-features' );
}
/**
* This function will render the HTML for the metabox 'acf-field-group-options'
*
* @since 5.0.0
*
* @return void
*/
public function mb_options() {
// global.
global $field_group;
// field key (leave in for compatibility).
if ( ! acf_is_field_group_key( $field_group['key'] ) ) {
$field_group['key'] = uniqid( 'group_' );
}
// view.
acf_get_view( 'field-group-options' );
}
/**
* This function can be accessed via an AJAX action and will return the result from the render_location_value function
*
* @since 5.0.0
*
* @return void
*/
public function ajax_render_location_rule() {
// validate.
if ( ! acf_verify_ajax() ) {
die();
}
// verify user capability.
if ( ! acf_current_user_can_admin() ) {
die();
}
// validate rule.
$rule = acf_validate_location_rule( acf_sanitize_request_args( $_POST['rule'] ) );
// view.
acf_get_view(
'html-location-rule',
array(
'rule' => $rule,
)
);
// die.
die();
}
/**
* This function will return HTML containing the field's settings based on it's new type
*
* @since 5.0.0
*
* @return void
*/
public function ajax_render_field_settings() {
// Verify the current request.
if ( ! acf_verify_ajax() || ! acf_current_user_can_admin() ) {
wp_send_json_error();
}
// Make sure we have a field.
$field = acf_maybe_get_POST( 'field' );
if ( ! $field ) {
wp_send_json_error();
}
$field['prefix'] = acf_maybe_get_POST( 'prefix' );
$field = acf_get_valid_field( $field );
$tabs = array(
'general' => '',
'validation' => '',
'presentation' => '',
'conditional_logic' => '',
);
foreach ( $tabs as $tab => $content ) {
ob_start();
if ( 'general' === $tab ) {
// Back-compat for fields not using tab-specific hooks.
do_action( "acf/render_field_settings/type={$field['type']}", $field );
}
do_action( "acf/render_field_{$tab}_settings/type={$field['type']}", $field );
$sections[ $tab ] = ob_get_clean();
}
wp_send_json_success( $sections );
}
/**
* Move field AJAX function
*
* @since 5.0.0
*
* @return void No return, HTML output for AJAX consumption.
*/
public function ajax_move_field() {
// disable filters to ensure ACF loads raw data from DB.
acf_disable_filters();
$args = acf_parse_args(
//phpcs:ignore WordPress.Security.NonceVerification.Missing
$_POST,
array(
'nonce' => '',
'post_id' => 0,
'field_id' => 0,
'field_group_id' => 0,
)
);
// verify nonce.
if ( ! wp_verify_nonce( $args['nonce'], 'acf_nonce' ) ) {
die();
}
// verify user capability.
if ( ! acf_current_user_can_admin() ) {
die();
}
// confirm?
if ( $args['field_id'] && $args['field_group_id'] ) {
// vars.
$field = acf_get_field( $args['field_id'] );
$field_group = acf_get_field_group( $args['field_group_id'] );
// update parent.
$field['parent'] = $field_group['ID'];
// remove conditional logic.
$field['conditional_logic'] = 0;
// update field.
acf_update_field( $field );
// Output HTML.
$link = '<a href="' . admin_url( 'post.php?post=' . $field_group['ID'] . '&action=edit' ) . '" target="_blank">' . esc_html( $field_group['title'] ) . '</a>';
echo '' .
'<p><strong>' . __( 'Move Complete.', 'acf' ) . '</strong></p>' .
'<p>' . sprintf(
/* translators: Confirmation message once a field has been moved to a different field group. */
acf_punctify( __( 'The %1$s field can now be found in the %2$s field group', 'acf' ) ),
esc_html( $field['label'] ),
$link //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
) . '</p>' .
'<a href="#" class="button button-primary acf-close-popup">' . __( 'Close Modal', 'acf' ) . '</a>';
die();
}
// get all field groups.
$field_groups = acf_get_field_groups();
$choices = array();
// check.
if ( ! empty( $field_groups ) ) {
// loop.
foreach ( $field_groups as $field_group ) {
// bail early if no ID.
if ( ! $field_group['ID'] ) {
continue;
}
// bail early if is current.
if ( $field_group['ID'] == $args['post_id'] ) {
continue;
}
$choices[ $field_group['ID'] ] = $field_group['title'];
}
}
// render options.
$field = acf_get_valid_field(
array(
'type' => 'select',
'name' => 'acf_field_group',
'choices' => $choices,
'aria-label' => __( 'Please select the destination for this field', 'acf' ),
)
);
echo '<p>' . __( 'Please select the destination for this field', 'acf' ) . '</p>';
echo '<form id="acf-move-field-form">';
// render.
acf_render_field_wrap( $field );
echo '<button type="submit" class="acf-btn">' . __( 'Move Field', 'acf' ) . '</button>';
echo '</form>';
// die.
die();
}
}
// initialize.
new acf_admin_field_group();
}
?>