Changeset 61512

Timestamp:

01/22/2026 11:15:34 PM (4 months ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing parameter descriptions for get_cli_args().

Follow-up to [14760].

Props rejaulalomkhan, huzaifaalmesbah, westonruter, SergeyBiryukov.
See #64224.

File:

• trunk/src/wp-admin/includes/class-wp-importer.php (modified) (1 diff)

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

@@ -290 +290 @@
  * Exits when a required param is not set.
  *
- * @param string $param
- * @param bool   $required
- * @return mixed
+ * @param string $param    The parameter name to retrieve.
+ * @param bool   $required Optional. Whether the parameter is required. Default false.
+ * @return string|true|null|never The parameter value or true if found, null otherwise.
+ *                                The function exits when a required parameter is missing.
  */
 function get_cli_args( $param, $required = false ) {