Download the PHP package eighteen73/spark without Composer
On this page you can find all versions of the php package eighteen73/spark. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eighteen73/spark
More information about eighteen73/spark
Files in eighteen73/spark
Package spark
Short Description Fetch and manage block patterns from a remote API, providing a centralised pattern library for consistent design across multiple websites.
License
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package spark
Spark
A WordPress plugin that fetches and manages block patterns from a remote API, providing a centralised pattern library for consistent design across multiple websites.
Overview
Spark solves the problem of manually updating block patterns across multiple client websites. Instead of updating patterns individually on each site, you can manage them centrally and have them automatically distributed to all connected websites.
Features
- Remote Pattern Fetching: Securely fetches block patterns from a remote API endpoint
- Persistent Storage: Stores patterns in the WordPress options table (never expires)
- Automatic Sync: Weekly automatic synchronisation to keep patterns up-to-date
- Admin Interface: Clean, WordPress-native admin interface for pattern management
- Pattern Management: View all cached patterns with detailed information including:
- Pattern name, title, and description
- Categories and keywords
- Block types, post types, and template types
- Viewport width and inserter settings
- Last updated timestamp
- Screen Options: Customisable table display with column visibility and pagination
- Secure API Integration: Uses basic authentication with username and password defined in wp-config.php
Requirements
- WordPress 6.8 or higher
- PHP 8.3 or higher
- Valid username and password for your pattern service
Installation
Manual Installation
- Download the plugin files
- Upload the
sparkfolder to your/wp-content/plugins/directory - Activate the plugin through the 'Plugins' menu in WordPress
- Configure your credentials (see Configuration section)
Via WP-CLI
Configuration
Credentials Setup
Add your username and password to your wp-config.php file:
Important: Never store credentials in the database or plugin files. Always use wp-config.php for security.
API Endpoint
The plugin connects to any compatible pattern service API. The endpoint URL is configurable via the SPARK_API_URI constant. Contact your administrator for the correct endpoint URL and credentials.
Usage
Initial Setup
- Configure API Settings: Add your username, password, and API URI to wp-config.php
- Fetch Patterns: Go to Settings → Spark and click "Update Patterns"
- Verify Patterns: Check that patterns appear in the table and are available in the block editor
Admin Interface
Navigate to Settings → Spark to access the plugin's admin interface:
- Update Patterns: Manually fetch the latest patterns from the API
- Storage Status: View current storage status and last sync time
- Pattern List: Browse all cached patterns with detailed information
- Screen Options: Customize which columns to display and items per page
Block Editor Integration
Once patterns are fetched, they automatically appear in the WordPress block editor:
- Open any post or page in the block editor
- Click the "+" button to add a block
- Navigate to the "Patterns" tab
- Find your patterns organised by category
Automatic Synchronisation
The plugin automatically syncs patterns weekly using WordPress cron:
- Frequency: Every 7 days
- Automatic: No manual intervention required
- Background: Runs via WordPress cron system
- Fallback: Manual sync available if needed
Pattern Information
Each pattern includes comprehensive metadata:
| Field | Description |
|---|---|
| Name | Unique pattern identifier |
| Title | Display name in the editor |
| Categories | Pattern categories for organisation |
| Description | Pattern description and usage notes |
| Last Updated | When the pattern was last modified |
| Block Types | Compatible block types |
| Post Types | Compatible post types |
| Template Types | Compatible template types |
| Viewport Width | Recommended viewport width |
| Inserter | Whether pattern appears in inserter |
Security
- Credentials are stored securely in wp-config.php
- All API communications use HTTPS
- Pattern content is sanitised before storage
- No sensitive data is stored in the database
Development
File Structure
Hooks and Filters
The plugin provides several WordPress hooks for customization:
spark_weekly_sync: Fired during weekly pattern sync- Admin action hooks for pattern management
License
GPL-2.0-or-later
