Coding Standards fixes for WP 6.1

[costdev]

Previously:

• #54728 (6.0)
• #53359 (5.9)
• #52627 (5.8)
• #51799 (5.7)
• #50767 (5.6)
• #49542 (5.5)
• #49222 (5.4)
• #47632 (5.3)
• #45934 (5.1)

[audrasjb]

In 53398:

Coding Standards: Fix params indentation in pre_get_network_by_path hook docblock.

See #55647.

[SergeyBiryukov]

In 53441:

Coding Standards: Correct alignment in various files.

This fixes an Equals sign not aligned correctly WPCS warning.

Additionally, this commit sets the svn:eol-style property for the phpunit/tests/ajax/wpAjaxCropImage.php file and corrects line endings, so that the output of composer format is clean.

Follow-up to [53027], [53217], [53404].

Props hellofromTonya, SergeyBiryukov.
See #55647.

[SergeyBiryukov]

In 53671:

Coding Standards: Simplify the logic for setting DB host and port in wpdb::parse_db_host().

This removes an extra foreach loop and the only variable variable ($$component) in core.

Follow-up to [20088,28342,28736-28747], [41629], [41820], [42226], [53670].

Props johnjamesjacoby.
See #54877, #55647.

[SergeyBiryukov]

In 53702:

Coding Standards: Rename the $user_id parameter of get_user_locale() to $user for accuracy.

Since the parameter accepts not only a user's ID, but also a WP_User object, $user is a more appropriate name, which better aligns with the $post parameter of functions that accept a post ID or a WP_Post object.

The pre-existing internal $user variable which contained a WP_User object is renamed to $user_object for clarity.

Follow-up to [38955].

Props aristath, poena, afercia, SergeyBiryukov.
See #55647.

[SergeyBiryukov]

In 53710:

Coding Standards: Improve readability of wp-admin/options-permalink.php.

Includes:

• Wrapping longer lines and reducing alignment levels to fit more data on the screen.
• Restoring esc_attr() for input values, which may include translatable parts.
• Adding comments to closing </div> tags and PHP endif statements.
• Reducing the context switching between HTML and PHP.
• Balancing PHP conditionals to better reflect the structure.
• Removing repeated function calls to improve performance.
• Renaming some variables for clarity and consistency.

Follow-up to [470], [601], [963], [1227], [1664], [2746], [3029], [6976], [7230], [11350], [14051], [14553], [21891], [34691], [34749], [37747], [38066], [41182], [41986], [42343], [43571], [48710], [50830], [51892], [53706].

See #55647.

Trac ticket:
A new set of improvements. :)
https://core.trac.wordpress.org/ticket/55647
https://core.trac.wordpress.org/ticket/54728

[SergeyBiryukov]

In 53713:

Coding Standards: Use a single input array on Permalink Settings screen.

This reduces the amount of code to edit in case of any changes to the default permalink structures.

Follow-up to [53706], [53710].

See #55647, #55498.

[SergeyBiryukov]

In 53714:

Coding Standards: Use MINUTE_IN_SECONDS where appropriate.

This aims to clarify the time units for some timeout or expiration values.

Follow-up to [11823], [13177], [21996], [37747].

See #55647.

[TobiasBg]

In [53714], instead of MINUTE_IN_SECONDS / 2, isn't 1/2 * MINUTE_IN_SECONDS or 0.5 * MINUTE_IN_SECONDS more readable and quicker understandable, because it reads "left to right"?

[knutsp]

Replying to TobiasBg:

In [53714], instead of MINUTE_IN_SECONDS / 2, isn't 1/2 * MINUTE_IN_SECONDS or 0.5 * MINUTE_IN_SECONDS more readable and quicker understandable, because it reads "left to right"?

The first expression gives int(30), the suggested ones two both give float(30.), so not good for identicality comparisons.

[TobiasBg]

Replying to knutsp:

The first expression gives int(30), the suggested ones two both give float(30.), so not good for identicality comparisons.

Good point, hadn't thought of that!

[SergeyBiryukov]

