Ecosyste.ms: Awesome

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

https://github.com/liquidweb/wp-orphans

WP-CLI command to automatically detect orphaned media files
https://github.com/liquidweb/wp-orphans

Last synced: 21 days ago
JSON representation

WP-CLI command to automatically detect orphaned media files

Lists

README

        

WP Orphans
==========

Locate and remove orphaned media from the WordPress media library.

[![Build Status](https://travis-ci.org/liquidweb/wp-orphans.svg?branch=master)](https://travis-ci.org/liquidweb/wp-orphans)

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

## Using

To locate orphaned media — files in your uploads directory that aren't recognized within WordPress as attachments — you may run the following command.
```
$ wp media find-orphans
```

This will locate orphaned media. If you wish to automatically remove these files, you may use the `--cleanup` flag to automatically purge the orphaned media from the filesystem.

## Installing

Installing this package requires WP-CLI v1.1.0 or greater. Update to the latest stable release with `wp cli update`.

Once you've done so, you can install this package with:

wp package install [email protected]:liquidweb/wp-orphans.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/liquidweb/wp-orphans/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/liquidweb/wp-orphans/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/liquidweb/wp-orphans/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