acf-sync.php

<?php
/*
Plugin Name: ACF Sync
Plugin URI: https://github.com/FreshFlesh/ACF-Sync
Description: Keep your ACF field groups synchronized between different environments
Version: 1.1.2
Author: Thomas Charbit
Author URI: https://twitter.com/thomascharbit
Author Email: thomas.charbit@gmail.com
*/


if ( ! defined( 'WPINC' ) ) {
    die;
}

class ACFSync {


    /*--------------------------------------------*
     * Constructor
     *--------------------------------------------*/


    /**
     * Initializes the plugin
     */

    function __construct() {
        
        // Sync fields on admin_init if needed
        add_action( 'admin_init', array( $this, 'check_acf_fields_version' ) );

        // Load plugin text domain
        add_action( 'admin_init', array( $this, 'plugin_textdomain' ) );
        
        // Add Admin UI for manual sync
        add_action('admin_footer', array( $this, 'render_admin_view' ) );

        // Handle Admin form
        add_action( 'admin_post_acf-manual-sync', array( $this, 'manual_sync_action' ) );

        // Admin notices
        add_action( 'admin_notices', array( $this, 'admin_notices' ) );

        // On prod or staging, let ACF simply read fields from JSON
        if ( defined( 'WP_ENV' ) && 'development' != WP_ENV ) {

            // Don't save fields to JSON
            add_filter( 'acf/settings/save_json', '__return_null', 99 );
            
            // Don't show ACF UI
            add_filter( 'acf/settings/show_admin', '__return_false' );
        }


    } // end constructor


    /**
     * Loads the plugin text domain for translation
     */

    public function plugin_textdomain() {

        $domain = 'acfsync';
        $locale = apply_filters( 'plugin_locale', get_locale(), $domain );

        load_textdomain( $domain, WP_LANG_DIR.'/'.$domain.'/'.$domain.'-'.$locale.'.mo' );
        
        if ( false !== strpos( __FILE__, basename( WPMU_PLUGIN_DIR ) ) ) {
            load_muplugin_textdomain( $domain, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
        }
        else {
            load_plugin_textdomain( $domain, FALSE, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
        }

        

    } // end plugin_textdomain


    /*--------------------------------------------*
     * Core Functions
     *--------------------------------------------*/


    /*
     *  check_acf_fields_version
     *
     *  Compare fields version and import newer version if needed
     *
     *  @param   n/a
     *  @return  n/a
     */
    
    public function check_acf_fields_version() {

        if ( defined( 'ACF_FIELDS_VERSION' ) && acf_get_setting('json') ) {

            $db_version = get_option( 'acf_fields_version' );

            // Import fields from local JSON if they are newer than in DB
            if ( version_compare( ACF_FIELDS_VERSION, $db_version ) > 0 ) {

                $success = $this->import_json_field_groups();

                if ( $success ) {
                    update_option( 'acf_fields_version', ACF_FIELDS_VERSION );
                }

            }

        }

    }


    /*
     *  render_admin_view
     *
     *  Render admin form on ACF settings-export page
     *
     *  @param   n/a
     *  @return  n/a
     */

    public function render_admin_view() {
        
        if ( !acf_get_setting('json') ) return;

        include( 'admin/views/json-import.php' );

    }

    /*
     *  manual_sync_action
     *
     *  Validate form data and import field groups
     *
     *  @param   n/a
     *  @return  n/a
     */

    public function manual_sync_action() {

        if ( ! wp_verify_nonce( $_POST[ '_acfnonce' ], 'acfsync' ) ) {
            die( 'Invalid nonce.' );
        }

        $success = $this->import_json_field_groups();

        if ( $success ) {
            if ( defined( 'ACF_FIELDS_VERSION' ) ) {
                update_option( 'acf_fields_version', ACF_FIELDS_VERSION );
            }
        }

        $url = add_query_arg(  array( 'fields-sync' => $success ), $_SERVER['HTTP_REFERER'] );

        wp_safe_redirect( $url );

        exit;

    }


    /*
     *  admin_notices
     *
     *  Display relevant admin notice after manual import 
     *
     *  @param   n/a
     *  @return  n/a
     */

    public function admin_notices() {

        if ( !isset( $_GET['fields-sync']) ) return;

        if ( $_GET['fields-sync'] == true ) {
            echo '<div class="updated"><p>' . esc_html__( 'Field groups updated !', 'acfsync' ) . '</p></div>';
        }
        else {
            echo '<div class="error"><p>' . esc_html__( 'Sorry, unable to sync your field groups. Make sure you have the local JSON feature enabled and that your JSON folder is readable.', 'acfsync' ) . '</p></div>';
        }

    }


    /*
     *  import_json_field_groups
     *
     *  Parse json load points paths and import all JSON files
     *
     *  @param   n/a
     *  @return  bool
     */

    private function import_json_field_groups() {

        if ( !acf_get_setting('json') ) return false;

        // Check if JSON paths are readable
        $json_paths = acf_get_setting('load_json');

        foreach ($json_paths as $json_path) {
            if ( !is_readable( $json_path ) ) {
                return false;
            }
        }

        // Tell ACF NOT to save to local JSON while we delete groups in DB
        add_filter('acf/settings/save_json', '__return_null', 99 );

        // Remove previous field groups
        $args = array(
            'post_type'      => 'acf-field-group',
            'post_status'    => 'any',
            'posts_per_page' => -1
        );

        $query = new WP_Query( $args );

        foreach ( $query->posts as $acf_group ) {
            wp_delete_post( $acf_group->ID, true);
        }

        // Parse local JSON load points directories
        foreach ($json_paths as $json_path) {

            $dir = new DirectoryIterator( $json_path );

            foreach( $dir as $file ) {
                
                if ( !$file->isDot() && 'json' == $file->getExtension() ) {

                    $json = json_decode( file_get_contents( $file->getPathname() ), true );
                    $this->import_json_field_group( $json );

                }

            }

        }

        return true;

    }


    /*
     *  import_json_field_group
     *
     * import ACF field group from JSON data
     *
     *  @param   $json (array)
     *  @return  n/a
     */

    private function import_json_field_group( $json ) {
        
        // What follows is basically a copy of import() in ACF admin/settings-export.php

        // if importing an auto-json, wrap field group in array
        if( isset($json['key']) ) {
            $json = array( $json );
        }
        
        // vars
        $added   = array();
        $ignored = array();
        $ref     = array();
        $order   = array();
        
        foreach( $json as $field_group ) {
            
            // remove fields
            $fields = acf_extract_var($field_group, 'fields');
         
            // format fields
            $fields = acf_prepare_fields_for_import( $fields );

            // save field group
            $field_group = acf_update_field_group( $field_group );

            // add to ref
            $ref[ $field_group['key'] ] = $field_group['ID'];
            
            // add to order
            $order[ $field_group['ID'] ] = 0;
            
            
            // add fields
            foreach( $fields as $field ) {
                
                // add parent
                if( empty($field['parent']) ) {
                    
                    $field['parent'] = $field_group['ID'];
                    
                } elseif( isset($ref[ $field['parent'] ]) ) {
                    
                    $field['parent'] = $ref[ $field['parent'] ];
                        
                }
                
                // add field menu_order
                if( !isset($order[ $field['parent'] ]) ) {
                    
                    $order[ $field['parent'] ] = 0;
                    
                }
                
                $field['menu_order'] = $order[ $field['parent'] ];
                $order[ $field['parent'] ]++;
                
                // save field
                $field = acf_update_field( $field );

                // add to ref
                $ref[ $field['key'] ] = $field['ID'];
                
            }
            
        }
    }

}

new ACFSync();