Changeset 54855 for trunk/src/wp-includes/functions.php

Timestamp:

11/17/2022 06:13:47 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update various DocBlocks and inline comments per the documentation standards.

Includes minor formatting edits for consistency.

Follow-up to [53/tests], [12179], [12946], [35288], [37884], [38810], [38928], [46596], [48131], [52955], [53548], [53813], [53873], [54118], [54316], [54420], [54421], [54803].

See #56792.

File:

• trunk/src/wp-includes/functions.php (modified) (3 diffs)

trunk/src/wp-includes/functions.php

@@ -935 +935 @@
      *
      * @param string[] $post_links An array of enclosure links.
-     * @param int      $post_ID    Post ID.
+     * @param int      $post_id    Post ID.
      */
     $post_links = apply_filters( 'enclosure_links', $post_links, $post->ID );
@@ -3331 +3331 @@
      *
      * @param string[] $wp_get_mime_types Mime types keyed by the file extension regex
-     *                                 corresponding to those types.
+     *                                    corresponding to those types.
      */
     return apply_filters(
@@ -5201 +5201 @@
  * @param array        $list          An array of objects or arrays to sort.
  * @param string|array $orderby       Optional. Either the field name to order by or an array
- *                                    of multiple orderby fields as $orderby => $order.
- * @param string       $order         Optional. Either 'ASC' or 'DESC'. Only used if $orderby
- *                                    is a string.
+ *                                    of multiple orderby fields as `$orderby => $order`.
+ *                                    Default empty array.
+ * @param string       $order         Optional. Either 'ASC' or 'DESC'. Only used if `$orderby`
+ *                                    is a string. Default 'ASC'.
  * @param bool         $preserve_keys Optional. Whether to preserve keys. Default false.
  * @return array The sorted array.