class-deodar.php

File: lib/class-deodar.php
Package: Deodar
Since: 2.0.0
Author: Brock Cataldi

Overview

The main Deodar class is the core of the plugin, handling initialization, configuration, and WordPress hook registration. It provides a modular foundation for WordPress development with ACF Pro integration.

Class Declaration

class Deodar

Properties

Public Properties

`$name`

public string $name = '';

The name of the source (basically the folder name of the plugin or theme).

`$path_base`

public string $path_base = '';

The file path location of the source.

`$path_blocks_dir`

public string $path_blocks_dir = '';

The directory path of /blocks/.

`$path_acf_blocks_dir`

public string $path_acf_blocks_dir = '';

The directory path of /blocks/acf/.

`$path_includes_dir`

public string $path_includes_dir = '';

The directory path of /includes/.

`$path_field_groups_dir`

public string $path_field_groups_dir = '';

The directory path of /includes/field-groups/.

`$path_post_types_dir`

public string $path_post_types_dir = '';

The directory path of /includes/post-types/.

`$path_taxonomies_dir`

public string $path_taxonomies_dir = '';

The directory path of /includes/taxonomies/.

`$path_options_pages_dir`

public string $path_options_pages_dir = '';

The directory path of /includes/options-pages/.

`$url_base`

public string $url_base = '';

The URL location of the source.

`$url_blocks_dir`

public string $url_blocks_dir = '';

The URL path of /blocks/.

`$configured`

public bool $configured = false;

Whether or not the source is bound and configured.

`$production`

public bool $production = false;

Whether or not the source is in production mode (affects caching).

`$menus`

public array $menus = array();

Associative array of menus to be registered.

`$scripts`

public array $scripts = array();

Array of Deodar_Script objects bound to the source.

`$styles`

public array $styles = array();

Array of Deodar_Style objects bound to the source.

`$supports`

public array $supports = array();

Array of Deodar_Support objects bound to the source.

Private Properties

`$transient_acf_blocks`

private string $transient_acf_blocks = 'deodar_paths_acf_blocks';

The transient name for the ACF block paths.

`$transient_walkers`

private string $transient_walkers = 'deodar_paths_walkers';

The transient name for the walker paths.

`$transient_customizations`

private string $transient_customizations = 'deodar_paths_customizations';

The transient name for the customization paths.

`$transient_styles_blocks`

private string $transient_styles_blocks = 'deodar_styles_blocks';

The transient name for the block styles.

`$paths_acf_blocks`

private null|array $paths_acf_blocks = null;

Cached ACF block paths.

`$paths_walkers`

private null|array $paths_walkers = null;

Cached walker paths.

`$paths_customizations`

private null|array $paths_customizations = null;

Cached customization paths.

`$styles_blocks`

private null|array $styles_blocks = null;

Cached block styles.

Methods

Constructor

`__construct()`

public function __construct()

Since: 2.0.0
Returns: void

Empty constructor meant to be empty, as it's not needed.

Public Methods

`bind()`

public function bind()

Since: 2.0.0
Returns: void

Binds all necessary WordPress hooks and filters:

acf/json/save_file_name - Custom ACF JSON file naming
acf/json/save_paths - ACF JSON save path configuration
acf/settings/load_json - ACF JSON loading paths
get_block_type_variations - Block variations support
admin_enqueue_scripts - Admin script/style enqueuing
after_setup_theme - Theme setup and configuration
customize_register - WordPress customizer registration
init - WordPress initialization
wp_enqueue_scripts - Frontend script/style enqueuing

`save_file_name($filename, $post)`

public function save_file_name($filename, $post)

Since: 2.0.0
Parameters:

string $filename - The current filename
array $post - The field group data

Returns: string - The sanitized filename

Hook: acf/json/save_file_name

Customizes ACF JSON file naming with the following priority:

If location is set and has a single location rule, uses the location value as the filename
Falls back to the sanitized field group title
Returns the original filename if neither is available

`save_paths($paths, $post)`

public function save_paths($paths, $post)

Since: 2.0.0
Parameters:

array $paths - The paths to save to
array $post - The field group data

Returns: array - The save location

Hook: acf/json/save_paths

Determines where ACF JSON files should be saved based on field group type and location rules.

`load_json($paths)`

public function load_json($paths)

Since: 2.0.0
Parameters:

array $paths - The default load paths

Returns: array - The load paths

Hook: acf/settings/load_json

Configures ACF JSON loading paths for field groups, post types, taxonomies, and options pages.

`admin_enqueue_scripts()`

public function admin_enqueue_scripts()

Since: 2.0.0
Returns: void

Hook: admin_enqueue_scripts

Enqueues all registered styles and scripts for the admin area.

`after_setup_theme()`

public function after_setup_theme()

Since: 2.0.0
Returns: void

Hook: after_setup_theme

Handles theme setup including:

Configuration from filter data
Walker loading
Theme support registration
Menu registration
Block style enqueuing

`customize_register($wp_customize)`

public function customize_register(WP_Customize_Manager $wp_customize)

Since: 2.0.0
Parameters:

WP_Customize_Manager $wp_customize - The WordPress customizer manager

Returns: void

Hook: customize_register

Registers all customizer customizations.

`init()`

public function init()

Since: 2.0.0
Returns: void

Hook: init

Registers all ACF block types.

`wp_enqueue_scripts()`

public function wp_enqueue_scripts()

Since: 2.0.0
Returns: void

Hook: wp_enqueue_scripts

Enqueues all registered styles and scripts for the frontend.

`get_block_type_variations($variations, $block_type)`

