Changeset 55365 for trunk/src/wp-includes/deprecated.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-includes/deprecated.php (modified) (2 diffs)

trunk/src/wp-includes/deprecated.php

@@ -742 +742 @@
  *
  * @param int $blogid Not Used
- * @param int $post_ID
+ * @param int $post_id
  * @return array
  */
-function wp_get_post_cats($blogid = '1', $post_ID = 0) {
+function wp_get_post_cats($blogid = '1', $post_id = 0) {
     _deprecated_function( __FUNCTION__, '2.1.0', 'wp_get_post_categories()' );
-    return wp_get_post_categories($post_ID);
+    return wp_get_post_categories($post_id);
 }
 
@@ -759 +759 @@
  *
  * @param int $blogid Not used
- * @param int $post_ID
+ * @param int $post_id
  * @param array $post_categories
  * @return bool|mixed
  */
-function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array()) {
+function wp_set_post_cats($blogid = '1', $post_id = 0, $post_categories = array()) {
     _deprecated_function( __FUNCTION__, '2.1.0', 'wp_set_post_categories()' );
-    return wp_set_post_categories($post_ID, $post_categories);
+    return wp_set_post_categories($post_id, $post_categories);
 }