gem-hunter
Language: Gherkin
Imports files as attachments, regenerates thumbnails, or lists registered image sizes.
Imports files as attachments, regenerates thumbnails, or lists registered image sizes.
Quick links: Using | Installing | Contributing | Support
This package implements the following commands:
Imports files as attachments, regenerates thumbnails, replaces existing attachment files, or lists registered image sizes.
wp media
EXAMPLES
# Re-generate all thumbnails, without confirmation.
$ wp media regenerate --yes
Found 3 images to regenerate.
1/3 Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 Regenerated thumbnails for "Boardwalk" (ID 757).
3/3 Regenerated thumbnails for "Sunburst Over River" (ID 756).
Success: Regenerated 3 of 3 images.
# Import a local image and set it to be the featured image for a post.
$ wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image
Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image.
Success: Imported 1 of 1 images.
# Import an image from STDIN.
$ curl http://example.com/image.jpg | wp media import -
Imported file 'STDIN' as attachment ID 1754.
Success: Imported 1 of 1 items.
# List all registered image sizes
$ wp media image-size
+---------------------------+-------+--------+-------+
| name | width | height | crop |
+---------------------------+-------+--------+-------+
| full | | | N/A |
| twentyfourteen-full-width | 1038 | 576 | hard |
| large | 1024 | 1024 | soft |
| medium_large | 768 | 0 | soft |
| medium | 300 | 300 | soft |
| thumbnail | 150 | 150 | hard |
+---------------------------+-------+--------+-------+
# Fix orientation for specific images.
$ wp media fix-orientation 63
1/1 Fixing orientation for "Portrait_6" (ID 63).
Success: Fixed 1 of 1 images.
# Remove all generated thumbnails, without confirmation.
$ wp media prune --yes
Found 3 images to prune.
1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 Pruned thumbnails for "Boardwalk" (ID 757).
3/3 Pruned thumbnails for "Sunburst Over River" (ID 756).
Success: Pruned 3 of 3 images.
Fix image orientation for one or more attachments.
wp media fix-orientation [<attachment-id>...] [--dry-run]
OPTIONS
[<attachment-id>...]
One or more IDs of the attachments to regenerate.
[--dry-run]
Check images needing orientation without performing the operation.
EXAMPLES
# Fix orientation for all images.
$ wp media fix-orientation
1/3 Fixing orientation for "Landscape_4" (ID 62).
2/3 Fixing orientation for "Landscape_3" (ID 61).
3/3 Fixing orientation for "Landscape_2" (ID 60).
Success: Fixed 3 of 3 images.
# Fix orientation dry run.
$ wp media fix-orientation 63 --dry-run
1/1 "Portrait_6" (ID 63) will be affected.
Success: 1 of 1 image will be affected.
# Fix orientation for specific images.
$ wp media fix-orientation 63
1/1 Fixing orientation for "Portrait_6" (ID 63).
Success: Fixed 1 of 1 images.
Creates attachments from local files or URLs.
wp media import <file>... [--post_id=<post_id>] [--post_name=<post_name>] [--file_name=<name>] [--title=<title>] [--caption=<caption>] [--alt=<alt_text>] [--desc=<description>] [--skip-copy] [--destination-dir=<destination-dir>] [--preserve-filetime] [--featured_image] [--skip-duplicates] [--porcelain[=<field>]]
OPTIONS
<file>...
Path to file or files to be imported. Supports the glob(3) capabilities of the current shell.
If file is recognized as a URL (for example, with a scheme of http or ftp), the file will be
downloaded to a temp file before being sideloaded.
Use '-' to read file data from STDIN.
[--post_id=<post_id>]
ID of the post to attach the imported files to.
[--post_name=<post_name>]
Name of the post to attach the imported files to.
[--file_name=<name>]
Attachment name (post_name field).
[--title=<title>]
Attachment title (post title field).
[--caption=<caption>]
Caption for attachment (post excerpt field).
[--alt=<alt_text>]
Alt text for image (saved as post meta).
[--desc=<description>]
"Description" field (post content) of attachment post.
[--skip-copy]
If set, media files (local only) are imported to the library but not moved on disk.
File names will not be run through wp_unique_filename() with this set. When used, files
will remain at their current location and will not be copied into any destination directory.
[--destination-dir=<destination-dir>]
Path to the destination directory for uploaded imported files.
Can be absolute or relative to ABSPATH. Ignored when used together with --skip-copy, as
files are not moved on disk in that case.
[--preserve-filetime]
Use the file modified time as the post published & modified dates.
Remote files will always use the current time.
[--featured_image]
If set, set the imported image as the Featured Image of the post it is attached to.
[--skip-duplicates]
If set, media files that have already been imported will be skipped.
[--porcelain[=<field>]]
Output a single field for each imported image. Defaults to attachment ID when used as flag.
---
options:
- url
---
EXAMPLES
# Import all jpgs in the current user's "Pictures" directory, not attached to any post.
$ wp media import ~/Pictures/**\/*.jpg
Imported file '/home/person/Pictures/landscape-photo.jpg' as attachment ID 1751.
Imported file '/home/person/Pictures/fashion-icon.jpg' as attachment ID 1752.
Success: Imported 2 of 2 items.
# Import a local image and set it to be the post thumbnail for a post.
$ wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image
Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image.
Success: Imported 1 of 1 images.
# Import a local image, but set it as the featured image for all posts.
# 1. Import the image and get its attachment ID.
# 2. Assign the attachment ID as the featured image for all posts.
$ ATTACHMENT_ID="$(wp media import ~/Downloads/image.png --porcelain)"
$ wp post list --post_type=post --format=ids | xargs -d ' ' -I % wp post meta add % _thumbnail_id $ATTACHMENT_ID
Success: Added custom field.
Success: Added custom field.
# Import an image from the web.
$ wp media import http://s.wordpress.org/style/images/wp-header-logo.png --title='The WordPress logo' --alt="Semantic personal publishing"
Imported file 'http://s.wordpress.org/style/images/wp-header-logo.png' as attachment ID 1755.
Success: Imported 1 of 1 images.
# Get the URL for an attachment after import.
$ wp media import http://s.wordpress.org/style/images/wp-header-logo.png --porcelain | xargs -I {} wp post list --post__in={} --field=url --post_type=attachment
http://wordpress-develop.dev/wp-header-logo/
# Import an image from STDIN.
$ curl http://example.com/image.jpg | wp media import - --title="From STDIN"
Imported file 'STDIN' as attachment ID 1756.
Success: Imported 1 of 1 items.
Removes all generated image files for one or more attachments.
wp media prune [<attachment-id>...] [--image_size=<image_size>...] [--remove-abandoned] [--yes]
Generated image files for registered sizes can be recreated with
wp media regenerate. Thumbnails for image sizes that are no longer
registered are kept by default because they cannot be regenerated; use
--remove-abandoned to remove them as well.
OPTIONS
[<attachment-id>...]
One or more IDs of the attachments to prune.
[--image_size=<image_size>...]
Name of the image size to remove. Repeat the flag to specify multiple. Only thumbnails of specified image size(s) will be removed, thumbnails of other image sizes will not.
[--remove-abandoned]
Also remove thumbnails for image sizes that are no longer registered.
[--yes]
Answer yes to the confirmation message. Confirmation only shows when no IDs passed as arguments.
EXAMPLES
# Remove all generated thumbnails for all images, without confirmation.
$ wp media prune --yes
Found 3 images to prune.
1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 Pruned thumbnails for "Boardwalk" (ID 757).
3/3 Pruned thumbnails for "Sunburst Over River" (ID 756).
Success: Pruned 3 of 3 images.
# Remove only the "large" thumbnails for all images.
$ wp media prune --image_size=large
Do you really want to prune the "large" image size for all images? [y/n] y
Found 3 images to prune.
1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 Pruned thumbnails for "Boardwalk" (ID 757).
3/3 Pruned thumbnails for "Sunburst Over River" (ID 756).
Success: Pruned 3 of 3 images.
# Remove all thumbnails including those for unregistered sizes.
$ wp media prune --remove-abandoned --yes
Found 3 images to prune.
1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 Pruned thumbnails for "Boardwalk" (ID 757).
3/3 Pruned thumbnails for "Sunburst Over River" (ID 756).
Success: Pruned 3 of 3 images.
Regenerates thumbnails for one or more attachments.
wp media regenerate [<attachment-id>...] [--image_size=<image_size>...] [--skip-delete] [--only-missing] [--delete-unknown] [--update-attachment-refs] [--yes]
OPTIONS
[<attachment-id>...]
One or more IDs of the attachments to regenerate.
[--image_size=<image_size>...]
Name of the image size to regenerate. Repeat the flag to specify multiple. Only thumbnails of specified image size(s) will be regenerated, thumbnails of other image sizes will not.
[--skip-delete]
Skip deletion of the original thumbnails. If your thumbnails are linked from sources outside your control, it's likely best to leave them around. Defaults to false.
[--only-missing]
Only generate thumbnails for images missing image sizes.
[--delete-unknown]
Only delete thumbnails for old unregistered image sizes.
[--update-attachment-refs]
Update references to regenerated thumbnails in post content.
[--yes]
Answer yes to the confirmation message. Confirmation only shows when no IDs passed as arguments.
EXAMPLES
# Regenerate thumbnails for given attachment IDs.
$ wp media regenerate 123 124 125
Found 3 images to regenerate.
1/3 Regenerated thumbnails for "Vertical Image" (ID 123).
2/3 Regenerated thumbnails for "Horizontal Image" (ID 124).
3/3 Regenerated thumbnails for "Beautiful Picture" (ID 125).
Success: Regenerated 3 of 3 images.
# Regenerate all thumbnails, without confirmation.
$ wp media regenerate --yes
Found 3 images to regenerate.
1/3 Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 Regenerated thumbnails for "Boardwalk" (ID 757).
3/3 Regenerated thumbnails for "Sunburst Over River" (ID 756).
Success: Regenerated 3 of 3 images.
# Re-generate all thumbnails that have IDs between 1000 and 2000.
$ seq 1000 2000 | xargs wp media regenerate
Found 4 images to regenerate.
1/4 Regenerated thumbnails for "Vertical Featured Image" (ID 1027).
2/4 Regenerated thumbnails for "Horizontal Featured Image" (ID 1022).
3/4 Regenerated thumbnails for "Unicorn Wallpaper" (ID 1045).
4/4 Regenerated thumbnails for "I Am Worth Loving Wallpaper" (ID 1023).
Success: Regenerated 4 of 4 images.
# Re-generate only the thumbnails of "large" image size for all images.
$ wp media regenerate --image_size=large
Do you really want to regenerate the "large" image size for all images? [y/n] y
Found 3 images to regenerate.
1/3 Regenerated "large" thumbnail for "Sydney Harbor Bridge" (ID 760).
2/3 No "large" thumbnail regeneration needed for "Boardwalk" (ID 757).
3/3 Regenerated "large" thumbnail for "Sunburst Over River" (ID 756).
Success: Regenerated 3 of 3 images.
# Re-generate only the thumbnails of "large" and "medium" image sizes for all images.
$ wp media regenerate --image_size=large --image_size=medium
Do you really want to regenerate the "large", "medium" image sizes for all images? [y/n] y
Found 3 images to regenerate.
1/3 Regenerated "large", "medium" thumbnails for "Sydney Harbor Bridge" (ID 760).
2/3 No "large", "medium" thumbnail regeneration needed for "Boardwalk" (ID 757).
3/3 Regenerated "large", "medium" thumbnails for "Sunburst Over River" (ID 756).
Success: Regenerated 3 of 3 images.
Replaces the file for an existing attachment while preserving its identity.
wp media replace <attachment-id> <file> [--skip-delete] [--porcelain]
OPTIONS
<attachment-id>
ID of the attachment whose file is to be replaced.
<file>
Path to the replacement file. Supports local paths and URLs.
[--skip-delete]
Skip deletion of old thumbnail files after replacement.
[--porcelain]
Output just the attachment ID after replacement.
EXAMPLES
# Replace an attachment file with a local file.
$ wp media replace 123 ~/new-image.jpg
Replaced file for attachment ID 123 with '/home/user/new-image.jpg'.
Success: Replaced 1 of 1 images.
# Replace an attachment file with a file from a URL.
$ wp media replace 123 'http://example.com/image.jpg'
Replaced file for attachment ID 123 with 'http://example.com/image.jpg'.
Success: Replaced 1 of 1 images.
# Replace and output just the attachment ID.
$ wp media replace 123 ~/new-image.jpg --porcelain
123
Lists image sizes registered with WordPress.
wp media image-size [--fields=<fields>] [--format=<format>]
OPTIONS
[--fields=<fields>]
Limit the output to specific fields. Defaults to all fields.
[--format=<format>]
Render output in a specific format
---
default: table
options:
- table
- json
- csv
- yaml
- count
---
AVAILABLE FIELDS
These fields will be displayed by default for each image size:
EXAMPLES
# List all registered image sizes
$ wp media image-size
+---------------------------+-------+--------+-------+-------+
| name | width | height | crop | ratio |
+---------------------------+-------+--------+-------+-------+
| full | | | N/A | N/A |
| twentyfourteen-full-width | 1038 | 576 | hard | 173:96|
| large | 1024 | 1024 | soft | N/A |
| medium_large | 768 | 0 | soft | N/A |
| medium | 300 | 300 | soft | N/A |
| thumbnail | 150 | 150 | hard | 1:1 |
+---------------------------+-------+--------+-------+-------+
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/media-command.git
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.
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.
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.
This project is licensed under the MIT License. See the LICENSE file for details.
GitHub issues aren't for general support questions. For support resources and next steps, see the WP-CLI Support page: https://make.wordpress.org/cli/handbook/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.