Changeset 42876 for trunk/src/wp-includes/comment.php

Timestamp:

03/25/2018 07:32:24 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Document more parameters and properties using typed array notation.

See #41756

File:

• trunk/src/wp-includes/comment.php (modified) (7 diffs)

trunk/src/wp-includes/comment.php

@@ -518 +518 @@
  * @since 4.5.0
  *
- * @param array $comments Array of comment objects.
+ * @param WP_Comment[] $comments Array of comment objects.
  */
 function wp_queue_comments_for_comment_meta_lazyload( $comments ) {
@@ -919 +919 @@
  * @since 2.7.0
  *
- * @param array $comments Array of comments
- * @return array Array of comments keyed by comment_type.
+ * @param WP_Comment[] $comments Array of comments
+ * @return WP_Comment[] Array of comments keyed by comment_type.
  */
 function separate_comments( &$comments ) {
@@ -953 +953 @@
  * @global WP_Query $wp_query
  *
- * @param array $comments Optional array of WP_Comment objects. Defaults to $wp_query->comments
- * @param int   $per_page Optional comments per page.
- * @param bool  $threaded Optional control over flat or threaded comments.
+ * @param WP_Comment[] $comments Optional. Array of WP_Comment objects. Defaults to $wp_query->comments.
+ * @param int          $per_page Optional. Comments per page.
+ * @param bool         $threaded Optional. Control over flat or threaded comments.
  * @return int Number of comment pages.
  */
@@ -2741 +2741 @@
      * @since 2.0.0
      *
-     * @param array $post_links An array of post links to be checked (passed by reference).
-     * @param array $pung       Whether a link has already been pinged (passed by reference).
-     * @param int   $post_ID    The post ID.
+     * @param string[] $post_links Array of link URLs to be checked (passed by reference).
+     * @param string[] $pung       Array of link URLs already pinged (passed by reference).
+     * @param int      $post_ID    The post ID.
      */
     do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post->ID ) );
@@ -2933 +2933 @@
  * @since 4.4.0 Introduced the `$update_meta_cache` parameter.
  *
- * @param array $comments          Array of comment row objects
- * @param bool  $update_meta_cache Whether to update commentmeta cache. Default true.
+ * @param WP_Comment[] $comments          Array of comment objects
+ * @param bool         $update_meta_cache Whether to update commentmeta cache. Default true.
  */
 function update_comment_cache( $comments, $update_meta_cache = true ) {
@@ -2960 +2960 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param array $comment_ids       Array of comment IDs.
+ * @param int[] $comment_ids       Array of comment IDs.
  * @param bool  $update_meta_cache Optional. Whether to update the meta cache. Default true.
  */
@@ -2998 +2998 @@
      * @since 3.2.0
      *
-     * @param array $post_types An array of registered post types. Default array with 'post'.
+     * @param string[] $post_types An array of post type names.
      */
     $post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );