soderlind / vmfa-folder-exporter
Export folders as ZIP archives with optional CSV manifests. Add-on for Virtual Media Folders.
Package info
github.com/soderlind/vmfa-folder-exporter
Type:wordpress-plugin
pkg:composer/soderlind/vmfa-folder-exporter
Requires
- php: >=8.3
- composer/installers: ^2.0
- woocommerce/action-scheduler: ^3.7
- yahnis-elsts/plugin-update-checker: ^5.6
Requires (Dev)
- brain/monkey: ^2.6
- dealerdirect/phpcodesniffer-composer-installer: ^1.0
- mockery/mockery: ^1.6
- pestphp/pest: ^4.0
- wp-coding-standards/wpcs: ^3.0
- dev-main
- 1.3.1
- 1.3.0
- 1.2.0
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.0
- dev-fix/action-scheduler-timing
- dev-dependabot/npm_and_yarn/axios-1.15.1
- dev-dependabot/npm_and_yarn/follow-redirects-1.16.0
- dev-dependabot/npm_and_yarn/basic-ftp-5.2.2
- dev-dependabot/npm_and_yarn/lodash-4.18.1
- dev-dependabot/npm_and_yarn/vite-7.3.2
- dev-dependabot/npm_and_yarn/lodash-es-4.18.1
- dev-dependabot/npm_and_yarn/node-forge-1.4.0
- dev-dependabot/npm_and_yarn/yaml-1.10.3
- dev-dependabot/npm_and_yarn/multi-bf05dc1ecf
- dev-dependabot/npm_and_yarn/flatted-3.4.2
- dev-dependabot/npm_and_yarn/undici-7.24.2
- dev-feature/use-vmf-addon-base
- dev-feature/wp7-ui
- dev-fix/dependabot-updates
- dev-update/wp-7.0
- dev-dependabot/npm_and_yarn/svgo-3.3.3
- dev-dependabot/npm_and_yarn/immutable-5.1.5
- dev-dependabot/npm_and_yarn/rollup-4.59.0
- dev-dependabot/npm_and_yarn/qs-6.14.2
- dev-hooks
- dev-add-folders-command
This package is auto-updated.
Last update: 2026-04-20 15:23:54 UTC
README
Add-on for Virtual Media Folders that lets you export folders (or subtrees) as ZIP archives with optional CSV manifests.
Features
- ZIP export — export any folder as a downloadable ZIP archive with the original folder hierarchy preserved.
- Include subfolders — optionally include all descendent folders in the export.
- CSV manifest — generate a manifest with ID, filename, URL, alt text, caption, description, MIME type, file size, dimensions, date uploaded, and folder path.
- Background processing — powered by Action Scheduler for large folders.
- Automatic cleanup — expired exports are automatically removed after 24 hours.
- Admin dashboard — React-based UI with folder picker, export options, progress tracking, and export history.
- WP-CLI support — export, list, and clean up from the command line.
Requirements
| Requirement | Version |
|---|---|
| WordPress | 6.8+ |
| PHP | 8.3+ |
| Virtual Media Folders | active |
Installation
- Download
vmfa-folder-exporter.zip - Upload via
Plugins → Add New → Upload Plugin - Activate via
WordPress Admin → Plugins
Plugin updates are handled automatically via GitHub. No need to manually download and install updates.
Usage
Admin Dashboard
Navigate to Media → Virtual Folders → Folder Exporter. The dashboard provides:
| Section | Purpose |
|---|---|
| Stats | Total available folders |
| Export Folder | Select a folder, choose options, start export |
| Progress | Real-time progress bar and download button |
| Recent Exports | History table with download/delete actions |
Export Options
| Option | Default | Description |
|---|---|---|
| Include subfolders | ✅ | Include all descendent folders in the ZIP |
| Include CSV manifest | ✅ | Add a manifest.csv file at the ZIP root |
CSV Manifest Columns
| Column | Description |
|---|---|
| ID | Attachment post ID |
| filename | Original filename |
| url | Full attachment URL |
| alt_text | Image alt text |
| caption | Attachment caption |
| description | Attachment description |
| mime_type | MIME type (e.g., image/jpeg) |
| file_size_bytes | File size in bytes |
| width | Image width in pixels (if applicable) |
| height | Image height in pixels (if applicable) |
| date_uploaded | Upload date |
| folder_path | Virtual folder path (e.g., Photos/2025/Summer) |
WP-CLI
wp vmfa-export folders # List folders with IDs wp vmfa-export folders --format=json wp vmfa-export folder 42 # Export folder ID 42 as ZIP wp vmfa-export folder 42 --output=/tmp/photos.zip wp vmfa-export folder 42 --no-children wp vmfa-export folder 42 --no-manifest wp vmfa-export list # List recent exports wp vmfa-export list --format=json wp vmfa-export clean # Remove expired exports wp vmfa-export clean --all # Remove all exports
Use wp vmfa-export folders to find the folder ID needed by wp vmfa-export folder <id>. The ID is also visible in the admin folder picker.
Developer Documentation
See docs/DEVELOPER.md for filters, REST API reference with examples, WP-CLI details, and build/test instructions.
License
GPL-2.0-or-later