Rechat Plugin (WordPress) — Documentation

Rechat plugin pulls data from Rechat (agents/offices/regions + listing search) and renders pages/blocks/shortcodes using Rechat Web Components (<rechat-root>, <rechat-listings>, etc.).

This README is user-facing: install, setup, features, templates, multisite, and all shortcodes + accepted parameters.

Features (what plugin does)

• OAuth connection to Rechat
  • Connect in WP admin, store access_token + refresh_token, auto-refresh.
  • Saves brand id, primary color, logo for UI usage.
• Automatic data sync (cron)
  • Scheduled sync every 12 hours (Agents / Offices / Regions / Branding).
  • Manual trigger exists (admin AJAX).
• Custom Post Types (CPT)
  • agents — agent profiles (archive + single).
  • offices — office profiles (archive + single) + Office ID meta from Rechat when synced.
  • regions — region pages (archive + single).
  • neighborhoods — neighborhood pages + cards, optional broadcast to agent subsites.
• Listings experience
  • [listings] shortcode and Listing block render full listing search experience.
  • Listing detail route rewrite: /listing-detail/{city}/{street}/{id}/ (legacy route also supported).
• Lead capture
  • [rch_leads_form] shortcode and Leads Form block.
  • Sends leads via Rechat SDK integration.
• Search form
  • [rch_search_listing_form] shortcode renders property search form that redirects to a listings page.
• Gutenberg blocks
  • Agents block
  • Offices/Regions block
  • Listing block
  • Leads Form block
• Template override system
  • Copy plugin templates into your theme folder rechat/ to customize output.
• WordPress Multisite support (optional)
  • Auto-create agent sub-sites and office sub-sites.
  • Agent subsites auto-scope listings to that agent.
  • Office subsites auto-scope listings to that office brand id (Office ID).
  • Theme sync / bulk provision / URL migration / cleanup tools in Network Admin.

Requirements

• WordPress with permalinks enabled.
• Rechat account.
• For maps: Google Maps API key (configured in plugin settings).
• For multisite provisioning: WordPress Multisite + Broadcast (ThreeWP Broadcast) network-active (when agent/office subsites enabled).

Install + setup

Install

1. Upload plugin folder to wp-content/plugins/rechat-plugin/
2. Activate from WP Admin → Plugins.

Connect to Rechat (OAuth)

WP Admin → Rechat → Connect to Rechat tab.

After success, plugin stores:

• rch_rechat_access_token
• rch_rechat_refresh_token
• rch_rechat_brand_id (brand UUID for SDK auth)
• optional appearance values (primary color, logo)

Automatic data sync

Plugin schedules a cron job (every 12 hours) that syncs:

• Agents
• Offices
• Regions
• Branding / associations

Notes:

• Cron hook: rch_data_sync_hook
• Interval: rch_every_12_hours

Custom post types (CPT) + what they represent

• Agents (agents)
  • Used for agent profile pages, agent blocks, and agent multisite subsites.
• Offices (offices)
  • Has office_id meta when pulled from Rechat API.
  • Locally created offices may not have office_id (no Rechat UUID).
• Regions (regions)
  • Region pages + region blocks.
• Neighborhoods (neighborhoods)
  • Neighborhood pages, optionally linked to offices and broadcast to agent subsites (multisite).

Template overrides (theme customization)

All data views (agents/regions/offices/listings) have default plugin templates. Override by adding files to your theme:

1. In your active theme (or child theme) create folder: rechat/
2. Copy the original templates from plugin into that folder and edit.

Supported override filenames:

Important:

• Put files in wp-content/themes/your-theme/rechat/ (not theme root).
• Use child theme for safe updates.

Gutenberg blocks

Blocks are registered by plugin and render server-side.

• Listing block: rch-rechat-plugin/listing-block
  • Same filter capabilities as [listings] (see shortcode section).
• Agents block: rch-rechat-plugin/agents-block
• Offices/Regions block: registered via block-offices-regions.php
• Leads form block: block-lead-form.php

Tip:

• Listing block + [listings] share the same PHP renderer. Most attributes map 1:1.

WordPress Multisite (agents + offices)

If WordPress Multisite enabled, plugin can provision a network sub-site for each agent and office.

What gets created

• Agent subsite
  • Linked to hub agent post via _rch_agent_site_id
  • URL can be subdomain or subdirectory depending on network
• Office subsite
  • Linked to hub office post via _rch_office_site_id
  • Uses o- prefix in slug to avoid collisions with agent slugs

Listing scope behavior on subsites

