Make WordPress Core

Changeset 55163


Ignore:
Timestamp:
01/30/2023 03:22:17 PM (16 months ago)
Author:
SergeyBiryukov
Message:

Code Modernization: Allow some parameters with reserved keywords in wp-includes/class-wp-text-diff-renderer-*.php.

This commit adds inline comments instructing PHPCS to ignore parameters with reserved keywords in the affected methods that should not be renamed:

  • $string parameter in WP_Text_Diff_Renderer_inline::_splitOnWords()
  • $final parameter in WP_Text_Diff_Renderer_Table::_changed() and ::interleave_changed_lines()

This resolves a few WPCS warnings along the lines of:

It is recommended not to use reserved keyword "string" as function parameter name. Found: $string
It is recommended not to use reserved keyword "final" as function parameter name. Found: $final

The two WP_Text_Diff_Renderer_* classes in question extend the Text_Diff_Renderer_inline and Text_Diff_Renderer classes from the Text_Diff package and should have the same parameters as the parent class methods, per the Task 1 section of ticket #51553.

The Text_Diff library currently included in WordPress core is no longer kept in sync with the upstream project and can be considered “adopted”, so the $string and $final parameters in the parent class methods can technically be renamed, e.g. to $input_string and $modified, respectively.

However, the “final” wording is also used to represent modified content in other parts the library, so it is more internally consistent to keep these parameters as is for now.

Follow-up to [7747], [38352], [55136].

See #56788.

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-text-diff-renderer-inline.php

    r54133 r55163  
    2525     * @return string
    2626     */
    27     public function _splitOnWords( $string, $newlineEscape = "\n" ) {
     27    public function _splitOnWords( $string, $newlineEscape = "\n" ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
    2828        $string = str_replace( "\0", '', $string );
    2929        $words  = preg_split( '/([^\w])/u', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
  • trunk/src/wp-includes/class-wp-text-diff-renderer-table.php

    r54891 r55163  
    248248     * @return string
    249249     */
    250     public function _changed( $orig, $final ) {
     250    public function _changed( $orig, $final ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.finalFound
    251251        $r = '';
    252252
     
    359359     * }
    360360     */
    361     public function interleave_changed_lines( $orig, $final ) {
     361    public function interleave_changed_lines( $orig, $final ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.finalFound
    362362
    363363        // Contains all pairwise string comparisons. Keys are such that this need only be a one dimensional array.
Note: See TracChangeset for help on using the changeset viewer.