Changeset 51592 for trunk/src/wp-includes/php-compat/readonly.php

Timestamp:

08/10/2021 01:44:34 PM (4 years ago)

Author:

SergeyBiryukov

Message:

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.

File:

• trunk/src/wp-includes/php-compat/readonly.php (modified) (2 diffs)

trunk/src/wp-includes/php-compat/readonly.php

@@ -16 +16 @@
  * 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.
@@ -25 +25 @@
  * @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 ) {