sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

phpDoc corrections for comment.php, props jacobsantos, fixes #7550

Browse Source 
git-svn-id: https://develop.svn.wordpress.org/trunk@8956 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Ozz 2008-09-22 20:21:10 +00:00
parent a055ab0699
commit 85a802aeb9
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
wp-includes/comment.php
View File

@ -14,6 +14,10 @@
* links exceeds the amount in the administration, then the check fails. If any * links exceeds the amount in the administration, then the check fails. If any
* of the parameter contents match the blacklist of words, then the check fails. * of the parameter contents match the blacklist of words, then the check fails.
* *
* If the number of links exceeds the amount in the administration, then the
* check fails. If any of the parameter contents match the blacklist of words,
* then the check fails.
*
* If the comment is a trackback and part of the blogroll, then the trackback is * If the comment is a trackback and part of the blogroll, then the trackback is
* automatically whitelisted. If the comment author was approved before, then * automatically whitelisted. If the comment author was approved before, then
* the comment is automatically whitelisted. * the comment is automatically whitelisted.
@ -116,6 +120,9 @@ function get_approved_comments($post_id) {
* after being passed through a filter. If the comment is empty, then the global * after being passed through a filter. If the comment is empty, then the global
* comment variable will be used, if it is set. * comment variable will be used, if it is set.
* *
* If the comment is empty, then the global comment variable will be used, if it
* is set.
*
* @since 2.0.0 * @since 2.0.0
* @uses $wpdb * @uses $wpdb
* *
@ -591,7 +598,7 @@ function wp_count_comments( $post_id = 0 ) {
* @uses do_action() Calls 'wp_set_comment_status' hook on comment ID with 'delete' set for the second parameter * @uses do_action() Calls 'wp_set_comment_status' hook on comment ID with 'delete' set for the second parameter
* *
* @param int $comment_id Comment ID * @param int $comment_id Comment ID
* @return bool False if delete comment query failure, true on success * @return bool False if delete comment query failure, true on success.
*/ */
function wp_delete_comment($comment_id) { function wp_delete_comment($comment_id) {
global $wpdb; global $wpdb;
@ -727,8 +734,8 @@ function wp_insert_comment($commentdata) {
* @uses apply_filters() Calls 'pre_comment_author_url' hook on comment author's URL * @uses apply_filters() Calls 'pre_comment_author_url' hook on comment author's URL
* @uses apply_filters() Calls 'pre_comment_author_email' hook on comment author's email address * @uses apply_filters() Calls 'pre_comment_author_email' hook on comment author's email address
* *
* @param array $commentdata Contains information on the comment * @param array $commentdata Contains information on the comment.
* @return array Parsed comment information * @return array Parsed comment information.
*/ */
function wp_filter_comment($commentdata) { function wp_filter_comment($commentdata) {
$commentdata['user_id'] = apply_filters('pre_user_id', $commentdata['user_ID']); $commentdata['user_id'] = apply_filters('pre_user_id', $commentdata['user_ID']);
@ -775,7 +782,7 @@ function wp_throttle_comment_flood($block, $time_lastcomment, $time_newcomment)
* @uses wp_allow_comment() checks to see if comment is approved. * @uses wp_allow_comment() checks to see if comment is approved.
* @uses wp_insert_comment() Does the actual comment insertion to the database. * @uses wp_insert_comment() Does the actual comment insertion to the database.
* *
* @param array $commentdata Contains information on the comment * @param array $commentdata Contains information on the comment.
* @return int The ID of the comment after adding. * @return int The ID of the comment after adding.
*/ */
function wp_new_comment( $commentdata ) { function wp_new_comment( $commentdata ) {