considbrs-webdev / modularity-simpleview-events

v1.0.0 2026-11-04 14:56 UTC

Requires

• php: >=8.3

Suggests

• helsingborg-stad/municipio: ^6.0.0

MIT

• Consid

Published on Packagist.org on 2026-11-04 14:58 UTC

README

A WordPress plugin for integrating events from the Simpleview API into WordPress.

Features

• Dynamically create post types and taxonomies from the Simpleview API
• Automatic synchronization via WP Cron
• Manual sync trigger from admin settings
• Configurable API credentials and sync frequency

Requirements

• PHP 8.3 or later
• WordPress with the Municipio theme and the Modularity plugin
• Advanced Custom Fields
• Composer and Node.js/npm for building

Installation

1. Place the plugin in wp-content/plugins/modularity-simpleview-events/
2. Run composer install (or composer dump-autoload to only regenerate the autoloader)
3. Run npm ci && npm run build to build assets (or php build.php to do all build steps)
4. Activate the plugin through the WordPress admin

Configuration

1. Navigate to Simpleview Events > Settings
2. Configure your API credentials:
   • API Base URL
   • API Key
3. Set your preferred sync frequency (hourly, twice daily, or daily)
4. Use the "Sync Now" button to perform an initial manual sync

CLI Commands

The plugin provides WP-CLI commands for managing Simpleview events data:

Sync Events

Sync events from the Simpleview API:

wp simpleview-events sync

Options:

• --wipe - Wipe all existing data before syncing (requires confirmation)

Examples:

# Run sync
wp simpleview-events sync

# Wipe all existing data and sync fresh
wp simpleview-events sync --wipe

Wipe Data

Delete all synced Simpleview events data (posts, terms, and options):

wp simpleview-events wipe

Options:

• --confirm - Skip confirmation prompt (use with caution)

Examples:

# Wipe all data (with confirmation prompt)
wp simpleview-events wipe

# Wipe all data (skip confirmation)
wp simpleview-events wipe --confirm

Show Statistics

Display sync statistics including total events, post types, and last sync time:

wp simpleview-events stats

This command shows:

• Total events count
• Draft events count
• Number of post types
• Last sync timestamp
• Post type breakdown with media channel information

Development

Source layout:

• source/php/ - PHP source files (PSR-4, namespace ModularitySimpleviewEvents\)
• source/php/AcfFields/ - ACF fields (auto-exported/imported)
• source/php/Admin/ - Admin functionality
• source/php/Api/ - API client for Simpleview
• source/php/Cache/ - Cache purging for event modules
• source/php/Cli/ - WP-CLI commands
• source/php/Cron/ - WP Cron scheduling
• source/php/Module/ - Upcoming events module
• source/php/PostType/, source/php/Taxonomy/ - Dynamic post type and taxonomy registration
• source/php/Query/ - Archive and upcoming events queries
• source/php/Sync/ - Synchronization and archiving logic
• source/js, source/sass - Frontend assets built with Vite

Build commands: npm run build, npm run build:dev, npm run watch.

See HOW_IT_WORKS.md for the architecture and sync flow.

Tests

There is no automated test setup yet.

Roadmap

• Automated tests (PHPUnit)
• Linting/formatting (PHP_CodeSniffer, PSR-12)

Release

Development happens on dev. When done, dev is merged into main and a release is tagged from main. The version is set in the plugin header in modularity-simpleview-events.php.

Working with AI

See AGENTS.md for instructions to AI tools working in this repository.

License

MIT