Documentation
Developers Doc
Folder Structure
Knowing where each subsystem lives is the fastest way to find the class, hook, or template you need to work…
Plugin Architecture & Lifecycle
Havenlytics is a real-estate plugin for WordPress built around a single, predictable entry point and a service-oriented core. This guide…
Bootstrap Process
The Havenlytics bootstrap process is deterministic: the same ordered sequence runs on every request, from the entry file's procedural setup…
Service Container
Havenlytics wires its subsystems together through a lightweight service container rather than global state. Two objects cooperate: the HvnlyNab singleton holds a…
Custom Post Types: Property, Agent & the Data Layer
Havenlytics stores its two primary content entities as WordPress custom post types: hvnly_property (listings) and hvnly_agent (real-estate agents). This reference documents how each CPT…
AJAX API: The Complete admin-ajax Reference
Alongside its REST API, Havenlytics uses WordPress's classic admin-ajax.php transport for a specific set of interactions: frontend property search and map rendering, the…
REST API: The Complete Developer Reference
The Havenlytics REST API exposes two independent namespaces. hvnlynab/v1 powers the admin experience — plugin settings, the drag-and-drop builders, analytics, meta cleanup, and plugin…
Security: A Developer's Guide to Nonces, Capabilities & Tokens
Security in Havenlytics is not an afterthought bolted onto a few handlers — it is a set of consistent conventions applied across…
Cache Management: A Developer's Guide
Havenlytics cache management spans several layers — a central transient facade, an engine cache, and multiple object-cache groups — all gated…
Shortcodes: The Complete Developer Reference
Havenlytics shortcodes render property archives, grids, lists, featured listings, agent and agency directories, and the Agent Workspace SPA anywhere WordPress accepts…
Builder System: The Two Drag-and-Drop Builders
The Havenlytics Builder System is made of exactly two drag-and-drop builders, each backed by its own PHP class, REST endpoints, and WordPress option. The…
Elementor Integration: Widgets & Developer Guide
Havenlytics ships a first-class Elementor integration that registers a dedicated widget category and three property widgets. This guide documents how the integration…
Email System: Developer Guide to Transactional Email
The Havenlytics email system is the transactional email layer that powers property-import confirmations, listing-workflow notifications, agent inquiry messages, workspace account mail, and…
Helper Functions: The Global hvnly Developer Reference
Havenlytics ships a large library of global helper functions — procedural PHP functions prefixed hvnly_ — that give theme and plugin developers a stable,…
Utilities: Settings, Design Tokens & Deletion Safety
Beyond the property and agent helper functions, Havenlytics ships a set of low-level utility functions for reading settings, resolving design tokens, checking feature…
Authentication & Authorization
Havenlytics authentication governs who may enter the Agent Workspace — the front-end SPA that agents use in place of wp-admin. This guide…
Widgets: The Complete Developer Reference
Havenlytics widgets are classic WP_Widget classes that render property-related content in the single-property sidebar — featured listings, the assigned agent, a mortgage calculator,…
Agent Workspace — Developer Guide
The Havenlytics Agent Workspace (internally the "Agent Portal") is a self-contained front-end single-page application plus a REST subsystem that gives real-estate agents…
Property Engine: Render Pipeline and View Model
The Havenlytics property engine is the set of functions and renderers that turn a hvnly_property post into a rendered card or single-property page. This…
Search Engine: Query Building and Map Search
The Havenlytics search engine spans two layers: a frontend JavaScript map/search client, and a server-side query builder that is the single source…
Action Hooks
Havenlytics action hooks are the do_action() events the plugin fires at key moments during its lifecycle, rendering, and data operations. They let you…
Extending Havenlytics: The Add-On Developer Guide
Havenlytics is built to be extended through hooks, filters, and theme template overrides — never by editing plugin files. This guide is…
Filter Hooks
Filter hooks are the primary extension seam of the Havenlytics real-estate plugin. Every filter lets you intercept a value the plugin is…
Template Loader
The Havenlytics template loader is the layer that decides which PHP template renders a property, an agent, an archive, or an individual…
Template Override
The Havenlytics template override system lets you replace any bundled template from your own theme without touching a single plugin file. It…