Merge pull request #6034 from PARTHVATALIYA/fix/6033

mrsdizzie · web-flow · commit 1488fc1d6dc5 · 2025-02-04T10:21:26.000-05:00
Added PHPDoc for cmd_starts_with() method
diff --git a/php/WP_CLI/Runner.php b/php/WP_CLI/Runner.php
@@ -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;
 	}

Original file line number	Diff line number	Diff line change
`@@ -344,6 +344,14 @@ private static function guess_url( $assoc_args ) {`
`344`	`344`	`return false;`
`345`	`345`	`}`
`346`	`346`
	`347`	`+ /**`
	`348`	`+ * Checks if the arguments passed to the WP-CLI binary start with the specified prefix.`
	`349`	`+ *`
	`350`	`+ * @param array $prefix An array of strings specifying the expected start of the arguments passed to the WP-CLI binary.`
	`351`	+ * For example, `['user', 'list']` checks if the arguments passed to the WP-CLI binary start with `user list`.
	`352`	`+ *`
	`353`	+ * @return bool `true` if the arguments passed to the WP-CLI binary start with the specified prefix, `false` otherwise.
	`354`	`+ */`
`347`	`355`	`private function cmd_starts_with( $prefix ) {`
`348`	`356`	`return array_slice( $this->arguments, 0, count( $prefix ) ) === $prefix;`
`349`	`357`	`}`