Skip to content

Added PHPDoc for cmd_starts_with() method #6034

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

Merged
mrsdizzie merged 3 commits into from
Feb 4, 2025
Merged

Added PHPDoc for cmd_starts_with() method #6034

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e91cab
Add PHPDoc for cmd_starts_with() method
PARTHVATALIYA Jan 24, 2025
8604a07
Update docblock example.
PARTHVATALIYA Jan 27, 2025
0a4ad95
Update the docblock for cmd_starts_with
PARTHVATALIYA Feb 4, 2025
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
8 changes: 8 additions & 0 deletions php/WP_CLI/Runner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,14 @@ private static function guess_url( $assoc_args ) {
return false;
}

/**
* Checks if the arguments passed to the WP-CLI binary start with the specified prefix.
*
* @param array $prefix An array of strings specifying the expected start of the arguments passed to the WP-CLI binary.
* For example, `['user', 'list']` checks if the arguments passed to the WP-CLI binary start with `user list`.
*
* @return bool `true` if the arguments passed to the WP-CLI binary start with the specified prefix, `false` otherwise.
*/
private function cmd_starts_with( $prefix ) {
return array_slice( $this->arguments, 0, count( $prefix ) ) === $prefix;
}
Expand Down
Loading