Skip to content

Add PHP-level glob expansion to wp media import #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 3 commits into from
Closed

Add PHP-level glob expansion to wp media import #226

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5204e7
Initial plan
Copilot Mar 2, 2026
bf9e9d7
Add PHP glob pattern expansion to wp media import command
Copilot Mar 2, 2026
ac3792e
Apply suggestion from @swissspidy
swissspidy Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions features/media-import.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,29 @@ Feature: Manage WordPress attachments
Success: Imported 2 of 2 items.
"""

Scenario: Import multiple images using a glob pattern
Given download:
| path | url |
| {CACHE_DIR}/large-image.jpg | http://wp-cli.org/behat-data/large-image.jpg |
And a {RUN_DIR}/images/ directory
Comment thread
swissspidy marked this conversation as resolved.
Outdated
And I run `cp {CACHE_DIR}/large-image.jpg {RUN_DIR}/images/image1.jpg`
And I run `cp {CACHE_DIR}/large-image.jpg {RUN_DIR}/images/image2.jpg`

When I run `wp media import '{RUN_DIR}/images/*.jpg'`
Then STDOUT should contain:
"""
Success: Imported 2 of 2 items.
"""

Scenario: Fail to import when a glob pattern matches no files
When I try `wp media import '/nonexistent-dir/*.png'`
Then STDERR should be:
"""
Warning: Pattern matched no files: '/nonexistent-dir/*.png'.
Error: No items imported.
"""
And the return code should be 1

Scenario: Fail to import one image but continue trying the next
When I try `wp media import gobbledygook.png 'http://wp-cli.org/behat-data/codeispoetry.png'`
Then STDERR should contain:
Expand Down
31 changes: 27 additions & 4 deletions src/Media_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ public function regenerate( $args, $assoc_args = array() ) {
* ## OPTIONS
*
* <file>...
* : Path to file or files to be imported. Supports the glob(3) capabilities of the current shell.
* : Path to file or files to be imported. Glob patterns (e.g. `dir/*.jpg`) are supported and
* expanded by WP-CLI, so quoting the argument is recommended to prevent shell expansion.
* 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.
*
Expand Down Expand Up @@ -246,7 +247,7 @@ public function regenerate( $args, $assoc_args = array() ) {
* ## EXAMPLES
*
* # Import all jpgs in the current user's "Pictures" directory, not attached to any post.
* $ wp media import ~/Pictures/**\/*.jpg
* $ wp media import '~/Pictures/*.jpg'
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example uses a quoted ~/Pictures/*.jpg, but quoting disables shell tilde expansion and PHP's glob() does not expand ~ either, so this example will typically match nothing. Consider switching the example to an expanded path (e.g., using $HOME) or documenting that ~ isn't supported when quoting glob patterns (or implement tilde expansion before calling glob()).

Suggested change
* $ wp media import '~/Pictures/*.jpg'
* $ wp media import "$HOME/Pictures/*.jpg"

Copilot uses AI. Check for mistakes.
* 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.
Expand Down Expand Up @@ -312,6 +313,28 @@ public function import( $args, $assoc_args = array() ) {
$assoc_args['post_id'] = false;
}

$glob_errors = 0;
$expanded_args = array();
foreach ( $args as $arg ) {
// phpcs:ignore WordPress.WP.AlternativeFunctions.parse_url_parse_url -- parse_url will only be used in absence of wp_parse_url.
$is_remote = function_exists( 'wp_parse_url' ) ? wp_parse_url( $arg, PHP_URL_HOST ) : parse_url( $arg, PHP_URL_HOST );
if ( empty( $is_remote ) && strpbrk( $arg, '*?[' ) !== false ) {
$matches = glob( $arg );
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The glob() function in PHP does not expand the tilde (~) character to the user's home directory. The updated documentation example at line 250 now uses '~/Pictures/*.jpg', which will fail because the tilde is passed literally to glob(). To ensure this works as users would expect from the example, you should manually expand the tilde to the user's home directory path before calling glob().

				if ( '~' === $arg[0] ) {
					$home = getenv( 'HOME' );
					if ( ! $home ) {
						// For Windows compatibility.
						$home = getenv( 'HOMEDRIVE' ) . getenv( 'HOMEPATH' );
					}
					if ( $home ) {
						$arg = $home . substr( $arg, 1 );
					}
				}
				$matches = glob( $arg );

if ( false === $matches ) {
WP_CLI::warning( "Unable to expand glob pattern '{$arg}'." );
++$glob_errors;
} elseif ( empty( $matches ) ) {
WP_CLI::warning( "Pattern matched no files: '{$arg}'." );
++$glob_errors;
} else {
$expanded_args = array_merge( $expanded_args, $matches );
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using array_merge() to append $matches can cause large array copies and extra peak memory usage when expanding patterns that match thousands of files (the main use case for this change). Consider appending the $matches elements onto $expanded_args in-place (e.g., loop/push) to reduce memory churn.

Suggested change
$expanded_args = array_merge( $expanded_args, $matches );
foreach ( $matches as $match ) {
$expanded_args[] = $match;
}

Copilot uses AI. Check for mistakes.
}
} else {
$expanded_args[] = $arg;
}
}
$args = $expanded_args;

$number = 0;
$successes = 0;
$errors = 0;
Expand Down Expand Up @@ -491,8 +514,8 @@ public function import( $args, $assoc_args = array() ) {

// Report the result of the operation
if ( ! Utils\get_flag_value( $assoc_args, 'porcelain' ) ) {
Utils\report_batch_operation_results( $noun, 'import', count( $args ), $successes, $errors );
} elseif ( $errors ) {
Utils\report_batch_operation_results( $noun, 'import', count( $args ) + $glob_errors, $successes, $errors + $glob_errors );
} elseif ( $errors || $glob_errors ) {
WP_CLI::halt( 1 );
}
}
Expand Down
Loading