In 53715:

Posts, Post Types: Standardize on $post parameter name where appropriate.

This renames the $post_id or $id parameters to $post for functions that accept a post ID or post object:

• get_sample_permalink()
• get_sample_permalink_html()
• wp_check_post_lock()
• wp_set_post_lock()
• get_the_tags()
• comment_class()
• get_comment_class()
• get_comments_link()
• get_comments_number()
• comments_number()
• get_comments_number_text()
• comments_open()
• pings_open()
• comment_form()
• do_trackbacks()
• pingback()
• post_permalink()
• get_post_permalink()
• get_edit_post_link()
• edit_post_link()
• get_delete_post_link()
• post_class()
• get_post_class()
• the_attachment_link()
• wp_get_attachment_link()
• wp_list_post_revisions()
• check_and_publish_future_post()
• add_ping()
• get_pung()
• get_to_ping()
• wp_get_post_revisions()
• wp_get_post_revisions_url()

Additionally, $revision_id is renamed to $revision in:

• wp_restore_post_revision()
• wp_delete_post_revision()

Includes minor documentation improvements for consistency and code layout fixes for better readability.

Follow-up to [1599], [1794], [2881], [3303], [3851], [5302], [6633], [6716], [6985], [7103], [7149], [7747], [8011], [8638], [8643], [8695], [9138], [9273], [11425], [11922], [11956], [12284], [12810], [12923], [13023], [13171], [25567], [27156], [27473], [28558], [28602], [33659], [38852], [47276], [47366], [48622], [49544], [49597], [52095].

See #56243, #55647.

[SergeyBiryukov]

In 53719:

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.

[SergeyBiryukov]

In 53720:

Coding Standards: Remove unused variable in wp-trackback.php.

This was present in the initial import of b2 files, but appears to have never been used in WordPress core.

Follow-up to [3], [636], [637], [1616].

See #55647.

[SergeyBiryukov]

In 53723:

Coding Standards: Rename $comment_post_ID and $comment_author_IP variables in various files.

This fixes two WPCS warnings:

• Variable "$comment_post_ID" is not in valid snake_case format
• Variable "$comment_author_IP" is not in valid snake_case format

While matching the database fields of the same name, these variables did not follow the WordPress coding standards, and are now renamed to address that.

Note: The name change only affects internal variables and parameters for a few actions receiving a comment post ID:

• edit_comment
• comment_id_not_found
• comment_closed
• comment_on_trash
• comment_on_draft
• comment_on_password_protected
• pre_comment_on_post

The change does not affect parameters for functions receiving an array of comment data:

• wp_insert_comment()
• wp_new_comment()
• wp_update_comment()
• wp_handle_comment_submission()

The associated array keys still match the database fields: comment_post_ID and comment_author_IP.

Follow-up to [1706], [2894], [8720], [28427], [28437], [28457], [34799], [53720],

See #55647, #56244.

[SergeyBiryukov]

In 53724:

Coding Standards: Use consistent placement for ::prepare_links() methods.

This moves the ::prepare_links() methods in REST API classes next to ::prepare_item_for_response() where they are used, to bring some consistency across the classes and make code navigation easier.

Includes wrapping some long lines for better readability.

Follow-up to [52079], [52051], [52342], [53721], [53722].

See #55647.

[SergeyBiryukov]

In 53729:

Coding Standards: Standardize on user_id when passing data to comment functions.

The wp_new_comment(), wp_update_comment(), and wp_filter_comment() functions already normalize the user_ID parameter internally to user_id, which matches the database field name.

This commit aims to bring some consistency when passing the parameter in core.

The corresponding $user_ID variable is also renamed to $user_id to match the other variables when not referring to the $user_ID global, which has an exception in the WordPress coding standards.

Follow-up to [8543], [8720], [12267], [12300], [26491], [28915], [28922], [34799], [49303].

See #55647, #56244.

[SergeyBiryukov]

In 53730:

Coding Standards: Remove extra comma in a compact() call.

This fixes a PHP compatibility error in wp_handle_comment_submission():

