Make WordPress Core

Opened 16 months ago

Closed 15 months ago

Last modified 15 months ago

#57692 closed defect (bug) (fixed)

Coding Standards: Invalid variable name $post_IDs and $post_ID as per coding standards

Reported by: mahekkalola's profile mahekkalola Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 6.2 Priority: normal
Severity: normal Version:
Component: Posts, Post Types Keywords: has-patch
Focuses: administration, coding-standards Cc:

Description

File: wp-admin/includes/post.php

Found two variables $post_IDs and $post_ID which can be renamed to maintain coding standards.

Change History (6)

#1 @SergeyBiryukov
16 months ago

  • Component changed from General to Posts, Post Types
  • Focuses administration added

This ticket was mentioned in PR #4061 on WordPress/wordpress-develop by @tanjimtc71.


16 months ago
#2

  • Keywords has-patch added

Fixes #57692

This pull request renames the variables $post_IDs and $post_ID in the "wp-admin/includes/post.php" file to align with the WordPress coding standards.

  • $post_IDs is renamed to $post_ids
  • $post_ID is renamed to $post_id_from_data to avoid conflicts and maintain coding standards.

The changes were thoroughly tested and are ready for review. Thank you for considering this pull request.

Trac ticket: https://core.trac.wordpress.org/ticket/57692

@SergeyBiryukov commented on PR #4061:


15 months ago
#3

Thanks for the PR!

I think we can just use $post_id here, as it does not appear to conflict with any existing variable. This would also be more consistent with the rest of core, which generally uses $post_id when referring to a post ID.

#4 @SergeyBiryukov
15 months ago

  • Milestone changed from Awaiting Review to 6.2

#5 @SergeyBiryukov
15 months ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 55365:

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.

@SergeyBiryukov commented on PR #4061:


15 months ago
#6

Merged in r55365 as part of a few other similar edits.

Note: See TracTickets for help on using tickets.