Dev Notes

Various Cheat Sheets and Resources by David Egan/Carawebs.

Convert ACF Fields Registered by PHP to Importable JSON Format


ACF, PHP, WordPress
David Egan

When using the WordPress Advanced Custom Fields plugin, you may need to switch between PHP registered custom fields and JSON registered fields.

Use Case

In older projects we registered ACF fields by importing to PHP. This is good for the deployed site - the fields load quicker, and users can’t amend the fields.

This can be problematic if you import a production database into a local development environment. The fields are not registered in the production database. When you import it, you no longer have access to the fields in the ACF GUI. The fields still exist (they are registered by PHP functions), but you can’t use the nifty ACF interface to edit them.

Because of this we have switched to ACFs local JSON option. ACF writes the field registration data in JSON format to a server-writable directory (acf-json, unless you override the default) in the theme root. You end up with a separate JSON file for each field group. The JSON configuration files can go into your version control system. You can deploy to staging or production, and if you accidentally delete files in your dev environment (for example, if you import a database) you can easily re-sync the JSON files to have them show up in the ACF GUI again.

If you have your fields registered by PHP (not in the database), how do you switch to the local JSON workflow?

  1. Create a JSON configuration file that can be read by the ACF “Import” function - i.e. mimic the output of the ACF “Export” function
  2. Create acf-json in your theme root and run sudo chown www-data acf-json
  3. Import the JSON file to ACF

Creating the JSON File for Import

The following quick and dirty method is suitable for a local development environment:

  1. Drop the code below into a suitable template
  2. Create a suitable config file - touch acf-import.json and make it server-writable
  3. Hit the page template in your browser - you’ll see the JSON data output, and this will be written to the config file
  4. Import the config file: within the ACF “Tools” > “Import Field Groups” interface, select the file and click import

The field configurations are now held in the local database, and will be saved in the acf-json directory.

<?php

$groups = acf_get_local_field_groups();
$json = [];

foreach ($groups as $group) {
    // Fetch the fields for the given group key
    $fields = acf_get_local_fields($group['key']);

    // Remove unecessary key value pair with key "ID"
    unset($group['ID']);

    // Add the fields as an array to the group
    $group['fields'] = $fields;

    // Add this group to the main array
    $json[] = $group;
}

$json = json_encode($json, JSON_PRETTY_PRINT);
// Optional - echo the JSON data to the page
echo "<pre>";
echo $json;
echo "</pre>";

// Write output to file for easy import into ACF.
// The file must be writable by the server process. In this case, the file is located in
// the current theme directory.
$file = get_template_directory() . '/acf-import.json';
file_put_contents($file, $json );

?>

comments powered by Disqus