https://github.com/underpin-wp/underpin-exporter-loader
Loader to handle GDPR compliant data exporting in WordPress
https://github.com/underpin-wp/underpin-exporter-loader
exporter gdpr underpin wordpress
Last synced: about 1 month ago
JSON representation
Loader to handle GDPR compliant data exporting in WordPress
- Host: GitHub
- URL: https://github.com/underpin-wp/underpin-exporter-loader
- Owner: Underpin-WP
- Created: 2021-05-03T19:49:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-24T21:43:02.000Z (over 4 years ago)
- Last Synced: 2025-03-08T01:01:52.508Z (over 1 year ago)
- Topics: exporter, gdpr, underpin, wordpress
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Underpin Exporter Loader
Loader That assists with adding GDPR-compliant exporters to a WordPress website.
## Installation
### Using Composer
`composer require underpin/exporter-loader`
### Manually
This plugin uses a built-in autoloader, so as long as it is required _before_
Underpin, it should work as-expected.
`require_once(__DIR__ . '/underpin-exporters/exporters.php');`
## Setup
1. Install Underpin. See [Underpin Docs](https://www.github.com/underpin-wp/underpin)
1. Register new exporters menus as-needed.
## Example
A very basic example could look something like this.
```php
// Register exporter
underpin()->exporters()->add( 'exporter', [
'id' => 'example-exporter', // required
'name' => __( 'translate-able name', 'domain' ), // required
'get_data_callback' => '__return_empty_array', // Required. See Exporter::get_data
'get_items_callback' => '__return_true', // Required. See Exporter::get_items
] );
```
Alternatively, you can extend `Exporter` and reference the extended class directly, like so:
```php
underpin()->exporters()->add('exporter-key','Namespace\To\Class');
```