Changeset 55365 for trunk/src/wp-admin/includes/ajax-actions.php

Timestamp:

02/19/2023 03:03:50 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename $post_ID variable to $post_id in various files.

The $post_ID variable is ​technically allowed in WPCS, as there is a global of the same name that needs to remain for backward compatibility. However, this name is mostly a remnant of legacy code, and switching to $post_id where appropriate brings more consistency with the rest of core.

Additionally, this commit resolves a few WPCS warnings in core:

Variable "$post_IDs" is not in valid snake_case format

This affects:

• Function parameters in:
  • add_meta()
  • post_preview()
  • WP_Embed::delete_oembed_caches()
  • WP_Embed::cache_oembed()
  • wp_get_post_cats()
  • wp_set_post_cats()
  • wp_unique_post_slug()
  • wp_set_post_categories()
  • wp_check_post_hierarchy_for_loops()
  • wp_add_trashed_suffix_to_post_name_for_trashed_posts()
  • wp_filter_wp_template_unique_post_slug()
  • wp_xmlrpc_server::add_enclosure_if_new()
  • wp_xmlrpc_server::attach_uploads()
  • wp_xmlrpc_server::mt_getTrackbackPings()
• Internal variables in:
  • wp_ajax_inline_save()
  • wp_ajax_set_post_thumbnail()
  • wp_ajax_get_post_thumbnail_html()
  • edit_post()
  • bulk_edit_posts()
  • wp_write_post()
  • WP_Embed::shortcode()
  • wp_insert_post()
  • wp_xmlrpc_server::_insert_post()
  • wp_xmlrpc_server::blogger_getPost()
  • wp_xmlrpc_server::blogger_newPost()
  • wp_xmlrpc_server::blogger_editPost()
  • wp_xmlrpc_server::blogger_deletePost()
  • wp_xmlrpc_server::mw_getPost()
  • wp_xmlrpc_server::mw_newPost()
  • wp_xmlrpc_server::mw_editPost()
  • wp_xmlrpc_server::mt_getPostCategories()
  • wp_xmlrpc_server::mt_setPostCategories()
  • wp_xmlrpc_server::mt_publishPost()
  • wp_xmlrpc_server::pingback_ping()
• Hook parameters in:
  • oembed_ttl
  • embed_oembed_html
  • wp_insert_post_parent
  • add_trashed_suffix_to_trashed_posts
  • pre_post_update
  • edit_attachment
  • attachment_updated
  • add_attachment
  • edit_post_{$post->post_type}
  • edit_post
  • post_updated
  • save_post_{$post->post_type}
  • save_post
  • wp_insert_post
  • pre_wp_unique_post_slug
  • wp_unique_post_slug
  • xmlrpc_call_success_blogger_newPost
  • xmlrpc_call_success_blogger_editPost
  • xmlrpc_call_success_blogger_deletePost
  • xmlrpc_call_success_mw_newPost
  • xmlrpc_call_success_mw_editPost

Note: The name change only affects variable names and DocBlocks.

The change does not affect the $post_ID global still used in a few places.

Follow-up to [51399], [52958], [53723], [53729], [55190], [55308], [55334].

Props mahekkalola, tanjimtc71, SergeyBiryukov.
Fixes #57692.

File:

• trunk/src/wp-admin/includes/ajax-actions.php (modified) (7 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -2035 +2035 @@
     }
 
-    $post_ID = (int) $_POST['post_ID'];
+    $post_id = (int) $_POST['post_ID'];
 
     if ( 'page' === $_POST['post_type'] ) {
-        if ( ! current_user_can( 'edit_page', $post_ID ) ) {
+        if ( ! current_user_can( 'edit_page', $post_id ) ) {
             wp_die( __( 'Sorry, you are not allowed to edit this page.' ) );
         }
     } else {
-        if ( ! current_user_can( 'edit_post', $post_ID ) ) {
+        if ( ! current_user_can( 'edit_post', $post_id ) ) {
             wp_die( __( 'Sorry, you are not allowed to edit this post.' ) );
         }
     }
 
-    $last = wp_check_post_lock( $post_ID );
+    $last = wp_check_post_lock( $post_id );
     if ( $last ) {
         $last_user      = get_userdata( $last );
@@ -2066 +2066 @@
     $data = &$_POST;
 
-    $post = get_post( $post_ID, ARRAY_A );
+    $post = get_post( $post_id, ARRAY_A );
 
     // Since it's coming from the database.
@@ -2700 +2700 @@
     $json = ! empty( $_REQUEST['json'] ); // New-style request.
 
-    $post_ID = (int) $_POST['post_id'];
-    if ( ! current_user_can( 'edit_post', $post_ID ) ) {
+    $post_id = (int) $_POST['post_id'];
+    if ( ! current_user_can( 'edit_post', $post_id ) ) {
         wp_die( -1 );
     }
@@ -2708 +2708 @@
 
     if ( $json ) {
-        check_ajax_referer( "update-post_$post_ID" );
+        check_ajax_referer( "update-post_$post_id" );
     } else {
-        check_ajax_referer( "set_post_thumbnail-$post_ID" );
+        check_ajax_referer( "set_post_thumbnail-$post_id" );
     }
 
     if ( '-1' == $thumbnail_id ) {
-        if ( delete_post_thumbnail( $post_ID ) ) {
-            $return = _wp_post_thumbnail_html( null, $post_ID );
+        if ( delete_post_thumbnail( $post_id ) ) {
+            $return = _wp_post_thumbnail_html( null, $post_id );
             $json ? wp_send_json_success( $return ) : wp_die( $return );
         } else {
@@ -2722 +2722 @@
     }
 
-    if ( set_post_thumbnail( $post_ID, $thumbnail_id ) ) {
-        $return = _wp_post_thumbnail_html( $thumbnail_id, $post_ID );
+    if ( set_post_thumbnail( $post_id, $thumbnail_id ) ) {
+        $return = _wp_post_thumbnail_html( $thumbnail_id, $post_id );
         $json ? wp_send_json_success( $return ) : wp_die( $return );
     }
@@ -2736 +2736 @@
  */
 function wp_ajax_get_post_thumbnail_html() {
-    $post_ID = (int) $_POST['post_id'];
-
-    check_ajax_referer( "update-post_$post_ID" );
-
-    if ( ! current_user_can( 'edit_post', $post_ID ) ) {
+    $post_id = (int) $_POST['post_id'];
+
+    check_ajax_referer( "update-post_$post_id" );
+
+    if ( ! current_user_can( 'edit_post', $post_id ) ) {
         wp_die( -1 );
     }
@@ -2751 +2751 @@
     }
 
-    $return = _wp_post_thumbnail_html( $thumbnail_id, $post_ID );
+    $return = _wp_post_thumbnail_html( $thumbnail_id, $post_id );
     wp_send_json_success( $return );
 }