boxybird/atomic

Atomic integrates HTMX fragments into WordPress, enabling dynamic partial page updates without full reloads.

v1.0.0-beta.3 2025-02-20 17:41 UTC

Requires

• php: >=8.2
• illuminate/encryption: ^11.41

Requires (Dev)

• pestphp/pest: ^3.7

MIT

• Andrew Rhyand

• php
• plugin
• wordpress
• router
• fragments
• htmx

README

Atomic integrates HTMX fragments into WordPress, enabling dynamic partial page updates without full reloads.

Installation

composer require boxybird/atomic

Location: /wp-config.php

define('ATOMIC_ENCRYPTION_KEY', 'SOME_RANDOM_16_CHARACTER_STRING');

Theme/Plugin Setup

Whether you're installing this package in a theme or plugin, you must define base URL of the install.

// Theme example:
require_once __DIR__.'/vendor/autoload.php';
BoxyBird\Atomic\Atomic::init(get_stylesheet_directory_uri());

// Plugin example:
require_once __DIR__.'/vendor/autoload.php';
BoxyBird\Atomic\Atomic::init(plugin_dir_url(__FILE__));

Flush Permalinks

Location: /wp-admin/options-permalink.php

Visit and refresh permalinks by clicking "Save Changes" button

Usage

<button hx-get="/atomic/v1/my-hook" hx-target="#results">GET REQUEST</button>
<div id="results"></div>

add_action('atomic/get/my-hook', function (int $post_id) {
    echo "<p>HTMX GET request fragment - ID: {$post_id}</p>";
});

<button hx-get="/atomic/v1/my-other-hook" hx-target="#results">GET REQUEST</button>
<div id="results"></div>

add_action('atomic/get/my-other-hook', function (int $post_id) {
    echo "<p>HTMX GET request fragment - ID: {$post_id}</p>";
});

<button hx-post="/atomic/v1/my-hook" hx-target="#results">POST REQUEST</button>
<div id="results"></div>

add_action('atomic/post/my-hook', function (int $post_id) {
    get_template_part('fragments/post', 'my-template', args: ['post_id' => $post_id]);
});

<button hx-put="/atomic/v1/my-hook">PUT REQUEST</button>
<button hx-patch="/atomic/v1/my-hook">PATCH REQUEST</button>
<button hx-delete="/atomic/v1/my-hook">DELETE REQUEST</button>

add_action('atomic/put/my-hook', ...);
add_action('atomic/patch/my-hook', ...);
add_action('atomic/delete/my-hook', ...);