Checkbox "return_format" isn't working.

[voyou-sbeaulieu]

We are trying to get return format "array" from a checkbox but it's always output as value.

We tried this :

->addCheckbox('global_btn_style', ['label' => 'Styles possible','return_format'=>'array', 'allow_custom'=> true,'allow_null'=>false])
            ->addChoices(
                ['default' => COLORDEFAULT], 
                ['primary' => COLORPRIMARY],
                ['secondary' => COLORSECONDARY],
                ['danger' => 'danger'],
                ['text' => 'text'],
                ['link' => 'link']
            )
            ->setDefaultValue(['default','primary','secondary'])

And a simplier one :

->addCheckbox('checkbox_field', [
                'label' => 'Checkbox Field',
                'instructions' => '',
                'required' => 0,
                'conditional_logic' => 0,
                'wrapper' => [
                    'width' => '',
                    'class' => '',
                    'id' => '',
                ],
                'choices' => ['dsfsd'],
                'allow_custom' => 0,
                'save_custom' => 0,
                'default_value' => [],
                'layout' => 'vertical',
                'toggle' => 0,
                'return_format' => 'array',
            ]);

Both aren't working

edit formating

[voyou-sbeaulieu]

This is what build() is printing :

Array
(
    [key] => group_Configuration
    [title] => Configuration
    [fields] => Array
        (
            [0] => Array
                (
                    [type] => tab
                    [name] => options_des_boutons_tab
                    [label] => Options Des Boutons
                    [key] => field_configuration_options_des_boutons_tab
                    [placement] => left
                )

            [1] => Array
                (
                    [choices] => Array
                        (
                            [default] => Défaut (Bleu)
                            [primary] => Primaire (Rouge)
                            [secondary] => Secondaire (Gris)
                            [danger] => danger
                            [text] => text
                            [link] => link
                        )

                    [type] => checkbox
                    [name] => global_btn_style
                    [label] => Styles possible
                    [key] => field_configuration_global_btn_style
                    [return_format] => array
                    [allow_custom] => 1
                    [default_value] => Array
                        (
                            [0] => default
                            [1] => primary
                            [2] => secondary
                        )

                )

        )

    [location] => Array
        (
            [0] => Array
                (
                    [0] => Array
                        (
                            [param] => options_page
                            [operator] => ==
                            [value] => theme-general-settings
                        )

                )

        )

)

I tried from ACF as php directly and it's working fine :

if( function_exists('acf_add_local_field_group') ):

    acf_add_local_field_group(array(
        'key' => 'group_5cc354a579943',
        'title' => 'test',
        'fields' => array(
            array(
                'key' => 'field_5cc354a764332',
                'label' => 'checkbox',
                'name' => 'checkbox',
                'type' => 'checkbox',
                'instructions' => '',
                'required' => 0,
                'conditional_logic' => 0,
                'wrapper' => array(
                    'width' => '',
                    'class' => '',
                    'id' => '',
                ),
                'choices' => array(
                ),
                'allow_custom' => 1,
                'save_custom' => 0,
                'default_value' => array(
                ),
                'layout' => 'vertical',
                'toggle' => 0,
                'return_format' => 'array',
            ),
        ),
        'location' => array(
            array(
                array(
                    'param' => 'options_page',
                    'operator' => '==',
                    'value' => 'theme-general-settings',
                ),
            ),
        ),
        'menu_order' => 0,
        'position' => 'normal',
        'style' => 'default',
        'label_placement' => 'top',
        'instruction_placement' => 'label',
        'hide_on_screen' => '',
        'active' => true,
        'description' => '',
    ));
    
    endif;

[voyou-sbeaulieu]

Any news/update on this?

[stevep]

@voyou-sbeaulieu This is very weird considering the output looks correct when compared to the way acf itself outputs the field configuration.

I finally had a chance to try this locally:

$builder
    ->addCheckbox('global_btn_style', ['label' => 'Styles possible','return_format'=>'array', 'allow_custom'=> true,'allow_null'=>false])
    ->addChoices(
        ['default' => 'default'],
        ['primary' => 'primary'],
        ['secondary' => 'secondary'],
        ['danger' => 'danger'],
        ['text' => 'text'],
        ['link' => 'link']
    );

And when I call print_r(get_field('global_btn_style')); in the template it returns:

Array
(
    [0] => Array
        (
            [value] => default
            [label] => default
        )

    [1] => Array
        (
            [value] => primary
            [label] => primary
        )

    [2] => Array
        (
            [value] => secondary
            [label] => secondary
        )
)