• Trailing comma's are not allowed in function calls in PHP 7.2 or earlier

Follow-up to [53729].

See #55647, #56244.

[SergeyBiryukov]

In 53732:

Tests: Correct the test for passing all expected parameters to the preprocess_comment filter.

Previously, assertSame() was replaced with assertSameSets(), which does not preserve the array keys. assertSameSetsWithIndex() should have been used instead.

Follow-up to [36038], [48937], [53729], [53730].

See #55647, #56244.

[SergeyBiryukov]

In 53747:

Coding Standards: Adjust the logic slightly in wp_ajax_replyto_comment().

This aims to bring more consistency to the function logic by separating the comment content and type checks from the user existence check.

Follow-up to [8720], [9098], [29758].

See #55647.

[SergeyBiryukov]

In 53749:

Coding Standards: Move wp-includes/wp-db.php to wp-includes/class-wpdb.php.

This renames the file containing the wpdb class to conform to the coding standards.

This commit also includes:

• A new wp-db.php that loads the new file, for anyone that may have been including the file directly.
• Replacing references to the old filename with the new filename.

Fixes #56268. See #55647.

[SergeyBiryukov]

In 53750:

Coding Standards: Replace the old wp-db.php filename in phpcompat.xml.dist.

This ensures the correct file is allowlisted for use of mysql_ extension in PHP < 7.0.

Follow-up to [53749].

See #56268, #55647.

[SergeyBiryukov]

In 53755:

Coding Standards: Check if the _deprecated_file() function exists in wp-db.php.

This avoids a fatal error if the file is included directly outside of WordPress core, e.g. by HyperDB.

Additionally, replace WPINC with wp-includes, as the constant may not be defined yet in that context.

Follow-up to [53749], [53750].

See #56268, #55647.

[SergeyBiryukov]

In 53756:

Coding Standards: Use __DIR__ instead of ABSPATH in wp-db.php.

If the file is included directly outside of WordPress core, ABSPATH may not be defined.

Follow-up to [53749], [53750], [53755].

See #56268, #55647.

[SergeyBiryukov]

In 53767:

Cache API: Make the placement of wp_cache_flush_group() more consistent.

Includes:

• Placing WP_Object_Cache::flush_group() next to ::flush().
• Placing wp_cache_supports_group_flush() next to wp_cache_flush_group().
• Placing the wp_cache_flush_group() unit test next to the ::flush() method test.
• Removing test name from assertion messages, as it is already mentioned directly above in case of failure.
• Adjusting function descriptions per the documentation standards.

Follow-up to [52706], [53763].

See #55647, #4476.

[SergeyBiryukov]

In 53800:

Docs: Use more inclusive language in PHPCS configuration files.

Follow-up to [42346], [43348], [45455], [46290], [46820], [48121], [48477].

See #55646, #55647.

[SergeyBiryukov]

In 53802:

Tests: Correct alignment in has_filter() unit test.

Follow-up to [100/tests].

See #55652, #55647.

[SergeyBiryukov]

In 53823:

Coding Standards: Wrap long lines with global cache groups for better readability.

Follow-up to [946/tests], [1060/tests], ​mu1784, ​mu2032 ​mu2029, [7986], [12128], [12603], [12688], [12732], [12755], [13125], [14009], [15482], [21403], [22092], [31347], [31348], [36258], [36393], [36413], [37918], [40343], [40347], [42836].

See #55647.

[SergeyBiryukov]

In 53824:

Tests: Simplify the list of global groups in object cache tests.

This list was not up to date due to missing blog_meta group, and does not appear to be required for the tests to pass, as WP_UnitTestCase_Base::flush_cache() adds the same list of groups, which is up to date.

Follow-up to [946/tests], [1332/tests], [40343], [42836], [53823].

See #55647.

[SergeyBiryukov]

In 53832:

Coding Standards: Reorder global cache groups alphabetically for some consistency.

Follow-up to [53823], [53824].

See #55647.

[SergeyBiryukov]

In 53872:

