README

Imports content from a given WXR file.

Quick links: Using | Installing | Contributing | Support

Using

wp import <file>... --authors=<authors> [--skip=<data-type>] [--rewrite_urls] [--importer=<importer>] [--source-dir=<dir>]

Provides a command line interface to the WordPress Importer plugin, for performing data migrations.

Use define( 'IMPORT_DEBUG', true ); for more verbosity during importing.

OPTIONS

<file>...
	Path to one or more valid WXR files for importing. Directories are also accepted.
	A URL to a WXR file is also accepted. Use '-' to import from STDIN.

--authors=<authors>
	How the author mapping should be handled. Options are 'create', 'mapping.csv', or 'skip'. The first will create any non-existent users from the WXR file. The second will read author mapping associations from a CSV, or create a CSV for editing if the file path doesn't exist. The CSV requires two columns, and a header row like "old_user_login,new_user_login". The last option will skip any author mapping.

[--skip=<data-type>]
	Skip importing specific data. Supported options are: 'attachment' and 'image_resize' (skip time-consuming thumbnail generation).

[--rewrite_urls]
	Change all imported URLs that currently link to the previous site so that they now link to this site
	Requires WordPress Importer version 0.9.1 or newer.

[--importer=<importer>]
	Use a custom importer class instead of the default WP_Import. The class must exist and be a subclass of WP_Import.

[--source-dir=<dir>]
	A local directory to search for attachment files before downloading them from their original URLs. When specified, the importer matches attachment filenames (by basename only) against files in this directory, and uses any local match instead of fetching the file over the network. Useful when attachment files are already available locally, e.g. from a previous site's uploads directory.

EXAMPLES

# Import content from a WXR file
$ wp import example.wordpress.2016-06-21.xml --authors=create
Starting the import process...
Processing post #1 ("Hello world!") (post_type: post)
-- 1 of 1
-- Tue, 21 Jun 2016 05:31:12 +0000
-- Imported post as post_id #1
Success: Finished importing from 'example.wordpress.2016-06-21.xml' file.

# Import content from a WXR file via HTTP
$ wp import https://raw.githubusercontent.com/WordPress/theme-test-data/refs/heads/master/theme-preview.xml --authors=skip
Starting the import process...
Downloading 'https://raw.githubusercontent.com/WordPress/theme-test-data/refs/heads/master/theme-preview.xml'...
Success: Finished importing from 'https://raw.githubusercontent.com/WordPress/theme-test-data/refs/heads/master/theme-preview.xml' file.

# Import content from STDIN
$ wp export --stdout | wp import - --authors=skip
Starting the import process...
Success: Finished importing from 'STDIN' file.

# Import using locally available attachment files to avoid re-downloading
$ wp import export.xml --authors=skip --source-dir=/path/to/uploads
Starting the import process...
-- Using local file for 'https://example.com/wp-content/uploads/2024/01/image.jpg'.
Success: Finished importing from 'export.xml' file.

Installing

This package is included with WP-CLI itself, no additional installation necessary.

To install the latest version of this package over what's included in WP-CLI, run:

wp package install git@github.com:wp-cli/import-command.git

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support

This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.