enmi-conf.org: comparison wp/wp-includes/comment.php

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 * @param string                $output  Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
 *                                       correspond to a WP_Comment object, an associative array, or a numeric array,
 *                                       respectively. Default OBJECT.
 * @return WP_Comment|array|null Depends on $output value.
 */
-function get_comment( &$comment = null, $output = OBJECT ) {
+function get_comment( $comment = null, $output = OBJECT ) {
 	if ( empty( $comment ) && isset( $GLOBALS['comment'] ) ) {
 		$comment = $GLOBALS['comment'];
 	}
 	if ( $comment instanceof WP_Comment ) {
 	 *
 	 * @param WP_Comment $_comment Comment data.
 	 */
 	$_comment = apply_filters( 'get_comment', $_comment );
-	if ( OBJECT == $output ) {
+	if ( OBJECT === $output ) {
 		return $_comment;
-	} elseif ( ARRAY_A == $output ) {
+	} elseif ( ARRAY_A === $output ) {
 		return $_comment->to_array();
-	} elseif ( ARRAY_N == $output ) {
+	} elseif ( ARRAY_N === $output ) {
 		return array_values( $_comment->to_array() );
 	}
 	return $_comment;
 }
 * @param int    $comment_id Comment ID.
 * @param string $meta_key   Metadata name.
 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
 * @param bool   $unique     Optional. Whether the same key should not be added.
 *                           Default false.
-* @return int|bool Meta ID on success, false on failure.
+* @return int|false Meta ID on success, false on failure.
 */
 function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {
 	return add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );
 }
 *
 * @param int    $comment_id Comment ID.
 * @param string $key        Optional. The meta key to retrieve. By default,
 *                           returns data for all keys.
 * @param bool   $single     Optional. Whether to return a single value.
-*                           This parameter has no effect if $key is not specified.
+*                           This parameter has no effect if `$key` is not specified.
 *                           Default false.
-* @return mixed An array if $single is false. The value of meta data field
+* @return mixed An array of values if `$single` is false.
-*               if $single is true. False for an invalid $comment_id.
+*               The value of meta data field if `$single` is true.
+*               False for an invalid `$comment_id` (non-numeric, zero, or negative value).
+*               An empty string if a valid but non-existing comment ID is passed.
 */
 function get_comment_meta( $comment_id, $key = '', $single = false ) {
 	return get_metadata( 'comment', $comment_id, $key, $single );
 }
 		 *
 		 * @since 1.5.0
 		 *
 		 * @param string $author_cookie The comment author name cookie.
 		 */
-		$comment_author                            = apply_filters( 'pre_comment_author_name', $_COOKIE[ 'comment_author_' . COOKIEHASH ] );
+		$comment_author = apply_filters( 'pre_comment_author_name', $_COOKIE[ 'comment_author_' . COOKIEHASH ] );
-		$comment_author                            = wp_unslash( $comment_author );
+		$comment_author = wp_unslash( $comment_author );
-		$comment_author                            = esc_attr( $comment_author );
+		$comment_author = esc_attr( $comment_author );
 		$_COOKIE[ 'comment_author_' . COOKIEHASH ] = $comment_author;
 	}
 	if ( isset( $_COOKIE[ 'comment_author_email_' . COOKIEHASH ] ) ) {
 		/**
 		 *
 		 * @since 1.5.0
 		 *
 		 * @param string $author_email_cookie The comment author email cookie.
 		 */
-		$comment_author_email                            = apply_filters( 'pre_comment_author_email', $_COOKIE[ 'comment_author_email_' . COOKIEHASH ] );
+		$comment_author_email = apply_filters( 'pre_comment_author_email', $_COOKIE[ 'comment_author_email_' . COOKIEHASH ] );
-		$comment_author_email                            = wp_unslash( $comment_author_email );
+		$comment_author_email = wp_unslash( $comment_author_email );
-		$comment_author_email                            = esc_attr( $comment_author_email );
+		$comment_author_email = esc_attr( $comment_author_email );
 		$_COOKIE[ 'comment_author_email_' . COOKIEHASH ] = $comment_author_email;
 	}
 	if ( isset( $_COOKIE[ 'comment_author_url_' . COOKIEHASH ] ) ) {
 		/**
 		 *
 		 * @since 1.5.0
 		 *
 		 * @param string $author_url_cookie The comment author URL cookie.
 		 */
-		$comment_author_url                            = apply_filters( 'pre_comment_author_url', $_COOKIE[ 'comment_author_url_' . COOKIEHASH ] );
+		$comment_author_url = apply_filters( 'pre_comment_author_url', $_COOKIE[ 'comment_author_url_' . COOKIEHASH ] );
-		$comment_author_url                            = wp_unslash( $comment_author_url );
+		$comment_author_url = wp_unslash( $comment_author_url );
 		$_COOKIE[ 'comment_author_url_' . COOKIEHASH ] = $comment_author_url;
 	}
 }
 /**
 				break;
 			}
 			if ( ! is_array( $col_length ) && (int) $col_length > 0 ) {
 				$max_length = (int) $col_length;
-			} elseif ( is_array( $col_length ) && isset( $col_length['length'] ) && intval( $col_length['length'] ) > 0 ) {
+			} elseif ( is_array( $col_length ) && isset( $col_length['length'] ) && (int) $col_length['length'] > 0 ) {
 				$max_length = (int) $col_length['length'];
 				if ( ! empty( $col_length['type'] ) && 'byte' === $col_length['type'] ) {
 					$max_length = $max_length - 10;
 				}
 * Get unapproved comment author's email.
 *
 * Used to allow the commenter to see their pending comment.
 *
 * @since 5.1.0
+* @since 5.7.0 The window within which the author email for an unapproved comment
+*              can be retrieved was extended to 10 minutes.
 *
 * @return string The unapproved comment author's email (when supplied).
 */
 function wp_get_unapproved_comment_author_email() {
 	$commenter_email = '';
 	if ( ! empty( $_GET['unapproved'] ) && ! empty( $_GET['moderation-hash'] ) ) {
 		$comment_id = (int) $_GET['unapproved'];
 		$comment    = get_comment( $comment_id );
 		if ( $comment && hash_equals( $_GET['moderation-hash'], wp_hash( $comment->comment_date_gmt ) ) ) {
-			// The comment will only be viewable by the comment author for 1 minute.
+			// The comment will only be viewable by the comment author for 10 minutes.
-			$comment_preview_expires = strtotime( $comment->comment_date_gmt . '+1 minute' );
+			$comment_preview_expires = strtotime( $comment->comment_date_gmt . '+10 minutes' );
 			if ( time() < $comment_preview_expires ) {
 				$commenter_email = $comment->comment_author_email;
 			}
 		}
 		$commentdata['user_id'] = $commentdata['user_ID'];
 	}
 	$prefiltered_user_id = ( isset( $commentdata['user_id'] ) ) ? (int) $commentdata['user_id'] : 0;
+	if ( ! isset( $commentdata['comment_author_IP'] ) ) {
+		$commentdata['comment_author_IP'] = $_SERVER['REMOTE_ADDR'];
+	}
+	if ( ! isset( $commentdata['comment_agent'] ) ) {
+		$commentdata['comment_agent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT'] : '';
+	}
 	/**
 	 * Filters a comment's data before it is sanitized and inserted into the database.
 	 *
 	 * @since 1.5.0
+	 * @since 5.6.0 Comment data includes the `comment_agent` and `comment_author_IP` values.
 	 *
 	 * @param array $commentdata Comment data.
 	 */
 	$commentdata = apply_filters( 'preprocess_comment', $commentdata );
 	$parent_status = ( $commentdata['comment_parent'] > 0 ) ? wp_get_comment_status( $commentdata['comment_parent'] ) : '';
 	$commentdata['comment_parent'] = ( 'approved' === $parent_status || 'unapproved' === $parent_status ) ? $commentdata['comment_parent'] : 0;
-	if ( ! isset( $commentdata['comment_author_IP'] ) ) {
-		$commentdata['comment_author_IP'] = $_SERVER['REMOTE_ADDR'];
-	}
 	$commentdata['comment_author_IP'] = preg_replace( '/[^0-9a-fA-F:., ]/', '', $commentdata['comment_author_IP'] );
-	if ( ! isset( $commentdata['comment_agent'] ) ) {
-		$commentdata['comment_agent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT'] : '';
-	}
 	$commentdata['comment_agent'] = substr( $commentdata['comment_agent'], 0, 254 );
 	if ( empty( $commentdata['comment_date'] ) ) {
 		$commentdata['comment_date'] = current_time( 'mysql' );
 	}
 	clean_comment_cache( $comment_old->comment_ID );
 	$comment = get_comment( $comment_old->comment_ID );
 	/**
-	 * Fires immediately before transitioning a comment's status from one to another
+	 * Fires immediately after transitioning a comment's status from one to another in the database
-	 * in the database.
+	 * and removing the comment from the object cache, but prior to all status transition hooks.
 	 *
 	 * @since 1.5.0
 	 *
-	 * @param int         $comment_id     Comment ID.
+	 * @param int    $comment_id     Comment ID.
-	 * @param string|bool $comment_status Current comment status. Possible values include
+	 * @param string $comment_status Current comment status. Possible values include
-	 *                                    'hold', 'approve', 'spam', 'trash', or false.
+	 *                               'hold', '0', 'approve', '1', 'spam', and 'trash'.
 	 */
 	do_action( 'wp_set_comment_status', $comment->comment_ID, $comment_status );
 	wp_transition_comment_status( $comment_status, $comment_old->comment_approved, $comment );
 * check for the rel="pingback" has more overhead than just the header.
 *
 * @since 1.5.0
 *
 * @param string $url        URL to ping.
-* @param int    $deprecated Not Used.
+* @param string $deprecated Not Used.
 * @return string|false String containing URI on success, false on failure.
 */
 function discover_pingback_server_uri( $url, $deprecated = '' ) {
 	if ( ! empty( $deprecated ) ) {
 		_deprecated_argument( __FUNCTION__, '2.7.0' );
 /**
 * Perform all pingbacks, enclosures, trackbacks, and send to pingback services.
 *
 * @since 2.1.0
-*
+* @since 5.6.0 Introduced `do_all_pings` action hook for individual services.
-* @global wpdb $wpdb WordPress database abstraction object.
 */
 function do_all_pings() {
-	global $wpdb;
+	/**
+	 * Fires immediately after the `do_pings` event to hook services individually.
-	// Do pingbacks.
+	 *
+	 * @since 5.6.0
+	 */
+	do_action( 'do_all_pings' );
+}
+/**
+* Perform all pingbacks.
+*
+* @since 5.6.0
+*/
+function do_all_pingbacks() {
 	$pings = get_posts(
 		array(
 			'post_type'        => get_post_types(),
 			'suppress_filters' => false,
 			'nopaging'         => true,
 	foreach ( $pings as $ping ) {
 		delete_post_meta( $ping, '_pingme' );
 		pingback( null, $ping );
 	}
+}
-	// Do enclosures.
+/**
+* Perform all enclosures.
+*
+* @since 5.6.0
+*/
+function do_all_enclosures() {
 	$enclosures = get_posts(
 		array(
 			'post_type'        => get_post_types(),
 			'suppress_filters' => false,
 			'nopaging'         => true,
 	foreach ( $enclosures as $enclosure ) {
 		delete_post_meta( $enclosure, '_encloseme' );
 		do_enclose( null, $enclosure );
 	}
+}
-	// Do trackbacks.
+/**
+* Perform all trackbacks.
+*
+* @since 5.6.0
+*/
+function do_all_trackbacks() {
 	$trackbacks = get_posts(
 		array(
 			'post_type'        => get_post_types(),
 			'suppress_filters' => false,
 			'nopaging'         => true,
 	foreach ( $trackbacks as $trackback ) {
 		delete_post_meta( $trackback, '_trackbackme' );
 		do_trackbacks( $trackback );
 	}
-	// Do Update Services/Generic Pings.
-	generic_ping();
 }
 /**
 * Perform trackbacks.
 *
 function _prime_comment_caches( $comment_ids, $update_meta_cache = true ) {
 	global $wpdb;
 	$non_cached_ids = _get_non_cached_ids( $comment_ids, 'comment' );
 	if ( ! empty( $non_cached_ids ) ) {
-		$fresh_comments = $wpdb->get_results( sprintf( "SELECT $wpdb->comments.* FROM $wpdb->comments WHERE comment_ID IN (%s)", join( ',', array_map( 'intval', $non_cached_ids ) ) ) );
+		$fresh_comments = $wpdb->get_results( sprintf( "SELECT $wpdb->comments.* FROM $wpdb->comments WHERE comment_ID IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) );
 		update_comment_cache( $fresh_comments, $update_meta_cache );
 	}
 }
 					break;
 				case 'comment_link':
 					$value = get_comment_link( $comment->comment_ID );
 					$value = sprintf(
-						'<a href="%s" target="_blank" rel="noreferrer noopener">%s</a>',
+						'<a href="%s" target="_blank" rel="noopener">%s</a>',
 						esc_url( $value ),
 						esc_html( $value )
 					);
 					break;
 			}

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 19	3d72ae0968f4