WordPress 4.4
[autoinstalls/wordpress.git] / wp-admin / includes / comment.php
index 8458911575e1a8e68dffcdcd702e29d3e6872e46..3037c4102e744b4444c3cdd40271f2ac400e4c43 100644 (file)
@@ -4,26 +4,39 @@
  *
  * @package WordPress
  * @subpackage Administration
+ * @since 2.3.0
  */
 
 /**
- * {@internal Missing Short Description}}
+ * Determine if a comment exists based on author and date.
+ *
+ * For best performance, use `$timezone = 'gmt'`, which queries a field that is properly indexed. The default value
+ * for `$timezone` is 'blog' for legacy reasons.
  *
  * @since 2.0.0
- * @uses $wpdb
+ * @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'.
  *
- * @param string $comment_author Author of the comment
- * @param string $comment_date Date of the comment
- * @return mixed Comment ID on success.
+ * @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 )
+       ) );
 }
 
 /**
@@ -32,16 +45,21 @@ function comment_exists($comment_author, $comment_date) {
  * @since 2.0.0
  */
 function edit_comment() {
-
        if ( ! current_user_can( 'edit_comment', (int) $_POST['comment_ID'] ) )
                wp_die ( __( 'You are not allowed to edit comments on this post.' ) );
 
-       $_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 ( 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] ) {
@@ -68,12 +86,12 @@ function edit_comment() {
 }
 
 /**
- * {@internal Missing Short Description}}
+ * Returns a WP_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.
+ * @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) )
@@ -83,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 );
@@ -97,7 +122,8 @@ function get_comment_to_edit( $id ) {
  * Get the number of pending comments on a post or posts
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @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
@@ -141,18 +167,30 @@ function get_pending_comments_num( $post_id ) {
  * 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;
-       $avatar = get_avatar( $comment, 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' );
 }
+
+/**
+ * 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