get_comment( WP_Comment|string|int $comment = null, string $output = OBJECT )
Retrieves comment data given a comment ID or comment object.
Description
If an object is passed then the comment data will be cached and then returned after being passed through a filter. If the comment is empty, then the global comment variable will be used, if it is set.
Parameters
- $comment
-
(WP_Comment|string|int) (Optional) Comment to retrieve.
Default value: null
- $output
-
(string) (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 value: OBJECT
Return
(WP_Comment|array|null) Depends on $output value.
Source
File: wp-includes/comment.php
function get_comment( &$comment = null, $output = OBJECT ) {
if ( empty( $comment ) && isset( $GLOBALS['comment'] ) ) {
$comment = $GLOBALS['comment'];
}
if ( $comment instanceof WP_Comment ) {
$_comment = $comment;
} elseif ( is_object( $comment ) ) {
$_comment = new WP_Comment( $comment );
} else {
$_comment = WP_Comment::get_instance( $comment );
}
if ( ! $_comment ) {
return null;
}
/**
* Fires after a comment is retrieved.
*
* @since WP-2.3.0
*
* @param mixed $_comment Comment data.
*/
$_comment = apply_filters( 'get_comment', $_comment );
if ( $output == OBJECT ) {
return $_comment;
} elseif ( $output == ARRAY_A ) {
return $_comment->to_array();
} elseif ( $output == ARRAY_N ) {
return array_values( $_comment->to_array() );
}
return $_comment;
}
Changelog
| Version | Description |
|---|---|
| WP-2.0.0 | Introduced. |