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.

git-svn-id: https://develop.svn.wordpress.org/trunk@51592 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2021-08-10 13:44:34 +00:00
parent 88fb0bc5e0
commit 016cce0695
2 changed files with 41 additions and 31 deletions

View File

@@ -15,7 +15,7 @@
/**
* Outputs the HTML readonly attribute.
*
* Compares the first two arguments and if identical marks as readonly
* Compares the first two arguments and if identical marks as readonly.
*
* This function is deprecated, and cannot be used on PHP >= 8.1.
*
@@ -24,10 +24,12 @@
*
* @see wp_readonly()
*
* @param mixed $readonly One of the values to compare
* @param mixed $current (true) The other value to compare if not just true
* @param bool $echo Whether to echo or just return the string
* @return string HTML attribute or empty string
* @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()' );