public function get_block_type_variations($variations, $block_type)

Since: 2.0.0
Parameters:

array $variations - The variations
array $block_type - The block type

Returns: array - The variations

Hook: get_block_type_variations

Handles block variations support by loading variation files for registered blocks.

Private Methods

`configure_if_not_configured()`

private function configure_if_not_configured(): void

Since: 2.0.0
Returns: void

Configures the source if not already configured by applying the deodar filter.

`configure($data)`

private function configure($data)

Since: 2.0.0
Parameters:

array $data - Deodar config array

Returns: void
Throws: InvalidArgumentException - If path and url aren't set

Configures the Deodar instance with provided data, setting up all paths, URLs, and hydrating objects.

`hydrate($items, $class_name)`

private function hydrate(array $items, string $class_name): array

Since: 2.0.0
Parameters:

array $items - The config data to hydrate
string $class_name - The class to hydrate the data to

Returns: array - The hydrated data

Converts configuration arrays into object instances.

`get_paths_acf_blocks()`

private function get_paths_acf_blocks()

Since: 2.0.0
Returns: string[] - Array of ACF block paths

Returns all directories in the /blocks/acf/ path, cached for performance.

`get_block_styles()`

private function get_block_styles(): array

Since: 2.0.0
Returns: array - Array of Deodar_Block_Style objects

Creates and caches Deodar_Block_Style objects for all discovered blocks.

`get_customizations()`

private function get_customizations(): array

Since: 2.0.0
Returns: array - Array of loaded customizations

Loads and caches customizations within the includes/customizations folder.

`get_walkers()`

private function get_walkers(): array

Since: 2.0.0
Returns: array - Array of loaded walkers

Returns all of the walkers within the walkers folder.

Usage Example

// The plugin automatically instantiates and binds
$deodar = new Deodar();
$deodar->bind();

Configuration

The class is configured via the deodar filter:

add_filter('deodar', function($data) {
    return [
        'path' => get_template_directory(),
        'url' => get_template_directory_uri(),
        'production' => true, // Enable caching in production
        'menus' => [
            'primary' => 'Primary Menu',
            'footer' => 'Footer Menu'
        ],
        'styles' => [
            [
                'handle' => 'main-style', 
                'file' => '/css/main.css',
                'dependencies' => [],
                'version' => '1.0.0',
                'media' => 'all',
                'frontend' => true,
                'backend' => false
            ]
        ],
        'scripts' => [
            [
                'handle' => 'main-script', 
                'file' => '/js/main.js',
                'dependencies' => ['jquery'],
                'version' => '1.0.0',
                'args' => true, // Load in footer
                'frontend' => true,
                'backend' => false
            ]
        ],
        'supports' => [
            'post-thumbnails',
            [
                'feature' => 'custom-logo', 
                'args' => ['height' => 100, 'width' => 100]
            ]
        ]
    ];
});

Deodar_Script - Script management
Deodar_Style - Style management
Deodar_Support - Theme support management
Deodar_Block_Style - Block style management
Deodar_Customization - Customizer management

Overview​

Class Declaration​

Properties​

Public Properties​

$name​

$path_base​

$path_blocks_dir​

$path_acf_blocks_dir​

$path_includes_dir​

$path_field_groups_dir​

$path_post_types_dir​

$path_taxonomies_dir​

$path_options_pages_dir​

$url_base​

$url_blocks_dir​

$configured​

$production​

$menus​

$scripts​

$styles​

$supports​

Private Properties​

$transient_acf_blocks​

$transient_walkers​

$transient_customizations​

$transient_styles_blocks​

$paths_acf_blocks​

$paths_walkers​

$paths_customizations​

$styles_blocks​

Methods​

Constructor​

__construct()​

Public Methods​

bind()​

save_file_name($filename, $post)​

save_paths($paths, $post)​

load_json($paths)​

admin_enqueue_scripts()​

after_setup_theme()​

customize_register($wp_customize)​

init()​

wp_enqueue_scripts()​

get_block_type_variations($variations, $block_type)​

Private Methods​

configure_if_not_configured()​

configure($data)​

hydrate($items, $class_name)​

get_paths_acf_blocks()​

get_block_styles()​

get_customizations()​

get_walkers()​

Usage Example​

Configuration​

Related Classes​

Overview

Class Declaration

Properties

Public Properties

`$name`

`$path_base`

`$path_blocks_dir`

`$path_acf_blocks_dir`

`$path_includes_dir`

`$path_field_groups_dir`

`$path_post_types_dir`

`$path_taxonomies_dir`

`$path_options_pages_dir`

`$url_base`

`$url_blocks_dir`

`$configured`

`$production`

`$menus`

`$scripts`

`$styles`

`$supports`

Private Properties

`$transient_acf_blocks`

`$transient_walkers`

`$transient_customizations`

`$transient_styles_blocks`

`$paths_acf_blocks`

`$paths_walkers`

`$paths_customizations`

`$styles_blocks`

Methods

Constructor

`__construct()`

Public Methods

`bind()`

`save_file_name($filename, $post)`

`save_paths($paths, $post)`

`load_json($paths)`

`admin_enqueue_scripts()`

`after_setup_theme()`

`customize_register($wp_customize)`

`init()`

`wp_enqueue_scripts()`

`get_block_type_variations($variations, $block_type)`

Private Methods

`configure_if_not_configured()`

`configure($data)`

`hydrate($items, $class_name)`

`get_paths_acf_blocks()`

`get_block_styles()`

`get_customizations()`

`get_walkers()`

Usage Example

Configuration

Related Classes