From 008630e97af1614874c709ae3978a660b87bf15a Mon Sep 17 00:00:00 2001 From: Gary Pendergast Date: Tue, 2 Jul 2019 01:44:06 +0000 Subject: [PATCH] Docs: Update some function docs and signatures. - Update the `_wp_specialchars()` docs to match the function signature. - Update the `human_time_diff()` function signature to match the docs. Props subrataemfluence. Fixes #46845. git-svn-id: https://develop.svn.wordpress.org/trunk@45586 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/formatting.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/wp-includes/formatting.php b/src/wp-includes/formatting.php index 15fef0d851..41cad82806 100644 --- a/src/wp-includes/formatting.php +++ b/src/wp-includes/formatting.php @@ -943,14 +943,14 @@ function seems_utf8( $str ) { * * @staticvar string $_charset * - * @param string $string The text which is to be encoded. - * @param int|string $quote_style Optional. Converts double quotes if set to ENT_COMPAT, - * both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. - * Also compatible with old values; converting single quotes if set to 'single', - * double if set to 'double' or both if otherwise set. - * Default is ENT_NOQUOTES. - * @param string $charset Optional. The character encoding of the string. Default is false. - * @param bool $double_encode Optional. Whether to encode existing html entities. Default is false. + * @param string $string The text which is to be encoded. + * @param int|string $quote_style Optional. Converts double quotes if set to ENT_COMPAT, + * both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. + * Also compatible with old values; converting single quotes if set to 'single', + * double if set to 'double' or both if otherwise set. + * Default is ENT_NOQUOTES. + * @param false|string $charset Optional. The character encoding of the string. Default is false. + * @param bool $double_encode Optional. Whether to encode existing html entities. Default is false. * @return string The encoded text with HTML entities. */ function _wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) { @@ -3624,7 +3624,7 @@ function sanitize_email( $email ) { * @param int $to Optional. Unix timestamp to end the time difference. Default becomes time() if not set. * @return string Human readable time difference. */ -function human_time_diff( $from, $to = '' ) { +function human_time_diff( $from, $to = 0 ) { if ( empty( $to ) ) { $to = time(); }