Changeset 55844

Timestamp:

05/21/2023 10:39:52 AM (19 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve a few DocBlocks in wp-includes/formatting.php.

This addresses missing hyphens, typos and unnecessarily complex language.

Follow-up to [8540], [8743], [11615], [11907], [28670], [42056].

Props apermo.
Fixes #58316.

File:

• trunk/src/wp-includes/formatting.php (modified) (9 diffs)

trunk/src/wp-includes/formatting.php

@@ -3832 +3832 @@
  * Determines the difference between two timestamps.
  *
- * The difference is returned in a human readable format such as "1 hour",
+ * The difference is returned in a human-readable format such as "1 hour",
  * "5 mins", "2 days".
  *
@@ -3840 +3840 @@
  * @param int $from Unix timestamp from which the difference begins.
  * @param int $to   Optional. Unix timestamp to end the time difference. Default becomes time() if not set.
- * @return string Human readable time difference.
+ * @return string Human-readable time difference.
  */
 function human_time_diff( $from, $to = 0 ) {
@@ -3901 +3901 @@
 
     /**
-     * Filters the human readable difference between two timestamps.
+     * Filters the human-readable difference between two timestamps.
      *
      * @since 4.0.0
      *
-     * @param string $since The difference in human readable text.
+     * @param string $since The difference in human-readable text.
      * @param int    $diff  The difference in seconds.
      * @param int    $from  Unix timestamp from which the difference begins.
@@ -3918 +3918 @@
  * Returns a maximum of 55 words with an ellipsis appended if necessary.
  *
- * The 55 word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter
+ * The 55-word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter
  * The ' […]' string can be modified by plugins/themes using the {@see 'excerpt_more'} filter
  *
@@ -4355 +4355 @@
  * Performs a deep string replace operation to ensure the values in $search are no longer present.
  *
- * Repeats the replacement operation until it no longer replaces anything so as to remove "nested" values
+ * Repeats the replacement operation until it no longer replaces anything to remove "nested" values
  * e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that
  * str_replace would return
@@ -4387 +4387 @@
  * NOTE: Since 4.8.3, '%' characters will be replaced with a placeholder string,
  * this prevents certain SQLi attacks from taking place. This change in behavior
- * may cause issues for code that expects the return value of esc_sql() to be useable
+ * may cause issues for code that expects the return value of esc_sql() to be usable
  * for other purposes.
  *
@@ -5156 +5156 @@
 
 /**
- * WordPress implementation of PHP sprintf() with filters.
+ * WordPress' implementation of PHP sprintf() with filters.
  *
  * @since 2.5.0
@@ -5334 +5334 @@
  * Adds a base URL to relative links in passed content.
  *
- * By default it supports the 'src' and 'href' attributes. However this can be
- * changed via the 3rd param.
+ * By default, this function supports the 'src' and 'href' attributes.
+ * However, this can be modified via the `$attrs` parameter.
  *
  * @since 2.7.0
@@ -5378 +5378 @@
  * Adds a target attribute to all links in passed content.
  *
- * This function by default only applies to `<a>` tags, however this can be
- * modified by the `$tags` parameter.
+ * By default, this function only applies to `<a>` tags.
+ * However, this can be modified via the `$tags` parameter.
  *
  * *NOTE:* Any current target attribute will be stripped and replaced.