Opened 10 years ago
Closed 10 years ago
#31747 closed defect (bug) (fixed)
wp_insert_comment better docstrings
Reported by: | lamosty | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | 4.3 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Comments | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
Function wp_insert_comment has incomplete docstring documentation. Its docstring says
The available comment data key names are 'comment_author_IP', 'comment_date', 'comment_date_gmt', 'comment_parent', 'comment_approved', and 'user_id'.
but the function accepts additional arguments through $commentdata assoc array, such as comment_type or comment_content.
Docstring could be enhanced to have a format like in the case of wp_insert_post function (=> argument type with a short description of what the argument does).
Attachments (2)
Change History (9)
Note: See
TracTickets for help on using
tickets.
Update docs of wp_insert_comment function