Coding Standards: Rename the $file parameter to $path in some WP_Filesystem_* methods.

This aims to bring more clarity to the code, and applies to methods where the path can be a file or a directory:

• WP_Filesystem_*::exists()
• WP_Filesystem_*::is_writable()

Follow-up to [6779], [25560].

See #55647.

[SergeyBiryukov]

In 53896:

Coding Standards: Restore correct regex formatting in dbDelta().

An earlier regex for normalizing index definitions disables the PHPCS check for extra padding in order to keep a more readable indentation. However, this was missed for index columns regex.

Follow-up to [37583], [42228], [42249], [42343].

See #55647.

[SergeyBiryukov]

In 53914:

Coding Standards: Check for deprecated options before wp_installing().

This is a micro-optimization that makes the conditional several times faster for non-deprecated options by avoiding an unnecessary function call.

Functions affected:

• get_option()
• update_option()
• add_option()

Follow-up to [48575].

See #55647.

[SergeyBiryukov]

In 53915:

Coding Standards: Simplify the logic in wp_not_installed().

The function to check whether WordPress is not installed has evolved over time, ending up with duplicate conditionals.

This commit combines two conditionals into a single one and includes an early return.

Follow-up to [672], [676], [725], [1184], [1401], [1980], [2171], [2467], [2468], [2486], [2703], [3011], [3670], [12688], [12732], [12762], [13253], [29599], [30581], [34828].

See #55647.

[SergeyBiryukov]

In 54038:

Coding Standards: Use more consistent formatting in wp-includes/class-json.php.

As an adopted library that does not follow the WordPress Coding Standards, the file ended with a mix of tab and spaces as part of maintenance updates over the years.

This commit standardizes on spaces for now, to bring some consistency while minimizing the number of changes.

Includes moving all the declared properties to the top of the class.

Follow-up to [11875], [11877], [23376], [32990], [46377], [54037].

See #55647.

[SergeyBiryukov]

In 54070:

Coding Standards: Use more meaningful variable names in WP_Users_List_Table.

This renames some variables for clarity, per the ​Naming Conventions:

Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

• $c is renamed to $columns in ::get_columns() and ::get_sortable_columns().
• $r is renamed to $row in ::single_row().

Follow-up to [3677], [5542], [6852], [8936], [15491], [16573].

Props burhandodhy, costdev, mukesh27, Presskopp.
See #56448, #55647.

[SergeyBiryukov]

In 54071:

Coding Standards: Use more meaningful variable names for output in the admin.

This renames some variables for clarity, per the ​Naming Conventions:

Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

• $out is renamed to $output in various list table methods and admin functions.
• $sep is renamed to $separator in various list table methods and admin functions.

This affects:

• WP_Comments_List_Table::handle_row_actions()
• WP_List_Table::row_actions()
• WP_Media_List_Table::column_default()
• WP_MS_Sites_List_Table::site_states()
• WP_MS_Users_List_Table::column_blogs()
• WP_Terms_List_Table::column_name()
• _wp_dashboard_recent_comments_row()
• image_align_input_fields()
• image_size_input_fields()
• wp_doc_link_parse()
• _post_states()
• _media_states()

Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070].

Props mukesh27, costdev.
See #56448, #55647.

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $sbname to $sidebar_name.
• $sbvalue to $sidebar_data.
• $j to $widget_count.
• $i to $sidebar_index.
• $sb to $sidebar in src/wp-admin/widgets-form.php.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $i to $submenu_index.
• $cap to $capability.
• $tax to $taxonomy.
• Several $awaiting_mod_* to $awaiting_moderation_*.
• Several $ptype_* to $post_type_*.
• $types to $post_types.
• $appearance_cap to $appearance_capability.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $r to $edit_result.
• $ext to $extension.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $q to $query_string.
• $vars to $query_vars.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $h to $header.

Note: There are a few variables I'd like some input on:

