WordPress/wp-includes/php-compat/readonly.php
Sergey Biryukov 5202ae3852 Docs: Improve documentation for a few functions per the documentation standards.
This affects:
* `checked()`
* `selected()`
* `disabled()`
* `wp_readonly()`
* `readonly()`
* `__checked_selected_helper()`

Follow-up to [143], [560], [9053], [10662], [13658], [41728], [51586].

See #53399.
Built from https://develop.svn.wordpress.org/trunk@51592


git-svn-id: http://core.svn.wordpress.org/trunk@51203 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-08-10 13:45:57 +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 One of the values to compare.
* @param mixed $current Optional. The other value to compare if not just true.
* Default true.
* @param bool $echo Optional. Whether to echo or just return the string.
* Default true.
* @return string HTML attribute or empty string.
*/
function readonly( $readonly, $current = true, $echo = true ) {
_deprecated_function( __FUNCTION__, '5.9.0', 'wp_readonly()' );
return wp_readonly( $readonly, $current, $echo );
}