PHPackages                             maestroerror/statamic-magic-import - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. maestroerror/statamic-magic-import

ActiveLibrary

maestroerror/statamic-magic-import
==================================

Seamless, magical import experience for Statamic

2.0(2y ago)14.9k↓27.3%MITPHP

Since Oct 16Pushed 2y ago1 watchersCompare

[ Source](https://github.com/MaestroError/statamic-magic-import)[ Packagist](https://packagist.org/packages/maestroerror/statamic-magic-import)[ RSS](/packages/maestroerror-statamic-magic-import/feed)WikiDiscussions maestro Synced 1mo ago

READMEChangelog (10)DependenciesVersions (12)Used By (0)

Statamic Magic Import
=====================

[](#statamic-magic-import)

your go-to solution for effortless data imports. With a user-friendly interface and support for **JSON** data formats, importing data into Statamic becomes as easy as a wave of a wand. Experience the magic of hassle-free data management

*This addon can work with JSON files extracted using a [statamic exporter Wordpress plugin](https://github.com/maestroerror/wordpress-to-statamic-exporter).*

Json import
-----------

[](#json-import)

**JSON file examples:**

[collections.example.json](https://github.com/MaestroError/statamic-magic-import/blob/maestro/collections.example.json)

```
{
  // Defining collections
  "collections": {
    // Name of new collection (You can add as many collections as you need)
    "post": {
      // Entrie slug
      "/post/top-10-titles": {
        // Date of creation (here you can use "order" keyword as well)
        "date": "2023-10-04",
        // Fields
        "data": {
          "title": "Top 10 Titles for example data",
          "content": "Some HTML content for TinyMCE or Bard fields",
          "author": "admin",
          "featured_image": "https://example.com/images/nice-image.webp", // It will download your image and add to assets
          "categories": ["category_1", "category_2"], // Create taxonomy and import it in "Taxonomy terms" field
          "tags": ["tag_1", "tag_2", "tag_3"] // For "Taxonomy terms" field
        }
      }
    }
  }
}
```

[taxonomies.example.json](https://github.com/MaestroError/statamic-magic-import/blob/maestro/taxonomies.example.json)

```
{
  // Defining taxonomies
  "taxonomies": {
    // Taxonomy name
    "categories": {
      // Taxonomy terms and titles:
      "development": {
        "title": "Development"
      },
      "outsourcing": {
        "title": "Outsourcing"
      },
      "product-design": {
        "title": "Product design"
      },
      "project-management": {
        "title": "Project management"
      },
      "startups": {
        "title": "Startups"
      },
      "tech-news": {
        "title": "Tech news"
      },
      "uncategorized": {
        "title": "Uncategorized"
      }
    }
  }
}
```

Features
--------

[](#features)

Json import:

- Create taxonomies and terms
- Create pages
- Create collections and entries
    - includes fields choosing feature for importing in existing collections

*Any meta data key prefixed with an underscore will be ignored.*

### Events

[](#events)

The addon is using the builtin methods for creating and saving content. As such, the normal events are dispatched which you can hook into for additional work according to your setup. That means you can listen on the following events to customize the import:

- `Statamic\Events\CollectionCreated`
- `Statamic\Events\CollectionSaved`
- `Statamic\Events\EntrySaving`
- `Statamic\Events\EntryCreated`
- `Statamic\Events\EntrySaved`
- `Statamic\Events\TaxonomySaved`
- `Statamic\Events\TermSaved`
- `Statamic\Events\AssetSaved`
- `Statamic\Events\AssetUploaded`

By the time you read this there might be others. Consult [the documentation](https://statamic.dev/extending/events#available-events) to learn more.

### Images

[](#images)

All URLs including image extensions (.png, .jpg, .webp and etc) will be downloaded. Featured images will be downloaded to the "assets" container by default (change in config), into a folder called "{collection\_handle}/{entry\_slug}", and saved in a [assets](https://statamic.dev/fieldtypes/assets) field.

How to Install
--------------

[](#how-to-install)

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:

```
composer require maestroerror/statamic-magic-import
```

How to Use
----------

[](#how-to-use)

Go to the `Tools > Magic Import` section and upload the json file.

For collections, the summary will show you 2 options: creating a new collection or importing in existing one.

[![statamic-json-import:creating-new-collection](https://github.com/MaestroError/statamic-magic-import/raw/maestro/resources/img/creating-new-collection.png)](https://github.com/MaestroError/statamic-magic-import/blob/maestro/resources/img/creating-new-collection.png)

When importing in existing collection, you can choose JSON field for each of your collection fields.

Even when creating new collection, there might be the collection with same name. If you choose to import it anyway, the content will be overwritten, but you can (De)Select anything you want (by titles) and click "Import".

[![statamic-json-import:pages-before-choice](https://github.com/MaestroError/statamic-magic-import/raw/maestro/resources/img/pages-before-choice.png)](https://github.com/MaestroError/statamic-magic-import/blob/maestro/resources/img/pages-before-choice.png)

[![statamic-json-import:collection-after-choice](https://github.com/MaestroError/statamic-magic-import/raw/maestro/resources/img/test-collection-after-choice.png)](https://github.com/MaestroError/statamic-magic-import/blob/maestro/resources/img/test-collection-after-choice.png)

*Note: You might get timeout errors if you're importing large datasets and/or many images.*

Config
------

[](#config)

The content of the config file looks like this:

```