Reply To: Include ACF to my plugin

• sixtyseven

• November 12, 2019 at 9:41 pm

Very good idea, Keith. I bundeled this into a separate class that I can easily use in the plugin boilerplate. Assuming you have the ACF files in a folder “acf” in a directory “lib”:

<?php
// Exit if accessed directly
if ( !defined( 'ABSPATH' ) )exit;

/**
 * Integrate ACF if needed
 *
 * @author     André R. Kohl <[email protected]>
 */

class ss_acf_integrate {
	/**
	 * The unique identifier of this plugin.
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $plugin_name    The string used to uniquely identify this plugin.
	 */
	protected $plugin_name = '';

	/**
	 * The current version of the plugin.
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $version    The current version of the plugin.
	 */
	protected $version = '1.0.0';
	
	/**
	 * The modus of ACF: Either "installed" if found as a plugin, "bundeled" when used via include ore false if not found
	 *
	 * @since    1.0.0
	 * @access   public static
	 * @var      string    $acf_modus    The used modus.
	 */
	public static $acf_modus;
	
	/**
	 * The path to the bundeled ACF
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $acf_dir    The path to the folder.
	 */
	protected $acf_dir;
	
	/**
	 * The URL to the bundeled ACF
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $acf_url    The url to the folder.
	 */
	protected $acf_url;
	
	/**
	 * The path to the json files
	 *
	 * @since    1.0.0
	 * @access   protected
	 * @var      string    $acf_json    The path to the folder.
	 */
	protected $acf_json;
	

	/**
	 * Initialize the class and set its properties.
	 *
	 * @since    1.0.0
	 * @var      string $name The name of this plugin.
	 * @var      string $version The version of this plugin.
	 */
	public function __construct( $name = false, $version = false ) {
		
		if($name){
			$this->plugin_name = $name;
		}
		
		if($version){
			$this->plugin_version = $version;
		}
		
		$this->acf_dir = plugin_dir_path( dirname( __FILE__ ) ) .'lib/acf/';
		$this->acf_url = plugin_dir_url( dirname( __FILE__ ) ) .'lib/acf/';
		$this->acf_json = plugin_dir_path( dirname( __FILE__ ) ) .'lib/acf_json/';
		
		if(is_dir ( $this->acf_json )) {
			if(!is_writable($this->acf_json )){
				chmod($this->acf_json , '777');
			}
		} else {
			mkdir($this->acf_json, 0777, true);
		}

		
		if ( class_exists('acf') ){
			self::$acf_modus = 'installed';
		} else if(file_exists($this->acf_dir.'acf.php')) {
			self::$acf_modus = 'bundeled';
		} else {
			self::$acf_modus = false;
		}

		$this->init();
	}
	
	/**
	 * Initiate the integration
	 *
	 * @since    1.0.0
	 */
	private function init(){
		if(!self::$acf_modus){
			return;
		}
		
		if ( 'bundeled' === self::$acf_modus ) {
			// Customize ACF path
			add_filter('acf/settings/path', array($this, 'acf_settings_path'));
			
			// Customize ACF URL
			add_filter('acf/settings/dir', array($this, 'acf_settings_dir'));
			
			// Stop ACF upgrade notifications
  			add_filter( 'site_transient_update_plugins', array($this, 'stop_acf_update_notifications' ), 11);
			
			 // Create JSON save point
  			add_filter('acf/settings/save_json', array($this,'acf_json_save_point'));
			
			// Include ACF
			require_once( $this->acf_dir . 'acf.php' );
			
		}
		
		// Show/Hide ACF admin based on config
		if(defined('ACF_SHOW_ADMIN') && false === ACF_SHOW_ADMIN){
			add_filter('acf/settings/show_admin', '__return_false');
		}
		
		// Create a json load point
		add_filter('acf/settings/load_json', array($this, 'acf_json_load_point'));
	}
	
	/**
	 * Filters the path to the ACF folder
	 *
	 * @since    1.0.0
	 */
	public function acf_settings_path( $path ) {
		$path = $this->acf_dir ;
		return $path;
	}
	
	/**
	 * Filters the URL to the ACF folder
	 *
	 * @since    1.0.0
	 */
	public function acf_settings_dir( $path ) {
		$path = $this->acf_url ;
		return $path;
	}
	
	/**
	 * Stops the upgrade notifications of ACF
	 *
	 * @since    1.0.0
	 */
	public function stop_acf_update_notifications( $value ) {
		unset( $value->response[ $this->acf_dir . 'acf.php' ] );
		return $value;
	}
	
	/**
	 * Creates a json load point
	 *
	 * @since    1.0.0
	 */
	public function acf_json_load_point( $paths ) {
	  $paths[] = $this->acf_json_load;
	  return $paths;
	}
	
	/**
	 * Creates a json save point
	 *
	 * @since    1.0.0
	 */
	public function acf_json_save_point( $path ) {
		$path = $this->acf_json_save;
		return $path;
	}
	
	/**
	 * Returns the current value of acf_modus for use in plugins or themes
	 *
	 * @since    1.0.0
	 */
	public static function acf_modus() {
		return self::$acf_modus;
	}
}

Call this class in the function load_dependencies() like this:

/**
* The class for integrating ACF
*/
if ( !class_exists( 'ss_acf_integrate ' ) ) {
	require_once  plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-ss_acf_integrate.php';
	new ss_acf_integrate( $this->get_plugin_name(), $this->get_version() );
}

I decided to have a little switch to enable/disable the ACF admin. In your wp-config.php add

// ACF Admin
define ('ACF_SHOW_ADMIN', true);

where obviously true means show the ACF admin and false means hide it.

Thanks again for your fantastic starting point.