Skip to content
Docs

Overview

Reign GeoDirectory Addon is a bridge plugin that connects GeoDirectory listings to community profiles built with BuddyPress or PeepSo, styled for the Reign theme.

With the addon active, a member’s GeoDirectory listings surface on their community profile, and the things members do in GeoDirectory (adding a place, marking a favorite, leaving a review) can appear in the community activity stream and send notifications.

What the addon does

Section titled “What the addon does”
  • Adds a “Places” tab to member profiles. On BuddyPress and PeepSo profiles the addon renders a tab that lists the member’s GeoDirectory listings using GeoDirectory’s own [gd_listings] output.
  • Records community activities. When enabled, adding a place, marking a place as favorite, and reviewing a place each post an activity update (BuddyPress activity stream or PeepSo stream).
  • Sends community notifications. New place, favorite, and review events can trigger BuddyPress or PeepSo notifications.
  • Adds a settings tab to the Reign theme options. All controls live under a “Geodirectory Settings” tab inside the Reign theme’s options page.

How it fits together

Section titled “How it fits together”
Layer Role
GeoDirectory Owns the listings (post types such as gd_place), reviews, and favorites.
Reign theme Hosts the addon settings UI and styles the listings on profiles. Required.
BuddyPress or PeepSo Provides the member profiles, activity stream, and notifications the addon writes to.
Reign GeoDirectory Addon Wires the three together.

Good to know

Section titled “Good to know”
  • The addon registers no shortcodes, no REST endpoints, no AJAX actions, no custom post types, and no custom database tables. It reuses GeoDirectory’s [gd_listings] shortcode and BuddyPress/PeepSo APIs.
  • The addon requires the Reign theme to be active. If any other theme is active it deactivates itself and shows a notice.
  • The addon requires the GeoDirectory plugin. Without it, the addon deactivates itself and shows a notice.
  • BuddyPress and PeepSo are both optional. The profile tab, activities, and notifications only appear for whichever of the two is active.

Continue to Requirements to confirm your environment, then Installation.