WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Sergey Biryukov 2021-08-10 13:45:57 +00:00
parent f7dbd99922
commit 5202ae3852
3 changed files with 42 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
wp-includes/general-template.php
View File

@ -4763,14 +4763,16 @@ function get_the_generator( $type = '' ) {
/** /**
* Outputs the HTML checked attribute. * Outputs the HTML checked attribute.
* *
* Compares the first two arguments and if identical marks as checked * Compares the first two arguments and if identical marks as checked.
* *
* @since 1.0.0 * @since 1.0.0
* *
* @param mixed $checked One of the values to compare * @param mixed $checked One of the values to compare.
* @param mixed $current (true) The other value to compare if not just true * @param mixed $current Optional. The other value to compare if not just true.
* @param bool $echo Whether to echo or just return the string * Default true.
* @return string HTML attribute or empty string * @param bool $echo Optional. Whether to echo or just return the string.
* Default true.
* @return string HTML attribute or empty string.
*/ */
function checked( $checked, $current = true, $echo = true ) { function checked( $checked, $current = true, $echo = true ) {
return __checked_selected_helper( $checked, $current, $echo, 'checked' ); return __checked_selected_helper( $checked, $current, $echo, 'checked' );
@ -4779,14 +4781,16 @@ function checked( $checked, $current = true, $echo = true ) {
/** /**
* Outputs the HTML selected attribute. * Outputs the HTML selected attribute.
* *
* Compares the first two arguments and if identical marks as selected * Compares the first two arguments and if identical marks as selected.
* *
* @since 1.0.0 * @since 1.0.0
* *
* @param mixed $selected One of the values to compare * @param mixed $selected One of the values to compare.
* @param mixed $current (true) The other value to compare if not just true * @param mixed $current Optional. The other value to compare if not just true.
* @param bool $echo Whether to echo or just return the string * Default true.
* @return string HTML attribute or empty string * @param bool $echo Optional. Whether to echo or just return the string.
* Default true.
* @return string HTML attribute or empty string.
*/ */
function selected( $selected, $current = true, $echo = true ) { function selected( $selected, $current = true, $echo = true ) {
return __checked_selected_helper( $selected, $current, $echo, 'selected' ); return __checked_selected_helper( $selected, $current, $echo, 'selected' );
@ -4795,14 +4799,16 @@ function selected( $selected, $current = true, $echo = true ) {
/** /**
* Outputs the HTML disabled attribute. * Outputs the HTML disabled attribute.
* *
* Compares the first two arguments and if identical marks as disabled * Compares the first two arguments and if identical marks as disabled.
* *
* @since 3.0.0 * @since 3.0.0
* *
* @param mixed $disabled One of the values to compare * @param mixed $disabled One of the values to compare.
* @param mixed $current (true) The other value to compare if not just true * @param mixed $current Optional. The other value to compare if not just true.
* @param bool $echo Whether to echo or just return the string * Default true.
* @return string HTML attribute or empty string * @param bool $echo Optional. Whether to echo or just return the string.
* Default true.
* @return string HTML attribute or empty string.
*/ */
function disabled( $disabled, $current = true, $echo = true ) { function disabled( $disabled, $current = true, $echo = true ) {
return __checked_selected_helper( $disabled, $current, $echo, 'disabled' ); return __checked_selected_helper( $disabled, $current, $echo, 'disabled' );
@ -4811,14 +4817,16 @@ function disabled( $disabled, $current = true, $echo = true ) {
/** /**
* Outputs the HTML readonly attribute. * 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.
* *
* @since 5.9.0 * @since 5.9.0
* *
* @param mixed $readonly One of the values to compare * @param mixed $readonly One of the values to compare.
* @param mixed $current (true) The other value to compare if not just true * @param mixed $current Optional. The other value to compare if not just true.
* @param bool $echo Whether to echo or just return the string * Default true.
* @return string HTML attribute or empty string * @param bool $echo Optional. Whether to echo or just return the string.
* Default true.
* @return string HTML attribute or empty string.
*/ */
function wp_readonly( $readonly, $current = true, $echo = true ) { function wp_readonly( $readonly, $current = true, $echo = true ) {
return __checked_selected_helper( $readonly, $current, $echo, 'readonly' ); return __checked_selected_helper( $readonly, $current, $echo, 'readonly' );
@ -4837,16 +4845,16 @@ if ( PHP_VERSION_ID < 80100 ) {
/** /**
* Private helper function for checked, selected, disabled and readonly. * Private helper function for checked, selected, disabled and readonly.
* *
* Compares the first two arguments and if identical marks as $type * Compares the first two arguments and if identical marks as `$type`.
* *
* @since 2.8.0 * @since 2.8.0
* @access private * @access private
* *
* @param mixed $helper One of the values to compare * @param mixed $helper One of the values to compare.
* @param mixed $current (true) The other value to compare if not just true * @param mixed $current The other value to compare if not just true.
* @param bool $echo Whether to echo or just return the string * @param bool $echo Whether to echo or just return the string.
* @param string $type The type of checked|selected|disabled|readonly we are doing * @param string $type The type of checked|selected|disabled|readonly we are doing.
* @return string HTML attribute or empty string * @return string HTML attribute or empty string.
*/ */
function __checked_selected_helper( $helper, $current, $echo, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore function __checked_selected_helper( $helper, $current, $echo, $type ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
if ( (string) $helper === (string) $current ) { if ( (string) $helper === (string) $current ) {

12
wp-includes/php-compat/readonly.php
View File

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

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-alpha-51591'; $wp_version = '5.9-alpha-51592';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.