• $oitar - I have no idea what this refers to.
• $dst_height - This could be $dest_height, but that doesn't seem like a worthwhile change. Suggestions?
• $dst_width - See above.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $r to $upgrade_data.
• $res to $connected.
• $info to $new_theme_data.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $r to $upgrade_data.
• $res to $connected.
• $pluginfiles to $plugin_files - Per naming conventions, separate words via underscores.
• $info to $new_plugin_data.

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

Per naming conventions, don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.

​See PHP Coding Standards - Naming Conventions.

This PR includes renaming of the following variables:

• $post_ID to $post_id. - "Use lowercase letters in variable, action/filter, and function names"
• $ext_type to $extension_type.
• $ext to $extension.
• $id3data to $id3_data. - "Separate words via underscores."
• $msg to $message.
• $sb to $sidebar.
• $alt to $alternate.
• $pid to $post_id.
• $menu_obj to $menu_object.
• $noparents to $no_parents. - "Separate words via underscores."
• $sup to $supplemental.
• $cat_id to $category_id.
• $cat_name to $category_name.
• $out to $output.
• $r to $edit_result.
• $t to $taxonomy.
• $u to $update_result.
• $r to $result.
• $response to $response_data.
• $x to $response.

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

Yes I believe so @mukeshpanchal27. Wherever a variable is unnecessarily abbreviated and is ambiguous, it should be renamed, especially if it's a single character variable like $c. Those reading the source should not need to scroll up to find out what a variable refers to.

That said, there are likely to be exceptions, such as $i inside for() loops. While $k => $v in foreach() loops is common, I generally find it better to just name _at least_ the $v variable.

[audrasjb]

In 54113:

Coding Standards: Clarify time units for various timeout or expiration values.

This changeset implements a clearer and more consistent timeout/duration/expiration format. It updates time durations used in various files, as per WordPress coding standards:

• If the value can be represented as an integer (not a fractional) number of minutes (hours, etc.), use the appropriate constant (e.g.: MINUTE_IN_SECONDS) multiplied by that number.
• Otherwise, keep the value as is and add a comment with the units for clarity.

Follow-up to [11823], [13177], [21996], [37747], [53714].

Props hztyfoon, audrasjb, arrasel403, krupalpanchal, GaryJ, SergeyBiryukov, peterwilsoncc, rudlinkon, costdev, robinwpdeveloper.
Fixes #56293.
See #55647.

@costdev great work 🚀

@costdev i don't think we can change $dst_height and $dst_width as it also used in JS and unit tests.

@costdev great work 🚀

[SergeyBiryukov]

In 54254:

Coding Standards: Rename WordPress Dependencies API class files.

The current coding standards note that the name of the class files should be based on the class name with class- prepended, and the underscores replaced by hyphens (see the ​Naming Conventions section in the handbook), except for the three legacy files: class.wp-dependencies.php, class.wp-scripts.php, class.wp-styles.php.

To bring more consistency to the codebase and make it easier to implement autoloading in the future, this commit renames those three legacy files to conform to the coding standards:

• wp-includes/class.wp-dependencies.php → wp-includes/class-wp-dependencies.php
• wp-includes/class.wp-scripts.php → wp-includes/class-wp-scripts.php
• wp-includes/class.wp-styles.php → wp-includes/class-wp-styles.php

Includes:

• Loading the new files from the old ones, for anyone that may have been including the files directly.
• Replacing references to the old filenames with the new filenames.

Follow-up to [7970], [45654], [45662], [45663], [45678], [47197], [52026], [53749].

Props afragen, schlessera, swissspidy, dingo_d, hellofromTonya, SergeyBiryukov.
Fixes #37861. See #55647.

[davidbaumwald]

In 54298:

Coding Standards: Correct alignment in WP_Theme_JSON_Resolver::get_core_data().

Follow-up to [54251].

See #55647.

Removes two unneeded whitespaces.
https://core.trac.wordpress.org/ticket/55647

[desrosj]

In 54480:

Coding Standards: Remove two unnecessary spaces.

Props kebbet.
See #55647.

[desrosj]

Closing this one out with RC1 today. #56791 has been created for 6.2.

Merged into Core in https://core.trac.wordpress.org/changeset/54480.