WordPress/wp-includes/php-compat/readonly.php
Sergey Biryukov 9e50590938 Code Modernization: Rename parameters that use reserved keywords in wp-includes/php-compat/readonly.php.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the `$readonly` and `$echo` parameters to `$readonly_value` and `$display` in `readonly()`.

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.
Built from https://develop.svn.wordpress.org/trunk@54951


git-svn-id: http://core.svn.wordpress.org/trunk@54503 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-12-08 19:31:17 +00:00

38 lines
1.2 KiB
PHP

<?php
/**
* Conditionally declares a `readonly()` function, which was renamed
* to `wp_readonly()` in WordPress 5.9.0.
*
* In order to avoid PHP parser errors, this function was extracted
* to this separate file and is only included conditionally on PHP 8.1.
*
* Including this file on PHP >= 8.1 results in a fatal error.
*
* @package WordPress
* @since 5.9.0
*/
/**
* Outputs the HTML readonly attribute.
*
* Compares the first two arguments and if identical marks as readonly.
*
* This function is deprecated, and cannot be used on PHP >= 8.1.
*
* @since 4.9.0
* @deprecated 5.9.0 Use wp_readonly() introduced in 5.9.0.
*
* @see wp_readonly()
*
* @param mixed $readonly_value One of the values to compare.
* @param mixed $current Optional. The other value to compare if not just true.
* Default true.
* @param bool $display Optional. Whether to echo or just return the string.
* Default true.
* @return string HTML attribute or empty string.
*/
function readonly( $readonly_value, $current = true, $display = true ) {
_deprecated_function( __FUNCTION__, '5.9.0', 'wp_readonly()' );
return wp_readonly( $readonly_value, $current, $display );
}