Skip to content

Commit eefa4e8

Browse files
Docs: Add missing parameter descriptions for get_cli_args().
Follow-up to [14760]. Props rejaulalomkhan, huzaifaalmesbah, westonruter, SergeyBiryukov. See #64224. git-svn-id: https://develop.svn.wordpress.org/trunk@61512 602fd350-edb4-49c9-b593-d223f7449a82
1 parent c22a748 commit eefa4e8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/wp-admin/includes/class-wp-importer.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,10 @@ public function stop_the_insanity() {
289289
* Returns value of command line params.
290290
* Exits when a required param is not set.
291291
*
292-
* @param string $param
293-
* @param bool $required
294-
* @return mixed
292+
* @param string $param The parameter name to retrieve.
293+
* @param bool $required Optional. Whether the parameter is required. Default false.
294+
* @return string|true|null|never The parameter value or true if found, null otherwise.
295+
* The function exits when a required parameter is missing.
295296
*/
296297
function get_cli_args( $param, $required = false ) {
297298
$args = $_SERVER['argv'];

0 commit comments

Comments
 (0)