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

Timestamp:

11/23/2021 09:35:57 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #53399

File:

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

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

@@ -339 +339 @@
      * @since 3.2.0
      *
-     * @param string $type              Type of meta, eg 'user', 'post'.
+     * @param string $type              Type of meta. Possible values include but are not limited
+     *                                  to 'post', 'comment', 'blog', 'term', and 'user'.
      * @param string $primary_table     Database table where the object being filtered is stored (eg wp_users).
      * @param string $primary_id_column ID column for the filtered object in $primary_table.
-     * @param object $context           Optional. The main query object.
-     * @return array|false {
-     *     Array containing JOIN and WHERE SQL clauses to append to the main query.
+     * @param object $context           Optional. The main query object that corresponds to the type, for
+     *                                  example a `WP_Query`, `WP_User_Query`, or `WP_Site_Query`.
+     * @return string[]|false {
+     *     Array containing JOIN and WHERE SQL clauses to append to the main query,
+     *     or false if no table exists for the requested meta type.
      *
      *     @type string $join  SQL fragment to append to the main JOIN clause.
@@ -379 +382 @@
          * @since 3.1.0
          *
-         * @param array  $sql               Array containing the query's JOIN and WHERE clauses.
-         * @param array  $queries           Array of meta queries.
-         * @param string $type              Type of meta.
-         * @param string $primary_table     Primary table.
-         * @param string $primary_id_column Primary column ID.
-         * @param object $context           The main query object.
+         * @param string[] $sql               Array containing the query's JOIN and WHERE clauses.
+         * @param array    $queries           Array of meta queries.
+         * @param string   $type              Type of meta. Possible values include but are not limited
+         *                                    to 'post', 'comment', 'blog', 'term', and 'user'.
+         * @param string   $primary_table     Primary table.
+         * @param string   $primary_id_column Primary column ID.
+         * @param object   $context           The main query object that corresponds to the type, for
+         *                                    example a `WP_Query`, `WP_User_Query`, or `WP_Site_Query`.
          */
         return apply_filters_ref_array( 'get_meta_sql', array( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) );