Changeset 42876 for trunk/src/wp-includes/class-wp-query.php

Timestamp:

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

Author:

johnbillion

Message:

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

See #41756

File:

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

trunk/src/wp-includes/class-wp-query.php

@@ -1380 +1380 @@
          * @since 3.7.0
          *
-         * @param array $terms Terms to check.
+         * @param string[] $terms Array of terms to check.
          * @return array Terms that are not stopwords.
          */
@@ -1448 +1448 @@
                  * @since 3.7.0
                  *
-                 * @param array $stopwords Stopwords.
+                 * @param string[] $stopwords Array of stopwords.
                  */
                 $this->stopwords = apply_filters( 'wp_search_stopwords', $stopwords );
@@ -2695 +2695 @@
                          * @since 3.1.0
                          *
-                         * @param array    $clauses The list of clauses for the query.
+                         * @param string[] $clauses Associative array of the clauses for the query.
                          * @param WP_Query $this    The WP_Query instance (passed by reference).
                          */
@@ -2819 +2819 @@
                          * @since 3.1.0
                          *
-                         * @param array    $pieces The pieces of the query.
+                         * @param string[] $pieces Associative array of the pieces of the query.
                          * @param WP_Query $this   The WP_Query instance (passed by reference).
                          */
@@ -2966 +2966 @@
                          * @since 2.3.0
                          *
-                         * @param array    $posts The post results array.
-                         * @param WP_Query $this The WP_Query instance (passed by reference).
+                         * @param WP_Post[] $posts Array of post objects.
+                         * @param WP_Query  $this  The WP_Query instance (passed by reference).
                          */
                         $this->posts = apply_filters_ref_array( 'posts_results', array( $this->posts, &$this ) );
@@ -3103 +3103 @@
                          * @since 1.5.0
                          *
-                         * @param array    $posts The array of retrieved posts.
-                         * @param WP_Query $this The WP_Query instance (passed by reference).
+                         * @param WP_Post[] $posts Array of post objects.
+                         * @param WP_Query  $this The WP_Query instance (passed by reference).
                          */
                         $this->posts = apply_filters_ref_array( 'the_posts', array( $this->posts, &$this ) );
@@ -4178 +4178 @@
                  * @since 4.4.0
                  *
-                 * @param array   $pages Array of "pages" derived from the post content.
-                 *                       of `<!-- nextpage -->` tags..
-                 * @param WP_Post $post  Current post object.
+                 * @param string[] $pages Array of "pages" from the post content split by `<!-- nextpage -->` tags.
+                 * @param WP_Post  $post  Current post object.
                  */
                 $pages = apply_filters( 'content_pagination', $pages, $post );