Changeset 53719

Timestamp:

07/19/2022 02:00:35 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Improve variable names in wp-trackback.php.

This fixes a Variable "$comment_post_ID" is not in valid snake_case format WPCS warning.

$comment_post_ID, while matching the database field of the same name, does not follow the WordPress coding standards, so the variable is now renamed to $comment_post_id.

Additionally, these variables are renamed for clarity:

• $tb_id to $post_id (this was not the trackback ID)
• $tb_url to $trackback_url

Follow-up to [172], [637], [1616],

See #55647, #56244.

Location:

trunk/src

Files:

• wp-includes/comment-template.php (modified) (2 diffs)
• wp-trackback.php (modified) (6 diffs)

trunk/src/wp-includes/comment-template.php

@@ -1147 +1147 @@
 function get_trackback_url() {
     if ( get_option( 'permalink_structure' ) ) {
-        $tb_url = trailingslashit( get_permalink() ) . user_trailingslashit( 'trackback', 'single_trackback' );
+        $trackback_url = trailingslashit( get_permalink() ) . user_trailingslashit( 'trackback', 'single_trackback' );
     } else {
-        $tb_url = get_option( 'siteurl' ) . '/wp-trackback.php?p=' . get_the_ID();
+        $trackback_url = get_option( 'siteurl' ) . '/wp-trackback.php?p=' . get_the_ID();
     }
 
@@ -1157 +1157 @@
      * @since 2.2.0
      *
-     * @param string $tb_url The trackback URL.
-     */
-    return apply_filters( 'trackback_url', $tb_url );
+     * @param string $trackback_url The trackback URL.
+     */
+    return apply_filters( 'trackback_url', $trackback_url );
 }
 

trunk/src/wp-trackback.php

@@ -27 +27 @@
 function trackback_response( $error = 0, $error_message = '' ) {
     header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ) );
+
     if ( $error ) {
         echo '<?xml version="1.0" encoding="utf-8"?' . ">\n";
@@ -46 +47 @@
 
 if ( ! isset( $_GET['tb_id'] ) || ! $_GET['tb_id'] ) {
-    $tb_id = explode( '/', $_SERVER['REQUEST_URI'] );
-    $tb_id = (int) $tb_id[ count( $tb_id ) - 1 ];
+    $post_id = explode( '/', $_SERVER['REQUEST_URI'] );
+    $post_id = (int) $post_id[ count( $post_id ) - 1 ];
 }
 
-$tb_url  = isset( $_POST['url'] ) ? $_POST['url'] : '';
-$charset = isset( $_POST['charset'] ) ? $_POST['charset'] : '';
+$trackback_url = isset( $_POST['url'] ) ? $_POST['url'] : '';
+$charset       = isset( $_POST['charset'] ) ? $_POST['charset'] : '';
 
 // These three are stripslashed here so they can be properly escaped after mb_convert_encoding().
@@ -82 +83 @@
 
 if ( is_single() || is_page() ) {
-    $tb_id = $posts[0]->ID;
+    $post_id = $posts[0]->ID;
 }
 
-if ( ! isset( $tb_id ) || ! (int) $tb_id ) {
+if ( ! isset( $post_id ) || ! (int) $post_id ) {
     trackback_response( 1, __( 'I really need an ID for this to work.' ) );
 }
 
-if ( empty( $title ) && empty( $tb_url ) && empty( $blog_name ) ) {
+if ( empty( $title ) && empty( $trackback_url ) && empty( $blog_name ) ) {
     // If it doesn't look like a trackback at all.
-    wp_redirect( get_permalink( $tb_id ) );
+    wp_redirect( get_permalink( $post_id ) );
     exit;
 }
 
-if ( ! empty( $tb_url ) && ! empty( $title ) ) {
+if ( ! empty( $trackback_url ) && ! empty( $title ) ) {
     /**
      * Fires before the trackback is added to a post.
@@ -101 +102 @@
      * @since 4.7.0
      *
-     * @param int    $tb_id     Post ID related to the trackback.
-     * @param string $tb_url    Trackback URL.
-     * @param string $charset   Character Set.
-     * @param string $title     Trackback Title.
-     * @param string $excerpt   Trackback Excerpt.
-     * @param string $blog_name Blog Name.
+     * @param int    $post_id       Post ID related to the trackback.
+     * @param string $trackback_url Trackback URL.
+     * @param string $charset       Character set.
+     * @param string $title         Trackback title.
+     * @param string $excerpt       Trackback excerpt.
+     * @param string $blog_name     Blog name.
      */
-    do_action( 'pre_trackback_post', $tb_id, $tb_url, $charset, $title, $excerpt, $blog_name );
+    do_action( 'pre_trackback_post', $post_id, $trackback_url, $charset, $title, $excerpt, $blog_name );
 
     header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ) );
 
-    if ( ! pings_open( $tb_id ) ) {
+    if ( ! pings_open( $post_id ) ) {
         trackback_response( 1, __( 'Sorry, trackbacks are closed for this item.' ) );
     }
@@ -119 +120 @@
     $excerpt = wp_html_excerpt( $excerpt, 252, '&#8230;' );
 
-    $comment_post_ID      = (int) $tb_id;
+    $comment_post_id      = (int) $post_id;
     $comment_author       = $blog_name;
     $comment_author_email = '';
-    $comment_author_url   = $tb_url;
+    $comment_author_url   = $trackback_url;
     $comment_content      = "<strong>$title</strong>\n\n$excerpt";
     $comment_type         = 'trackback';
 
-    $dupe = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_author_url = %s", $comment_post_ID, $comment_author_url ) );
+    $dupe = $wpdb->get_results(
+        $wpdb->prepare(
+            "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_author_url = %s",
+            $comment_post_id,
+            $comment_author_url
+        )
+    );
+
     if ( $dupe ) {
         trackback_response( 1, __( 'There is already a ping from that URL for this post.' ) );
     }
 
-    $commentdata = compact( 'comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content', 'comment_type' );
+    $commentdata = array(
+        'comment_post_ID' => $comment_post_id,
+    );
+
+    $commentdata += compact(
+        'comment_author',
+        'comment_author_email',
+        'comment_author_url',
+        'comment_content',
+        'comment_type'
+    );
 
     $result = wp_new_comment( $commentdata );
@@ -149 +167 @@
      */
     do_action( 'trackback_post', $trackback_id );
+
     trackback_response( 0 );
 }