acf_admin_field_group{} │ ACF 1.0└─ ACF_Admin_Internal_Post_Type
ACF Admin Field Group Class
All the logic for editing a field group
Хуки из класса
Использование
$acf_admin_field_group = new acf_admin_field_group(); // use class methods
Методы
- public __construct()
- public admin_enqueue_scripts()
- public admin_footer()
- public admin_head()
- public admin_l10n( $l10n )
- public ajax_move_field()
- public ajax_render_field_settings()
- public ajax_render_location_rule()
- public edit_form_after_title()
- public form_data( $args )
- public include_pro_features()
- public mb_fields()
- public mb_options()
- public mb_pro_features()
- public post_submitbox_misc_actions()
- public post_updated_messages( $messages )
- public save_post( $post_id, $post )
- public screen_layout( $columns = 0 )
- public screen_settings( $html )
Код acf_admin_field_group{} acf admin field group{} ACF 6.4.2
<?php
class acf_admin_field_group extends ACF_Admin_Internal_Post_Type {
/**
* The slug for the internal post type.
*
* @since 6.1
* @var string
*/
public $post_type = 'acf-field-group';
/**
* The admin body class used for the post type.
*
* @since 6.1
* @var string
*/
public $admin_body_class = 'acf-admin-single-field-group';
/**
* Constructs the class.
*
* @since 5.0.0
*/
public function __construct() {
parent::__construct();
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' ) );
}
/**
* Customizes the messages shown when editing a field group.
*
* @since 5.0.0
*
* @param array $messages Post type messages.
* @return array
*/
public function post_updated_messages( $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 $messages;
}
/**
* Enqueues any scripts necessary for internal post type.
*
* @since 5.0.0
*/
public function admin_enqueue_scripts() {
parent::admin_enqueue_scripts();
acf_localize_text(
array(
'The string "field_" may not be used at the start of a field name' => esc_html__( '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' => esc_html__( 'This field cannot be moved until its changes have been saved', 'acf' ),
'Field group title is required' => esc_html__( 'Field group title is required', 'acf' ),
'Move field group to trash?' => esc_html__( 'Move field group to trash?', 'acf' ),
'No toggle fields available' => esc_html__( 'No toggle fields available', 'acf' ),
'Move Custom Field' => esc_html__( 'Move Custom Field', 'acf' ),
'Close modal' => esc_html__( 'Close modal', 'acf' ),
'Field moved to other group' => esc_html__( 'Field moved to other group', 'acf' ),
'Field groups linked successfully.' => esc_html__( 'Field groups linked successfully.', 'acf' ),
'Checked' => esc_html__( 'Checked', 'acf' ),
'(no label)' => esc_html__( '(no label)', 'acf' ),
'(this field)' => esc_html__( '(this field)', 'acf' ),
'copy' => esc_html__( 'copy', 'acf' ),
'or' => esc_html__( 'or', 'acf' ),
'Show this field group if' => esc_html__( 'Show this field group if', 'acf' ),
'Null' => esc_html__( 'Null', 'acf' ),
'PRO Only' => esc_html__( 'PRO Only', 'acf' ),
// Conditions.
'Has any value' => esc_html__( 'Has any value', 'acf' ),
'Has no value' => esc_html__( 'Has no value', 'acf' ),
'Value is equal to' => esc_html__( 'Value is equal to', 'acf' ),
'Value is not equal to' => esc_html__( 'Value is not equal to', 'acf' ),
'Value matches pattern' => esc_html__( 'Value matches pattern', 'acf' ),
'Value contains' => esc_html__( 'Value contains', 'acf' ),
'Value is greater than' => esc_html__( 'Value is greater than', 'acf' ),
'Value is less than' => esc_html__( 'Value is less than', 'acf' ),
'Selection is greater than' => esc_html__( 'Selection is greater than', 'acf' ),
'Selection is less than' => esc_html__( 'Selection is less than', 'acf' ),
'Relationship is equal to' => esc_html__( 'Relationship is equal to', 'acf' ),
'Relationship is not equal to' => esc_html__( 'Relationship is not equal to', 'acf' ),
'Relationships contain' => esc_html__( 'Relationships contain', 'acf' ),
'Relationships do not contain' => esc_html__( 'Relationships do not contain', 'acf' ),
'Post is equal to' => esc_html__( 'Post is equal to', 'acf' ),
'Post is not equal to' => esc_html__( 'Post is not equal to', 'acf' ),
'Posts contain' => esc_html__( 'Posts contain', 'acf' ),
'Posts do not contain' => esc_html__( 'Posts do not contain', 'acf' ),
'Has any post selected' => esc_html__( 'Has any post selected', 'acf' ),
'Has no post selected' => esc_html__( 'Has no post selected', 'acf' ),
'Has any relationship selected' => esc_html__( 'Has any relationship selected', 'acf' ),
'Has no relationship selected' => esc_html__( 'Has no relationship selected', 'acf' ),
'Page is equal to' => esc_html__( 'Page is equal to', 'acf' ),
'Page is not equal to' => esc_html__( 'Page is not equal to', 'acf' ),
'Pages contain' => esc_html__( 'Pages contain', 'acf' ),
'Pages do not contain' => esc_html__( 'Pages do not contain', 'acf' ),
'Has any page selected' => esc_html__( 'Has any page selected', 'acf' ),
'Has no page selected' => esc_html__( 'Has no page selected', 'acf' ),
'User is equal to' => esc_html__( 'User is equal to', 'acf' ),
'User is not equal to' => esc_html__( 'User is not equal to', 'acf' ),
'Users contain' => esc_html__( 'Users contain', 'acf' ),
'Users do not contain' => esc_html__( 'Users do not contain', 'acf' ),
'Has any user selected' => esc_html__( 'Has any user selected', 'acf' ),
'Has no user selected' => esc_html__( 'Has no user selected', 'acf' ),
'Term is equal to' => esc_html__( 'Term is equal to', 'acf' ),
'Term is not equal to' => esc_html__( 'Term is not equal to', 'acf' ),
'Terms contain' => esc_html__( 'Terms contain', 'acf' ),
'Terms do not contain' => esc_html__( 'Terms do not contain', 'acf' ),
'Has any term selected' => esc_html__( 'Has any term selected', 'acf' ),
'Has no term selected' => esc_html__( 'Has no term selected', 'acf' ),
// Custom Select2 templates.
'Type to search...' => esc_html__( 'Type to search...', 'acf' ),
'This Field' => esc_html__( 'This Field', 'acf' ),
)
);
acf_localize_data(
array(
'fieldTypes' => acf_get_field_types_info(),
'fieldCategoriesL10n' => acf_get_field_categories_i18n(),
'PROUpgradeURL' => acf_add_url_utm_tags( 'https://www.advancedcustomfields.com/pro/', 'ACF upgrade', 'field-type-selection' ),
'PROFieldTypes' => acf_get_pro_field_types(),
'PROLocationTypes' => array(
'block' => esc_html__( 'Block', 'acf' ),
'options_page' => esc_html__( 'Options Page', 'acf' ),
),
)
);
do_action( 'acf/field_group/admin_enqueue_scripts' );
}
/**
* Set up functionality for the field group edit page.
*
* @since 3.1.8
*/
public function admin_head() {
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' );
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.
*/
public function edit_form_after_title() {
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( '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 array $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
*/
public function admin_footer() {
$this->include_pro_features();
do_action( 'acf/field_group/admin_footer' );
}
/**
* Renders HTML for the ACF PRO features upgrade notice.
*/
public function include_pro_features() {
// Bail if on PRO.
if ( acf_is_pro() && acf_pro_is_license_active() ) {
return;
}
// Bail if not the edit field group screen.
if ( ! acf_is_screen( 'acf-field-group' ) ) {
return;
}
acf_get_view( 'acf-field-group/pro-features' );
}
/**
* 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 integer $columns Number of columns for layout.
* @return integer
*/
public function screen_layout( $columns = 0 ) {
return 1;
}
/**
* This function will customize the publish metabox
*
* @since 5.2.9
*/
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
}
/**
* Saves field group data.
*
* @since 1.0.0
*
* @param integer $post_id The post ID.
* @param WP_Post $post The post object.
* @return integer $post_id
*/
public function save_post( $post_id, $post ) {
if ( ! $this->verify_save_post( $post_id, $post ) ) {
return $post_id;
}
// disable filters to ensure ACF loads raw data from DB.
acf_disable_filters();
// save fields.
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Validated by WordPress.
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 ( acf_maybe_get_POST( '_acf_delete_fields', false ) ) { // phpcs:ignore -- Sanitized below, unslash not needed
// clean.
$ids = explode( '|', $_POST['_acf_delete_fields'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput -- Sanitized below, unslash not required.
$ids = array_map( 'intval', $ids );
// loop.
foreach ( $ids as $id ) {
// bai early if no id.
if ( ! $id ) {
continue;
}
// delete.
acf_delete_field( $id );
}
}
$_POST['acf_field_group']['ID'] = $post_id;
// phpcs:disable WordPress.Security.ValidatedSanitizedInput
$_POST['acf_field_group']['title'] = isset( $_POST['post_title'] ) ? $_POST['post_title'] : ''; // Post title is stored unsafe like WordPress, escaped on output.
// save field group.
acf_update_field_group( $_POST['acf_field_group'] );
// phpcs:enable WordPress.Security.ValidatedSanitizedInput
// phpcs:enable WordPress.Security.NonceVerification.Missing
return $post_id;
}
/**
* This function will render the HTML for the metabox 'acf-field-group-fields'
*
* @since 5.0.0
*/
public function mb_fields() {
global $field_group;
$view = array(
'fields' => acf_get_fields( $field_group ),
'parent' => 0,
);
acf_get_view( $this->post_type . '/fields', $view );
}
/**
* This function will render the HTML for the metabox 'acf-field-group-pro-features'
*
* @since 6.0.0
*/
public function mb_pro_features() {
acf_get_view( $this->post_type . '/pro-features' );
}
/**
* This function will render the HTML for the metabox 'acf-field-group-options'
*
* @since 5.0.0
*/
public function mb_options() {
global $field_group;
// Field group key (leave in for compatibility).
if ( ! acf_is_field_group_key( $field_group['key'] ) ) {
$field_group['key'] = uniqid( 'group_' );
}
acf_get_view( $this->post_type . '/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
*/
public function ajax_render_location_rule() {
// validate.
if ( ! acf_verify_ajax() ) {
die();
}
// verify user capability.
if ( ! acf_current_user_can_admin() ) {
die();
}
if ( empty( $_POST['rule'] ) ) {
die();
}
// validate rule.
$rule = acf_validate_location_rule( acf_sanitize_request_args( $_POST['rule'] ) ); //phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- values not saved.
acf_get_view(
'acf-field-group/location-rule',
array(
'rule' => $rule,
)
);
die();
}
/**
* This function will return HTML containing the field's settings based on it's new type
*
* @since 5.0.0
*/
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 = acf_get_combined_field_type_settings_tabs();
$tab_keys = array_keys( $tabs );
$sections = array();
foreach ( $tab_keys as $tab ) {
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/field_group/render_field_settings_tab/{$tab}/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 );
}
/**
* Moves fields between field groups via AJAX.
*
* @since 5.0.0
*
* @return void
*/
public function ajax_move_field() {
// Disable filters to ensure ACF loads raw data from DB.
acf_disable_filters();
// phpcs:disable WordPress.Security.NonceVerification.Missing
$args = acf_parse_args(
$_POST,
array(
'nonce' => '',
'post_id' => 0,
'field_id' => 0,
'field_group_id' => 0,
)
);
// phpcs:enable WordPress.Security.NonceVerification.Missing
// Verify nonce.
if ( ! wp_verify_nonce( $args['nonce'], 'acf_nonce' ) ) {
die();
}
// Verify user capability.
if ( ! acf_current_user_can_admin() ) {
die();
}
// Move the field if the user has confirmed.
if ( $args['field_id'] && $args['field_group_id'] ) {
$field = acf_get_field( $args['field_id'] );
$old_field_group = acf_get_field_group( $args['post_id'] );
$new_field_group = acf_get_field_group( $args['field_group_id'] );
// Update the field parent and remove conditional logic.
$field['parent'] = $new_field_group['ID'];
$field['conditional_logic'] = 0;
// Update the field in the database.
acf_update_field( $field );
// Fire `acf/update_field_group` action hook so JSON can sync if necessary.
do_action( 'acf/update_field_group', $old_field_group );
do_action( 'acf/update_field_group', $new_field_group );
// Output HTML.
$link = '<a href="' . admin_url( 'post.php?post=' . $new_field_group['ID'] . '&action=edit' ) . '" target="_blank">' . esc_html( $new_field_group['title'] ) . '</a>';
echo '' .
'<p><strong>' . esc_html__( '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">' . esc_html__( 'Close Modal', 'acf' ) . '</a>';
die();
}
// Get all field groups.
$field_groups = acf_get_field_groups();
$choices = array();
if ( ! empty( $field_groups ) ) {
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>' . esc_html__( 'Please select the destination for this field', 'acf' ) . '</p>';
echo '<form id="acf-move-field-form">';
acf_render_field_wrap( $field );
echo '<button type="submit" class="acf-btn">' . esc_html__( 'Move Field', 'acf' ) . '</button>';
echo '</form>';
die();
}
}