Docs: Improve the documentation for parameters which accept OBJECT, ARRAY_A, and ARRAY_N as parameters.

See #37770


git-svn-id: https://develop.svn.wordpress.org/trunk@39188 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2016-11-09 22:59:02 +00:00
parent 28e538bf80
commit 9ac95f7650
7 changed files with 46 additions and 38 deletions
+2 -1
View File
@@ -170,7 +170,8 @@ function get_approved_comments( $post_id, $args = array() ) {
* @global WP_Comment $comment
*
* @param WP_Comment|string|int $comment Comment to retrieve.
* @param string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants.
* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
* a WP_Comment object, an associative array, or a numeric array, respectively. Default OBJECT.
* @return WP_Comment|array|null Depends on $output value.
*/
function get_comment( &$comment = null, $output = OBJECT ) {