So I'm not sure what is causing your issue. Is this the output that you would expect?

[voyou-sbeaulieu]

Your output looks good, yeah but mine isn't like you...

What I get is :

           

Array
(
    [0] => default
    [1] => primary
    [2] => secondary
    [3] => link
)

instead of :

Array
(
    [0] => Array
        (
            [value] => default
            [label] => Défaut (Bleu)
        )

    [1] => Array
        (
            [value] => primary
            [label] => Primaire (Rouge)
        )

    [2] => Array
        (
            [value] => secondary
            [label] => Secondaire (Gris)
        )
...
)

Not sure why and we have multiple checkboxes with return value at "array" and none are working... no clue why. Just to add we are using tho in backend not frontend. We create a params configuration in the options ACF page and use it to fill the backend page ACF fields.

Fields create in the options page

<?php 
namespace App;

use StoutLogic\AcfBuilder\FieldsBuilder;

$config = (object) [
    'ui' => 1,
    'wrapper' => ['width' => 30],
];

$button = new FieldsBuilder('admin_params_btn');

$button
...
->addCheckbox('admin_btn_style', [
      'label' => 'Styles possible', 
      'return_format' => 'array', 
      'wrapper' => $config->wrapper,
      'allow_custom'=> true]
      )
      ->addChoices(
        ['default' => COLORDEFAULT], 
        ['primary' => COLORPRIMARY],
        ['secondary' => COLORSECONDARY],
        ['danger' => 'danger'],
        ['text' => 'text'],
        ['link' => 'link']
      )
      ->setDefaultValue(['default','primary','secondary'])
...

Fields create in the page getting data from the options page configuration

$btn_style = get_field('admin_btn_style', 'options'); // Where we get the value wrong
if($btn_style) $btn_style = clean_from_options($btn_style);

$config = (object) [
   'btn_style' => $btn_style ?? [],
];

$btn_style = new FieldsBuilder('btn_style');

if(isset($btn_type)){
	$btn_style->addButtonGroup('btn_style', ['label' => 'Style du bouton'])
	->addChoices(
		$config->btn_style
	)
	->setDefaultValue('secondary')
	->conditional('btn_option', '==', '1');
}

Maybe this could be why? We also have problem with group used this way ...

For exemple, if we had a group create in the options pages like so :

->addGroup('admin_params_btn',['label' => 'Options des boutons'])
    ->addCheckbox('admin_btn_type', [
      'label' => 'Types possible', 
      'return_format' => 'array', 
      'wrapper' => $config->wrapper,
      'allow_custom'=> true]
      )
      ->addChoices(
          ['internal' => 'Lien interne'], 
          ['external' => 'Lien externe'],
          ['lightbox' => 'Lightbox']
      )
      ->setDefaultValue(['internal','external'])
....

And then do $btn_type = get_field('admin_params_btn', 'options'); to create a button group in the backend the value would be reset everything preventing us from updating the options page. As soon as we removed the code from the get_field('admin_params_btn', 'options'); from the FieldsBuilder, then options was saving correctly again.. I could send you some files in private if this can help you a bit to understand..

Weird thing is, we create this from ACF fields directly because using ACF builder and everything was working. So it's not against ACF logics...

Thank for your time.

[voyou-sbeaulieu]

Hi, I know this is kinda old now but we figured out why this is happening ... (kinda)

We are having a problem with the return_format only when it's called in the WordPress backend. So my guess is all functionality isn't fully loaded?

We are calling the fields based on this logic: https://roots.io/guides/using-acf-builder-with-sage/

And calling like so:

add_action('init', function () {
    collect(glob(config('theme.dir').'/app/fields/*.php'))->map(function ($field) {
        return require_once($field);
    })->map(function ($field) {
        if ($field instanceof FieldsBuilder) {
            acf_add_local_field_group($field->build());
        }
    });
});

We then setup value inside an ACF 'option' page and use those option in our WordPress backend.

For example, in the options page, we can setup, "button style" and then use the result on the options field to create select value/label in an other ACF field builder. We know this is kinda "unique" but we tried with ACF directly and the return value was working properly so I guess there something that doesn't pass information from ACF-builder.

If you need more code sample/example to replicate feel free to ask.

[darisi]

Having the same issue on a options page select in backend. @voyou-sbeaulieu did you found a soliution to this?

I'm also using the sage acf example.