Installation
Get FilterX up and running on your WordPress site in minutes.
System Requirements
| Requirement | Minimum | Recommended |
|---|---|---|
| PHP | 8.1 | 8.2+ |
| WordPress | 6.2 | 6.5+ |
| MySQL | 5.7 | 8.0+ |
| Memory Limit | 64 MB | 256 MB |
| WooCommerce (optional) | 7.0 | 8.0+ |
Method 1: Upload via WordPress Admin
- 1Log in to your WordPress Admin panel.
- 2Navigate to Plugins → Add New → Upload Plugin.
- 3Click Choose File and select the filter-x.zip file you downloaded.
- 4Click Install Now, then Activate Plugin.
- 5FilterX will automatically create its 6 database tables and set default options.
Method 2: Manual Upload via FTP
- 1Extract the
filter-x.ziparchive. - 2Upload the
filter-xfolder to/wp-content/plugins/ - 3Go to WordPress Admin → Plugins and click Activate next to FilterX.
# FTP directory structure
/wp-content/plugins/filter-x/
├── filter-x.php (main plugin file)
├── includes/
├── assets/
├── admin/
└── templates/
After Activation
On first activation, FilterX automatically:
- Creates 6 custom database tables (filterx_index, filterx_facets, filterx_grids, filterx_cards, filterx_queue, filterx_migrations)
- Sets 6 default plugin options including caching TTL and index batch size
- Flushes WordPress rewrite rules
- Fires the filterx/activated action hook
- Adds FilterX to the WordPress admin menu at priority 76
Developer Setup (Optional)
If you plan to contribute or extend FilterX, install Composer dependencies for code quality tooling:
$ cd /wp-content/plugins/filter-x
$ composer install
# Available composer scripts:
$ composer phpcs # Check WPCS code standards
$ composer phpcbf # Auto-fix formatting
$ composer phpstan # Static analysis (PHP 8.1+)
$ composer test # Run unit tests
Plugin Constants
FilterX defines the following constants on load:
FILTERX_VERSION "1.0.0"
FILTERX_FILE // Full path to filter-x.php
FILTERX_PATH // Full path to plugin directory (with trailing slash)
FILTERX_URL // Plugin URL (with trailing slash)
FILTERX_BASENAME "filter-x/filter-x.php"
FILTERX_MIN_WP "6.2"
FILTERX_MIN_PHP "8.1"