https://github.com/steadfast-collective/statamic-csv-exporter
Export your content to CSV files.
https://github.com/steadfast-collective/statamic-csv-exporter
csv-exporter statamic-addon statamic-utility statamic-v3
Last synced: about 2 months ago
JSON representation
Export your content to CSV files.
- Host: GitHub
- URL: https://github.com/steadfast-collective/statamic-csv-exporter
- Owner: steadfast-collective
- License: mit
- Created: 2022-03-25T09:53:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T03:38:34.000Z (about 1 year ago)
- Last Synced: 2025-04-20T12:27:37.586Z (about 2 months ago)
- Topics: csv-exporter, statamic-addon, statamic-utility, statamic-v3
- Language: PHP
- Homepage: https://statamic.com/addons/steadfastcollective/csv-exporter
- Size: 143 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Statamic CSV Exporter
This addon gives you the ability to export your content to CSV files.
## Installation
You can search for this addon in the `Tools > Addons` section of the Statamic Control Panel and click **install**, or run the following command from your project root:
```bash
composer require steadfastcollective/statamic-csv-exporter
```
## Usage
To use this addon, follow the usage instructions or [watch this video](https://www.loom.com/share/2d4f2777408a47b1b53d283a0db2cba4):
1. Head into the Control Panel
2. Go to `Utilities` and click into the 'CSV Exporter' utility
3. Select the collections you wish to export and click the 'Export' button
4. A ZIP file will be downloaded. If you open that, you'll find each collection in its own CSV file.
### Ignoring certain fields
If you'd like to exclude certain fields from being returned by the export, you should add them to the addon's configuration file
By default, you're unlikley to have the configuration file published. To publish it, run:
```
php artisan vendor:publish --tag=statamic-csv-exporter-config
```
The config file will appear as `config/statamic-csv-exporter.php`.
In the config file, you will see an `ignored_fields` array. Inside that, add the handle of the collection, then any of the fields you wish to be excluded.
In the below example: exports for the `events` collection will exclude the `author` and `excerpt` fields.
```php
/*
|--------------------------------------------------------------------------
| Ignored fields
|--------------------------------------------------------------------------
|
| Configure any fields which should be ignored when exporting items.
|
*/
'ignored_fields' => [
'collections' => [
'events' => [
'author', 'excerpt',
],
],
],
```
## Changelog
Please see [CHANGELOG](https://github.com/steadfast-collective/statamic-csv-exporter/blob/main/CHANGELOG.md) for more information what has changed recently.
## Security
If you discover any security related issues, please email [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## License
The MIT License (MIT). Please see [License File](https://github.com/steadfast-collective/statamic-csv-exporter/blob/main/LICENSE.md) for more information.