Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wp-cli/import-command

Imports content from a given WXR file.
https://github.com/wp-cli/import-command

cli hacktoberfest import wordpress wp-cli wp-cli-package

Last synced: 2 days ago
JSON representation

Imports content from a given WXR file.

Host: GitHub
URL: https://github.com/wp-cli/import-command
Owner: wp-cli
License: mit
Created: 2017-02-28T13:07:49.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2024-04-26T10:36:14.000Z (8 months ago)
Last Synced: 2024-07-25T17:15:17.645Z (5 months ago)
Topics: cli, hacktoberfest, import, wordpress, wp-cli, wp-cli-package
Language: PHP
Homepage:
Size: 8.07 MB
Stars: 20
Watchers: 10
Forks: 24
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

stars - wp-cli/import-command - Imports content from a given WXR file. (PHP)

README

        wp-cli/import-command

=====================

Imports content from a given WXR file.

[![Testing](https://github.com/wp-cli/import-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/import-command/actions/workflows/testing.yml)

Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)

## Using

~~~

wp import ... --authors= [--skip=]

~~~

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**

	...

		Path to one or more valid WXR files for importing. Directories are also accepted.

	--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=]

		Skip importing specific data. Supported options are: 'attachment' and 'image_resize' (skip time-consuming thumbnail generation).

**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.

## 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 [email protected]: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](https://make.wordpress.org/cli/handbook/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](https://github.com/wp-cli/import-command/issues?q=label%3Abug%20) 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](https://github.com/wp-cli/import-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).

### Creating a pull request

Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/import-command/issues/new) 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](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.

## 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](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*