More API PHP scripts examples for updating different form fields

Hello Pawel,
Indeed, I have already been able to solve some things with the help of the API documentation.
But not all fields have the same characteristics and therefore I have a hard time updating e.g. a select field via API.
How are the select options entered into the appropriate array?
I thought using PHP code to study the script found the following would work but I cannot.

$form_id = 7;
$field_id = 'select-1';

$data = array(
	'id' 		=> 'select-1',
	'element_id'	=> 'select-1',
	'form_id' 	=> 'wrapper-1311247712118-1294',
    	"type"        	=> "select",
        "cols"     	=> "12",
        "required"    	=> "true",
        "value_type"  	=> "single",
        "field_label" 	=> "Make a selection",
        "placeholder" 	=> "Select an item",
       	"options"     	=> $options,
	);
               $options[] = array(
                    'label' 	=> "Label 1",
                    'value' 	=> "First item",
                    'limit' 	=> '',
                    'key'   	=> forminator_unique_key(),
                    'label' 	=> "Label 2",
                    'value' 	=> "Second item",
                    'limit' 	=> '',
                    'key'   	=> forminator_unique_key(),
                    'label' 	=> "Label 3",
                    'value' 	=> "Third item",
                    'limit' 	=> '',
                    'key'   	=> forminator_unique_key(),
                );
	
	$fields = Forminator_API::update_form_field( $form_id, $field_id, $data );

Can someone set up this example script correctly so that the existing select-1 field is modified or updated with new labels and also with new values? And of course be saved in the current form afterwards as well.
I don’t know if the key settings are needed and if this forminator_unique_key() function is needed?
Thanks in advance.
Kind Regards.

Hi Adam,
I have tried the folow script as MU plugin, but I receive a critical error and the website is not working.

<?php

$form_id = 1269;
$field_id = 'select-1';

private $options = array(
            'value-1'    => 'Label 1',
            'value-2'    => 'Label 2',
            'value-3'    => 'Label 3',
        );

$data = array(
	'id' 			=> 'select-1',
	'element_id'	=> 'select-1',
	'form_id' 		=> 'wrapper-1311247712118-1294',
    "type"        	=> "select",
    "cols"       	=> "12",
    required"    	=> "true",
    "value_type"  	=> "single",
    "field_label" 	=> "Make a selection",
    "placeholder" 	=> "Select an item",
    "options"     	=> $options,
	);
	
	$fields = Forminator_API::update_form_field( $form_id, $field_id, $data );
	

What did I wrong? Any suggestions, please?
Thanks in advance to help me with this PHP script.
Best Regards.

• This reply was modified 2 years, 6 months ago by alainmelsens.

Hi Pawel,
I know I closed this ticket, but I did have another question regarding such API PHP code scripts for e.g. the GDPR checkbox field.
In this field there is an extra small text editor where it is possible to modify a standard line of text with the following text:
“Yes, I agree with the privacy policy and terms and conditions”.
How can this be updated using an API script?
What are the Array elements in which variable data can be added?
Is this the right syntax to edit it?

$form_id = 1269;
$field_id = 'gdprcheckbox-1';

$data = array(
	'id' 			=> 'gdprcheckbox-1',
	'element_id'	=> 'gdprcheckbox-1',
	'form_id' 		=> 'wrapper-1311247712118-1094',
    "type"        	=> "gdprcheckbox",
    "cols"       	=> "12",
    "required"    	=> "true",
    "options"     	=> "This is GDPR phrase."
	);

	$fields = Forminator_API::update_form_field( $form_id, $field_id, $data );

This script that I have tried, is not working, but no error messages, either.
So, maybe the Array element that I have tried as “options” is not the good one.
Please, which is the array element I should use for this? Or maybe there are other elements also to add?
Thanks in advance.
Kind Regards.

Hi Patrick,
Yes, this is also working fine. Thank you very much.
I also want to be able to update the following primary field types via API.
This includes radio buttons and check buttons. Are the array elements the same as for a select field?
I don’t have some examples of these fields yet but I will test this either.
Anyway, thank you again for your fast and great support.
I will return soon with my experiences for radio and check buttons, if it will work also or not?
Best Regards,
Alain

Hi Patrick,

I also want to be able to update the following primary field types via API.
This includes radio buttons and check buttons. Are the array elements the same as for a select field?

No, I mean other primary form fields like the radio buttons and check buttons. This has nothing to do with my previous question for the GDPR field, as this has been resolved. For which I sincerely thank you again.

I just wanted to ask if any other radio button field or check buttons field also has the same options for this the same API – Array elements in the PHP code?
See example for radio buttons:

$form_id = 1269;
$field_id = 'radio-1';

$data = array(
	'id' 			=> 'radio-1',
	'element_id'	=> 'radio-1',
	'form_id' 		=> 'wrapper-1311247712118-1295',
    "type"        	=> "select",
    "cols"       	=> "12",
    "required"    	=> "true",
    "value_type"  	=> "single",
    "field_label" 	=> "Make a selection",
    "placeholder" 	=> "Select an item",
	   'options'     => array(
	    array(
		'label' => 'Option 1',
		'value' => 'one',
		'limit' => '',
	    ),
	    array(
		'label' => 'Option 2',
		'value' => 'two',
		'limit' => '',
	    ),
	),
);
	
	$fields = Forminator_API::update_form_field( $form_id, $field_id, $data );

And for check buttons, the follow example:

$form_id = 1269;
$field_id = 'check-1';

$data = array(
	'id' 			=> 'check-1',
	'element_id'	=> 'check-1',
	'form_id' 		=> 'wrapper-1311247712118-1296',
    "type"        	=> "select",
    "cols"       	=> "12",
    "required"    	=> "true",
    "value_type"  	=> "single",
    "field_label" 	=> "Make a selection",
    "placeholder" 	=> "Select an item",
	   'options'     => array(
	    array(
		'label' => 'Option 1',
		'value' => 'one',
		'limit' => '',
	    ),
	    array(
		'label' => 'Option 2',
		'value' => 'two',
		'limit' => '',
	    ),
	),
);
	
	$fields = Forminator_API::update_form_field( $form_id, $field_id, $data );

I didn’t have the time yet to check these examples but I guess is maybe that what I mean. Should this work for radio buttons and check buttons or is are there other options array elements that I need to wrote in the API code?
Thanks in advance.
Best Regards,
Alain