Changeset 49672 for trunk/src/wp-includes/author-template.php

Timestamp:

11/19/2020 06:22:02 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Document parameters that accept an array of integers using typed array notation.

While many of these parameters also technically accept an array of numerical strings, they are all ultimately cast to an array of integers. Documenting them as such assists developers in understanding the expected types.

See #51800, #41756

File:

• trunk/src/wp-includes/author-template.php (modified) (1 diff)

trunk/src/wp-includes/author-template.php

@@ -406 +406 @@
  *                                       will be separated by commas.
  *     @type bool         $html          Whether to list the items in HTML form or plaintext. Default true.
- *     @type array|string $exclude       Array or comma/space-separated list of author IDs to exclude. Default empty.
- *     @type array|string $include       Array or comma/space-separated list of author IDs to include. Default empty.
+ *     @type int[]|string $exclude       Array or comma/space-separated list of author IDs to exclude. Default empty.
+ *     @type int[]|string $include       Array or comma/space-separated list of author IDs to include. Default empty.
  * }
  * @return void|string Void if 'echo' argument is true, list of authors if 'echo' is false.