Changeset 6553

Timestamp:

01/04/08 20:03:42 (8 months ago)

Author:

ryan

Message:

phpdoc for comment.php from darkdragon. fixes #5578

Files:

• trunk/wp-includes/comment.php (modified) (32 diffs)

trunk/wp-includes/comment.php

@@ -1 +1 @@
-<?php
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $comment_type) {
-    global $wpdb;
@@ -61 +83 @@
-}
-
-
+
+
+
+
+
+
+
+
+
-function get_approved_comments($post_id) {
-    global $wpdb;
@@ -67 +97 @@
-}
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function &get_comment(&$comment, $output = OBJECT) {
-    global $wpdb;
@@ -103 +142 @@
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_commentdata( $comment_ID, $no_cache = 0, $include_unapproved = false ) { // less flexible, but saves DB queries
-    global $postc, $wpdb;
@@ -128 +186 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function get_lastcommentmodified($timezone = 'server') {
-    global $cache_lastcommentmodified, $wpdb;
@@ -152 +221 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function get_comment_count( $post_id = 0 ) {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function sanitize_comment_cookies() {
-    if ( isset($_COOKIE['comment_author_'.COOKIEHASH]) ) {
@@ -222 +309 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_allow_comment($commentdata) {
-    global $wpdb;
@@ -261 +360 @@
-}
-
+/**
+ * check_comment_flood_db() - {@internal Missing Short Description}}
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 2.3.0
+ * @uses $wpdb
+ * @uses apply_filters() {@internal Missing Description}}
+ * @uses do_action() {@internal Missing Description}}
+ *
+ * @param string $ip {@internal Missing Description}}
+ * @param string $email {@internal Missing Description}}
+ * @param unknown_type $date {@internal Missing Description}}
+ */
-function check_comment_flood_db( $ip, $email, $date ) {
-    global $wpdb;
@@ -274 +387 @@
-}
-
+/**
+ * wp_blacklist_check() - Does comment contain blacklisted characters or words
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 1.5.0
+ * @uses do_action() Calls 'wp_blacklist_check' hook for all parameters
+ *
+ * @param string $author The author of the comment
+ * @param string $email The email of the comment
+ * @param string $url The url used in the comment
+ * @param string $comment The comment content
+ * @param string $user_ip The comment author IP address
+ * @param string $user_agent The author's browser user agent
+ * @return bool True if comment contains blacklisted content, false if comment does not
+ */
-function wp_blacklist_check($author, $email, $url, $comment, $user_ip, $user_agent) {
-    do_action('wp_blacklist_check', $author, $email, $url, $comment, $user_ip, $user_agent);
@@ -316 +445 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_delete_comment($comment_id) {
-    global $wpdb;
@@ -336 +478 @@
-}
-
-
+
+
+
+
+
+
+
+
-function wp_get_comment_status($comment_id) {
-    $comment = get_comment($comment_id);
@@ -356 +505 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_get_current_commenter() {
-    // Cookies should already be sanitized.
@@ -375 +535 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function wp_insert_comment($commentdata) {
-    global $wpdb;
@@ -407 +577 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_filter_comment($commentdata) {
-    $commentdata['user_id']              = apply_filters('pre_user_id', $commentdata['user_ID']);
@@ -420 +608 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_throttle_comment_flood($block, $time_lastcomment, $time_newcomment) {
-    if ( $block ) // a plugin has already blocked... we'll let that decision stand
@@ -429 +628 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function wp_new_comment( $commentdata ) {
-    $commentdata = apply_filters('preprocess_comment', $commentdata);
@@ -463 +676 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function wp_set_comment_status($comment_id, $comment_status) {
-    global $wpdb;
@@ -496 +719 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function wp_update_comment($commentarr) {
-    global $wpdb;
@@ -538 +771 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    static $_defer = false;
-    
@@ -545 +792 @@
-        // flush any deferred counts
-        if ( !$defer )
-NULL
+null
-    }
-    
@@ -551 +798 @@
-}
-
+/**
+ * wp_update_comment_count() - Updates the comment count for post(s)
+ *
+ * When $do_deferred is false (is by default) and the comments have been
+ * set to be deferred, the post_id will be added to a queue, which will
+ * be updated at a later date and only updated once per post ID.
+ *
+ * If the comments have not be set up to be deferred, then the post will
+ * be updated. When $do_deferred is set to true, then all previous deferred
+ * post IDs will be updated along with the current $post_id.
+ *
+ * @since 2.1.0
+ * @see wp_update_comment_count_now() For what could cause a false return value
+ *
+ * @param int $post_id Post ID
+ * @param bool $do_deferred Whether to process previously deferred post comment counts
+ * @return bool True on success, false on failure
+ */
-function wp_update_comment_count($post_id, $do_deferred=false) {
-    static $_deferred = array();
@@ -558 +823 @@
-        foreach ( $_deferred as $i => $_post_id ) {
-            wp_update_comment_count_now($_post_id);
-
+ /** @todo Move this outside of the foreach and reset $_deferred to an array instead */
-        }
-    }
@@ -572 +837 @@
-}
-
+/**
+ * wp_update_comment_count_now() - Updates the comment count for the post
+ *
+ * @since 2.5
+ * @uses $wpdb
+ * @uses do_action() Calls 'wp_update_comment_count' hook on $post_id, $new, and $old
+ * @uses do_action() Calls 'edit_posts' hook on $post_id and $post
+ *
+ * @param int $post_id Post ID
+ * @return bool False on '0' $post_id or if post with ID does not exist. True on success. 
+ */
-function wp_update_comment_count_now($post_id) {
-    global $wpdb;
@@ -595 +871 @@
-}
-
-
-//
-// Ping and trackback functions.
-//
-
+/**
+ * discover_pingback_server_uri() - Finds a pingback server URI based on the given URL
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 1.5.0
+ * @uses $wp_version
+ *
+ * @param string $url URL to ping
+ * @param int $timeout_bytes Number of bytes to timeout at. Prevents big file downloads, default is 2048.
+ * @return bool|string False on failure, string containing URI on success.
+ */
-function discover_pingback_server_uri($url, $timeout_bytes = 2048) {
-    global $wp_version;
@@ -680 +967 @@
-}
-
-
+
+
+
+
+
+
+
+
-function do_all_pings() {
-    global $wpdb;
@@ -707 +1001 @@
-}
-
+/**
+ * do_trackbacks() - {@internal Missing Short Description}}
+ *
+ * {@internal Missing Long Description}}
+ *
+ * @since 1.5.0
+ * @uses $wpdb
+ *
+ * @param int $post_id Post ID to do trackbacks on
+ */
-function do_trackbacks($post_id) {
-    global $wpdb;
@@ -745 +1049 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
-function generic_ping($post_id = 0) {
-    $services = get_option('ping_sites');
@@ -759 +1072 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function pingback($content, $post_ID) {
-    global $wp_version;
@@ -825 +1149 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
-function privacy_ping_filter($sites) {
-    if ( '0' != get_option('blog_public') )
@@ -833 +1166 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function trackback($trackback_url, $title, $excerpt, $ID) {
-    global $wpdb, $wp_version;
@@ -865 +1212 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function weblog_ping($server = '', $path = '') {
-    global $wp_version;
@@ -886 +1244 @@
-//
-
+/**
+ * clean_comment_cache() - Removes comment ID from the comment cache
+ *
+ * @since 2.3.0
+ * @package WordPress
+ * @subpackage Cache
+ *
+ * @param int $id Comment ID to remove from cache
+ */
-function clean_comment_cache($id) {
-    wp_cache_delete($id, 'comment');
-}
-
+/**
+ * update_comment_cache() - Updates the comment cache of given comments
+ *
+ * Will add the comments in $comments to the cache. If comment ID already
+ * exists in the comment cache then it will not be updated.
+ *
+ * The comment is added to the cache using the comment group with the key
+ * using the ID of the comments.
+ *
+ * @since 2.3.0
+ *
+ * @param array $comments Array of comment row objects
+ */
-function update_comment_cache($comments) {
-
+(array) 
-        wp_cache_add($comment->comment_ID, $comment, 'comment');
-}