Changeset 46596 for trunk/src/wp-includes/post.php

Timestamp:

10/26/2019 09:07:10 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Switch more docs over to typed array notation, plus some fixes.

See #48303, #41756

File:

• trunk/src/wp-includes/post.php (modified) (10 diffs)

trunk/src/wp-includes/post.php

@@ -633 +633 @@
  * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
  *                       a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
- * @return array Array of children, where the type of each element is determined by $output parameter.
- *               Empty array on failure.
+ * @return WP_Post[]|int[] Array of post objects or post IDs.
  */
 function get_children( $args = '', $output = OBJECT ) {
@@ -1600 +1599 @@
  * @global array $post_type_meta_caps Used to store meta capabilities.
  *
- * @param array $capabilities Post type meta capabilities.
+ * @param string[] $capabilities Post type meta capabilities.
  */
 function _post_type_meta_capabilities( $capabilities = null ) {
@@ -4732 +4731 @@
      * @since 2.0.0
      *
-     * @param array $pung    Array of enclosures for the given post.
-     * @param int   $post_id Post ID.
+     * @param string[] $pung    Array of enclosures for the given post.
+     * @param int      $post_id Post ID.
      */
     return apply_filters( 'get_enclosed', $pung, $post_id );
@@ -4774 +4773 @@
  *
  * @param int|WP_Post $post_id Post Object or ID
- * @return array
+ * @param string[] List of URLs yet to ping.
  */
 function get_to_ping( $post_id ) {
@@ -4791 +4790 @@
      * @since 2.0.0
      *
-     * @param array $to_ping List of URLs yet to ping.
+     * @param string[] $to_ping List of URLs yet to ping.
      */
     return apply_filters( 'get_to_ping', $to_ping );
@@ -5066 +5065 @@
  * @since 2.0.0
  *
- * @param array $pages   Posts array (passed by reference).
- * @param int   $page_id Optional. Parent page ID. Default 0.
- * @return array A list arranged by hierarchy. Children immediately follow their parents.
+ * @param WP_Post[] $pages   Posts array (passed by reference).
+ * @param int       $page_id Optional. Parent page ID. Default 0.
+ * @return string[] Array of post names keyed by ID and arranged by hierarchy. Children immediately follow their parents.
  */
 function get_page_hierarchy( &$pages, $page_id = 0 ) {
@@ -5097 +5096 @@
  * @see _page_traverse_name()
  *
- * @param int   $page_id   Page ID.
- * @param array $children  Parent-children relations (passed by reference).
- * @param array $result    Result (passed by reference).
+ * @param int      $page_id  Page ID.
+ * @param array    $children Parent-children relations (passed by reference).
+ * @param string[] $result   Array of page names keyed by ID (passed by reference).
  */
 function _page_traverse_name( $page_id, &$children, &$result ) {
@@ -5462 +5461 @@
      * @since 2.1.0
      *
-     * @param array $pages List of pages to retrieve.
-     * @param array $parsed_args     Array of get_pages() arguments.
+     * @param WP_Post[] $pages       Array of page objects.
+     * @param array     $parsed_args Array of get_pages() arguments.
      */
     return apply_filters( 'get_pages', $pages, $parsed_args );
@@ -6108 +6107 @@
 
             /**
-             * Filters the list of icon directory URIs.
+             * Filters the array of icon directory URIs.
              *
              * @since 2.5.0
              *
-             * @param array $uris List of icon directory URIs.
+             * @param string[] $uris Array of icon directory URIs keyed by directory absolute path.
              */
             $dirs       = apply_filters( 'icon_dirs', array( $icon_dir => $icon_dir_uri ) );
@@ -7096 +7095 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param array $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
- *                       DISTINCT, fields (SELECT), and LIMITS clauses.
- * @return array The modified clauses.
+ * @param string[] $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
+ *                          DISTINCT, fields (SELECT), and LIMITS clauses.
+ * @return string[] The modified array of clauses.
  */
 function _filter_query_attachment_filenames( $clauses ) {