Wordpress 3.7
[autoinstalls/wordpress.git] / wp-admin / includes / comment.php
index 0f2aa6140a7a29a5cef2b669aea72ce8289a962c..a74eeaac2275dfb8f2ec53850a5af746d5e7bd0d 100644 (file)
@@ -1,25 +1,53 @@
 <?php
-
+/**
+ * WordPress Comment Administration API.
+ *
+ * @package WordPress
+ * @subpackage Administration
+ */
+
+/**
+ * Determine if a comment exists based on author and date.
+ *
+ * @since 2.0.0
+ * @uses $wpdb
+ *
+ * @param string $comment_author Author of the comment
+ * @param string $comment_date Date of the comment
+ * @return mixed Comment post ID on success.
+ */
 function comment_exists($comment_author, $comment_date) {
        global $wpdb;
 
-       return $wpdb->get_var("SELECT comment_post_ID FROM $wpdb->comments
-                       WHERE comment_author = '$comment_author' AND comment_date = '$comment_date'");
+       $comment_author = stripslashes($comment_author);
+       $comment_date = stripslashes($comment_date);
+
+       return $wpdb->get_var( $wpdb->prepare("SELECT comment_post_ID FROM $wpdb->comments
+                       WHERE comment_author = %s AND comment_date = %s", $comment_author, $comment_date) );
 }
 
+/**
+ * Update a comment with values provided in $_POST.
+ *
+ * @since 2.0.0
+ */
 function edit_comment() {
 
-       $comment_post_ID = (int) $_POST['comment_post_ID'];
-
-       if (!current_user_can( 'edit_post', $comment_post_ID ))
-               wp_die( __('You are not allowed to edit comments on this post, so you cannot edit this comment.' ));
-
-       $_POST['comment_author'] = $_POST['newcomment_author'];
-       $_POST['comment_author_email'] = $_POST['newcomment_author_email'];
-       $_POST['comment_author_url'] = $_POST['newcomment_author_url'];
-       $_POST['comment_approved'] = $_POST['comment_status'];
-       $_POST['comment_content'] = $_POST['content'];
-       $_POST['comment_ID'] = (int) $_POST['comment_ID'];
+       if ( ! current_user_can( 'edit_comment', (int) $_POST['comment_ID'] ) )
+               wp_die ( __( 'You are not allowed to edit comments on this post.' ) );
+
+       if ( isset( $_POST['newcomment_author'] ) )
+               $_POST['comment_author'] = $_POST['newcomment_author'];
+       if ( isset( $_POST['newcomment_author_email'] ) )
+               $_POST['comment_author_email'] = $_POST['newcomment_author_email'];
+       if ( isset( $_POST['newcomment_author_url'] ) )
+               $_POST['comment_author_url'] = $_POST['newcomment_author_url'];
+       if ( isset( $_POST['comment_status'] ) )
+               $_POST['comment_approved'] = $_POST['comment_status'];
+       if ( isset( $_POST['content'] ) )
+               $_POST['comment_content'] = $_POST['content'];
+       if ( isset( $_POST['comment_ID'] ) )
+               $_POST['comment_ID'] = (int) $_POST['comment_ID'];
 
        foreach ( array ('aa', 'mm', 'jj', 'hh', 'mn') as $timeunit ) {
                if ( !empty( $_POST['hidden_' . $timeunit] ) && $_POST['hidden_' . $timeunit] != $_POST[$timeunit] ) {
@@ -28,8 +56,7 @@ function edit_comment() {
                }
        }
 
-
-       if (!empty ( $_POST['edit_date'] ) ) {
+       if ( !empty ( $_POST['edit_date'] ) ) {
                $aa = $_POST['aa'];
                $mm = $_POST['mm'];
                $jj = $_POST['jj'];
@@ -43,9 +70,17 @@ function edit_comment() {
                $_POST['comment_date'] = "$aa-$mm-$jj $hh:$mn:$ss";
        }
 
-       wp_update_comment( $_POST);
+       wp_update_comment( $_POST );
 }
 
+/**
+ * Returns a comment object based on comment ID.
+ *
+ * @since 2.0.0
+ *
+ * @param int $id ID of comment to retrieve.
+ * @return bool|object Comment if found. False on failure.
+ */
 function get_comment_to_edit( $id ) {
        if ( !$comment = get_comment($id) )
                return false;
@@ -54,62 +89,83 @@ function get_comment_to_edit( $id ) {
        $comment->comment_post_ID = (int) $comment->comment_post_ID;
 
        $comment->comment_content = format_to_edit( $comment->comment_content );
-       $comment->comment_content = apply_filters( 'comment_edit_pre', $comment->comment_content);
+       /**
+        * Filter the comment content before editing.
+        *
+        * @since 2.0.0
+        *
+        * @param string $comment->comment_content Comment content.
+        */
+       $comment->comment_content = apply_filters( 'comment_edit_pre', $comment->comment_content );
 
        $comment->comment_author = format_to_edit( $comment->comment_author );
        $comment->comment_author_email = format_to_edit( $comment->comment_author_email );
-       $comment->comment_author_url = clean_url($comment->comment_author_url);
        $comment->comment_author_url = format_to_edit( $comment->comment_author_url );
+       $comment->comment_author_url = esc_url($comment->comment_author_url);
 
        return $comment;
 }
 
+/**
+ * Get the number of pending comments on a post or posts
+ *
+ * @since 2.3.0
+ * @uses $wpdb
+ *
+ * @param int|array $post_id Either a single Post ID or an array of Post IDs
+ * @return int|array Either a single Posts pending comments as an int or an array of ints keyed on the Post IDs
+ */
 function get_pending_comments_num( $post_id ) {
        global $wpdb;
 
        $single = false;
        if ( !is_array($post_id) ) {
-               $post_id = (array) $post_id;
+               $post_id_array = (array) $post_id;
                $single = true;
+       } else {
+               $post_id_array = $post_id;
        }
-       $post_id = array_map('intval', $post_id);
-       $post_id = "'" . implode("', '", $post_id) . "'";
-
-       $pending = $wpdb->get_results( "SELECT comment_post_ID, COUNT(comment_ID) as num_comments FROM $wpdb->comments WHERE comment_post_ID IN ( $post_id ) AND comment_approved = '0' GROUP BY comment_post_ID", ARRAY_N );
+       $post_id_array = array_map('intval', $post_id_array);
+       $post_id_in = "'" . implode("', '", $post_id_array) . "'";
 
-       if ( empty($pending) )
-               return 0;
+       $pending = $wpdb->get_results( "SELECT comment_post_ID, COUNT(comment_ID) as num_comments FROM $wpdb->comments WHERE comment_post_ID IN ( $post_id_in ) AND comment_approved = '0' GROUP BY comment_post_ID", ARRAY_A );
 
-       if ( $single )
-               return $pending[0][1];
+       if ( $single ) {
+               if ( empty($pending) )
+                       return 0;
+               else
+                       return absint($pending[0]['num_comments']);
+       }
 
        $pending_keyed = array();
-       foreach ( $pending as $pend )
-               $pending_keyed[$pend[0]] = $pend[1];
+
+       // Default to zero pending for all posts in request
+       foreach ( $post_id_array as $id )
+               $pending_keyed[$id] = 0;
+
+       if ( !empty($pending) )
+               foreach ( $pending as $pend )
+                       $pending_keyed[$pend['comment_post_ID']] = absint($pend['num_comments']);
 
        return $pending_keyed;
 }
 
-// Add avatars to relevant places in admin, or try to
-
+/**
+ * Add avatars to relevant places in admin, or try to.
+ *
+ * @since 2.5.0
+ * @uses $comment
+ *
+ * @param string $name User name.
+ * @return string Avatar with Admin name.
+ */
 function floated_admin_avatar( $name ) {
        global $comment;
-
-       $id = $avatar = false;
-       if ( $comment->comment_author_email )
-               $id = $comment->comment_author_email;
-       if ( $comment->user_id )
-               $id = $comment->user_id;
-
-       if ( $id )
-               $avatar = get_avatar( $id, 32 );
-
+       $avatar = get_avatar( $comment, 32, 'mystery' );
        return "$avatar $name";
 }
 
-if ( is_admin() && ('edit-comments.php' == $pagenow || 'edit.php' == $pagenow) ) {
-       if ( get_option('show_avatars') )
-               add_filter( 'comment_author', 'floated_admin_avatar' );
+function enqueue_comment_hotkeys_js() {
+       if ( 'true' == get_user_option( 'comment_shortcuts' ) )
+               wp_enqueue_script( 'jquery-table-hotkeys' );
 }
-
-?>