• Agent subsite
  • Auto-inject filter_agents="<csv>" into <rechat-listings> for:
    • [listings]
    • Listing block
    • [rch_latest_listings]
• Office subsite
  • Auto-inject filter_brand_id="<office_id>" into <rechat-listings> for:
    • [listings]
    • Listing block
    • [rch_latest_listings]
  • Value comes from hub office CPT meta office_id (Rechat Office brand UUID). If office is locally created with no office_id, scope is skipped.

Where to manage it

Network Admin / hub site → Rechat Settings → Multisite tab:

• enable/disable subsite creation
• bulk provision
• apply themes (agent sites / office sites)
• migrate agent URL slugs
• cleanup duplicates

Shortcodes (all + parameters)

All shortcodes can be used in:

• WP classic editor
• Gutenberg “Shortcode” block
• Theme templates (via do_shortcode() / plugin helper rch_do_shortcode() when available)

1) [listings] — full listing search experience

Renders <rechat-root> + <rechat-listings> + filters + map + grid + pagination.

Basic example:

[listings minimum_price="100000" maximum_price="500000" listing_per_page="12" filter_search_limit="200" filter_pool="true"]

Accepted parameters (from rch_get_listings_default_atts()):

Notes:

• Google Maps API key comes from settings, not from shortcode.
• Most filters become attributes on <rechat-listings>. For SDK meaning reference: https://sdk.rechat.com/classes/Listings.html

2) [rch_latest_listings] — compact latest listings widget

Renders <rechat-root> + <rechat-listings> using one of 3 layouts:

• swiper (default)
• normal (list + SDK pagination)
• grid (simple grid)

Basic example:

[rch_latest_listings property_types="Residential" listing_statuses="Active" filter_search_limit="200"]

Core parameters (from defaults):

Swiper-only parameters:

Examples:

[rch_latest_listings display_type="swiper" listing_statuses="Active" limit="10" filter_search_limit="100"]

[rch_latest_listings display_type="grid" property_types="Sale" limit="6" sort_by="-list_date"]

3) [rch_leads_form] — lead capture form

Basic example:

[rch_leads_form form_title="Contact Us" show_first_name="true" show_last_name="true" show_phone_number="true" show_email="true" show_note="true"]

Accepted parameters (from rch_parse_shortcode_attributes()):

4) [rch_search_listing_form] — search bar that redirects to listings page

This shortcode renders <rechat-property-search-form> inside <rechat-listings>. On submit it redirects (GET) to target_page with query parameters.

Basic example:

[rch_search_listing_form target_page="/listings/" show_background="false"]

Accepted parameters (from shortcode_atts defaults):

5) [rch_off_market] — Off Market listings grid

Renders a grid of Off Market listings (the off_market CPT — manually-entered listings with no Rechat API dependency). Use it anywhere: home page, a section, a widget, or a template via do_shortcode(). Each card links to its single Off Market page. Empty fields never render.

Two display modes: normal (responsive grid) or swiper (carousel). Swiper mode reuses the theme/SDK-provided global Swiper (same as [rch_latest_listings]).

Basic examples:

[rch_off_market]
[rch_off_market status="sold" limit="8" columns="4"]
[rch_off_market status="active" title="Our Private Listings"]
[rch_off_market status="active,pending" orderby="price" order="desc"]
[rch_off_market display_type="swiper" columns="4" limit="12"]
[rch_off_market display_type="swiper" status="active" autoplay="true" loop="true"]

Accepted parameters:

Swiper mode loads Swiper 11 automatically (from CDN) when used, so the carousel works on any page/theme. If a global Swiper already exists, it's reused.

Notes:

• Off Market listings are managed in wp-admin under Off Market (Add New → fill the fields → Publish). Fields: status, price, address, beds/baths/sqft, coordinates, list/sold date, gallery (Media Library), and an Agent picked from the site's Agents.
• Statuses use the "Privately" wording: Active Privately, Coming Soon Privately, Pending Privately, Sold Privately. The status filter matches on the keyword, so status="sold" catches "Sold Privately".
• The full listing (archive) also lives at /off-market/.

Notes + troubleshooting

• Permalinks / rewrite
  • After activation or URL changes, re-save WP Settings → Permalinks.
• No data / empty pages
  • Confirm OAuth connected and brand id exists in settings.
  • Check WP cron runs (or server cron).
• Multisite provisioning not working
  • Must be WordPress Multisite.
  • If subsite creation enabled, Broadcast must be network-active.
• Office subsite listing scope missing
  • Hub office must have office_id meta (synced from Rechat). Locally added offices have no id.