mirror of
https://github.com/WordPress/WordPress.git
synced 2024-11-08 20:01:12 +01:00
15af7662df
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.
Built from https://develop.svn.wordpress.org/trunk@55163
git-svn-id: http://core.svn.wordpress.org/trunk@54696 1a063a9b-81f0-0310-95a4-ce76da25c4cd
35 lines
830 B
PHP
35 lines
830 B
PHP
<?php
|
|
/**
|
|
* Diff API: WP_Text_Diff_Renderer_inline class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Diff
|
|
* @since 4.7.0
|
|
*/
|
|
|
|
/**
|
|
* Better word splitting than the PEAR package provides.
|
|
*
|
|
* @since 2.6.0
|
|
* @uses Text_Diff_Renderer_inline Extends
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
class WP_Text_Diff_Renderer_inline extends Text_Diff_Renderer_inline {
|
|
|
|
/**
|
|
* @ignore
|
|
* @since 2.6.0
|
|
*
|
|
* @param string $string
|
|
* @param string $newlineEscape
|
|
* @return string
|
|
*/
|
|
public function _splitOnWords( $string, $newlineEscape = "\n" ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
|
|
$string = str_replace( "\0", '', $string );
|
|
$words = preg_split( '/([^\w])/u', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
|
|
$words = str_replace( "\n", $newlineEscape, $words );
|
|
return $words;
|
|
}
|
|
|
|
}
|