Settings API

The GatherPress Settings API provides a structured way to manage plugin configuration. All settings are stored in a single flat WordPress option (gatherpress_settings) as key-value pairs. Only non-default values are persisted, keeping the database lean.

Reading and Writing Settings

use GatherPressCoreSettings;

$settings = Settings::get_instance();

// Get a single setting (returns default if not set).
$map_platform = $settings->get( 'map_platform' ); // 'osm'
$max_limit    = $settings->get( 'max_attendance_limit' ); // 50

// Set a single setting. Values matching the default are automatically removed.
$settings->set( 'map_platform', 'google' );

Settings Page Tabs

The settings page is organized into tabs, each managed by its own class:

Tab	Class	Description
Events	`SettingsEvents`	Date/time formats, event display, archive pages, permalinks
RSVP	`SettingsRsvp_Settings`	Attendance limits, guest limits, anonymous RSVP, cleanup
Venues	`SettingsVenues`	Map platform (and future venue-specific config)
Roles	`SettingsRoles`	Organizer role assignment
Tools	`SettingsTools`	Import and export settings
Credits	`SettingsCredits`	Plugin contributors

Available Settings

Events Tab

Key	Type	Default	Description
`date_format`	text	WordPress date format	Date format for events
`time_format`	text	WordPress time format	Time format for events
`show_timezone`	checkbox	`true`	Display timezone for events
`post_or_event_date`	checkbox	`true`	Display event date instead of publish date
`upcoming_events`	autocomplete	`[]`	Page for upcoming events archive
`past_events`	autocomplete	`[]`	Page for past events archive
`events_url`	text	`'event'`	Permalink base for events
`venues_url`	text	`'venue'`	Permalink base for venues
`topics_url`	text	`'topic'`	Permalink base for topics

RSVP Tab

Key	Type	Default	Description
`rsvp_mode`	select	`'all_on'`	Controls sitewide RSVP availability. See RSVP Mode below.
`max_attendance_limit`	number	`50`	Maximum attendees per event (0 = unlimited)
`max_guest_limit`	number	`0`	Maximum guests per attendee (0-5)
`enable_anonymous_rsvp`	checkbox	`false`	Allow anonymous RSVPs
`enable_open_rsvp`	checkbox	`true`	Allow visitors to RSVP without a site account (email verification). Enabled by default.
`rsvp_cleanup_switch`	select	`'off'`	Enable/disable RSVP cleanup
`rsvp_cleanup_frequency`	select	`'daily'`	Cleanup frequency (hourly, daily, weekly, monthly, yearly)
`rsvp_cleanup_interval`	number	`1`	Interval multiplier for cleanup frequency

RSVP Mode

The rsvp_mode setting controls how RSVP availability is determined across the site.

Value	Label	Behavior
`all_on`	All events	RSVP is enabled for every event. No per-event toggle is shown. This is the default.
`per_event_on`	Per event (default on)	A per-event toggle appears in the block editor. New events default to RSVP enabled.
`per_event_off`	Per event (default off)	A per-event toggle appears in the block editor. New events default to RSVP disabled.
`disabled`	Disabled	RSVP is turned off sitewide. RSVP blocks are hidden from the inserter, the RSVPs admin submenu is removed, and the RSVP Settings editor panel is hidden.

Per-event meta convention: the gatherpress_enable_rsvp post meta stores the per-event state as an integer (1 = enabled, 0 = disabled). An unset meta value (empty string) is treated as enabled — only an explicit 0 disables RSVP for an individual event. When mode is all_on, this meta is explicitly written as 1 on save so that switching to a per-event mode later produces predictable results.

use GatherPressCoreSettings;

// Read the current RSVP mode.
$mode = Settings::get_instance()->get( 'rsvp_mode' ); // 'all_on'

// Check whether RSVP is enabled for a specific event post.
$enabled = ( new GatherPressCoreRsvp( $post_id ) )->is_enabled();

Venues Tab

Key	Type	Default	Description
`map_platform`	select	`'osm'`	Map provider (osm or google)

Roles Tab

Key	Type	Default	Description
`organizer`	autocomplete	`[]`	Users assigned as organizers

Import and Export

Settings can be exported and imported via the Tools tab or WP-CLI:

# Export settings to a file.
wp gatherpress settings export --file=settings.json

# Preview what an import would change (default behavior).
wp gatherpress settings import settings.json

# Apply import with merge (preserves existing settings not in the file).
wp gatherpress settings import settings.json --apply

# Apply import with replace (overwrites all settings).
wp gatherpress settings import settings.json --apply --mode=replace

Settings