]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/comment.php
WordPress 4.4.1
[autoinstalls/wordpress.git] / wp-admin / includes / comment.php
index 26f25564a184a1707adb807035ed81a26bcf8bbd..3037c4102e744b4444c3cdd40271f2ac400e4c43 100644 (file)
@@ -4,46 +4,62 @@
  *
  * @package WordPress
  * @subpackage Administration
+ * @since 2.3.0
  */
 
 /**
- * {@internal Missing Short Description}}
+ * Determine if a comment exists based on author and date.
  *
- * @since unknown
- * @uses $wpdb
+ * For best performance, use `$timezone = 'gmt'`, which queries a field that is properly indexed. The default value
+ * for `$timezone` is 'blog' for legacy reasons.
  *
- * @param string $comment_author
- * @param string $comment_date
- * @return mixed Comment ID on success.
+ * @since 2.0.0
+ * @since 4.4.0 Added the `$timezone` parameter.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @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'.
+ *
+ * @return mixed Comment post ID on success.
  */
-function comment_exists($comment_author, $comment_date) {
+function comment_exists( $comment_author, $comment_date, $timezone = 'blog' ) {
        global $wpdb;
 
-       $comment_author = stripslashes($comment_author);
-       $comment_date = stripslashes($comment_date);
+       $date_field = 'comment_date';
+       if ( 'gmt' === $timezone ) {
+               $date_field = 'comment_date_gmt';
+       }
 
        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) );
+                       WHERE comment_author = %s AND $date_field = %s",
+                       stripslashes( $comment_author ),
+                       stripslashes( $comment_date )
+       ) );
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Update a comment with values provided in $_POST.
  *
- * @since unknown
+ * @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] ) {
@@ -52,7 +68,7 @@ function edit_comment() {
                }
        }
 
-       if (!empty ( $_POST['edit_date'] ) ) {
+       if ( !empty ( $_POST['edit_date'] ) ) {
                $aa = $_POST['aa'];
                $mm = $_POST['mm'];
                $jj = $_POST['jj'];
@@ -66,16 +82,16 @@ function edit_comment() {
                $_POST['comment_date'] = "$aa-$mm-$jj $hh:$mn:$ss";
        }
 
-       wp_update_comment( $_POST);
+       wp_update_comment( $_POST );
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Returns a WP_Comment object based on comment ID.
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @param unknown_type $id
- * @return unknown
+ * @param int $id ID of comment to retrieve.
+ * @return WP_Comment|false Comment if found. False on failure.
  */
 function get_comment_to_edit( $id ) {
        if ( !$comment = get_comment($id) )
@@ -85,7 +101,14 @@ 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 );
@@ -96,36 +119,46 @@ function get_comment_to_edit( $id ) {
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Get the number of pending comments on a post or posts
+ *
+ * @since 2.3.0
  *
- * @since unknown
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int $post_id Post ID
- * @return unknown
+ * @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;
 }
@@ -133,35 +166,31 @@ function get_pending_comments_num( $post_id ) {
 /**
  * Add avatars to relevant places in admin, or try to.
  *
- * @since unknown
- * @uses $comment
+ * @since 2.5.0
  *
  * @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( get_comment(), 32, 'mystery' );
        return "$avatar $name";
 }
 
+/**
+ * @since 2.7.0
+ */
 function enqueue_comment_hotkeys_js() {
        if ( 'true' == get_user_option( 'comment_shortcuts' ) )
                wp_enqueue_script( 'jquery-table-hotkeys' );
 }
 
-if ( is_admin() && isset($pagenow) && ('edit-comments.php' == $pagenow || 'edit.php' == $pagenow) ) {
-       if ( get_option('show_avatars') )
-               add_filter( 'comment_author', 'floated_admin_avatar' );
-}
-
-?>
+/**
+ * Display error message at bottom of comments.
+ *
+ * @param string $msg Error Message. Assumed to contain HTML and be sanitized.
+ */
+function comment_footer_die( $msg ) {
+       echo "<div class='wrap'><p>$msg</p></div>";
+       include( ABSPATH . 'wp-admin/admin-footer.php' );
+       die;
+}
\ No newline at end of file