[ Index ]

PHP Cross Reference of WordPress




/wp-admin/includes/ -> comment.php (summary)

WordPress Comment Administration API.

File Size: 217 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions


Functions that are not part of a class:

comment_exists( $comment_author, $comment_date, $timezone = 'blog' )   X-Ref
Determine if a comment exists based on author and date.

For best performance, use `$timezone = 'gmt'`, which queries a field that is properly indexed. The default value
for `$timezone` is 'blog' for legacy reasons.

return: string|null Comment post ID on success.
since: 2.0.0
since: 4.4.0 Added the `$timezone` parameter.
param: string $comment_author Author of the comment.
param: string $comment_date   Date of the comment.
param: string $timezone       Timezone. Accepts 'blog' or 'gmt'. Default 'blog'.

edit_comment()   X-Ref
Update a comment with values provided in $_POST.

return: int|WP_Error The value 1 if the comment was updated, 0 if not updated.
since: 2.0.0
since: 5.5.0 A return value was added.

get_comment_to_edit( $id )   X-Ref
Returns a WP_Comment object based on comment ID.

return: WP_Comment|false Comment if found. False on failure.
since: 2.0.0
param: int $id ID of comment to retrieve.

get_pending_comments_num( $post_id )   X-Ref
Get the number of pending comments on a post or posts

return: int|int[] Either a single Posts pending comments as an int or an array of ints keyed on the Post IDs
since: 2.3.0
param: int|int[] $post_id Either a single Post ID or an array of Post IDs

floated_admin_avatar( $name )   X-Ref
Adds avatars to relevant places in admin.

return: string Avatar with the user name.
since: 2.5.0
param: string $name User name.

enqueue_comment_hotkeys_js()   X-Ref

since: 2.7.0

comment_footer_die( $msg )   X-Ref
Display error message at bottom of comments.

param: string $msg Error Message. Assumed to contain HTML and be sanitized.

Generated: Tue Apr 16 01:00:02 2024 Cross-referenced by PHPXref 0.7.1