Changeset 48475

Timestamp:

07/14/2020 12:08:28 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve docs for arguments that accept a numerically indexed array of associative arrays.

See #49572

Location:

trunk/src

Files:

• wp-admin/includes/ajax-actions.php (modified) (2 diffs)
• wp-admin/includes/class-wp-site-health.php (modified) (1 diff)
• wp-includes/class-wp-date-query.php (modified) (2 diffs)
• wp-includes/class-wp-editor.php (modified) (1 diff)
• wp-includes/class-wp-meta-query.php (modified) (1 diff)
• wp-includes/class-wp-tax-query.php (modified) (1 diff)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -4776 +4776 @@
          *     An array of callable exporters of personal data. Default empty array.
          *
-         *     @type array {
+         *     @type array ...$0 {
          *         Array of personal data exporters.
          *
@@ -4966 +4966 @@
          *     An array of callable erasers of personal data. Default empty array.
          *
-         *     @type array {
+         *     @type array ...$0 {
          *         Array of personal data exporters.
          *

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -158 +158 @@
                  *
                  * @param array $test_result {
-                 *     An associated array of test result data.
+                 *     An associative array of test result data.
                  *
-                 *     @param string $label  A label describing the test, and is used as a header in the output.
-                 *     @param string $status The status of the test, which can be a value of `good`, `recommended` or `critical`.
+                 *     @param string $label       A label describing the test, and is used as a header in the output.
+                 *     @param string $status      The status of the test, which can be a value of `good`, `recommended` or `critical`.
                  *     @param array  $badge {
                  *         Tests are put into categories which have an associated badge shown, these can be modified and assigned here.

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

@@ -73 +73 @@
          *     Array of date query clauses.
          *
-         *     @type array {
+         *     @type array ...$0 {
          *         @type string $column   Optional. The column to query against. If undefined, inherits the value of
          *                                the `$default_column` parameter. Accepts 'post_date', 'post_date_gmt',
@@ -82 +82 @@
          *         @type string $relation Optional. The boolean relationship between the date queries. Accepts 'OR' or 'AND'.
          *                                Default 'OR'.
-         *         @type array {
+         *         @type array  ...$0 {
          *             Optional. An array of first-order clause parameters, or another fully-formed date query.
          *

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

@@ -1795 +1795 @@
                  *
                  * @param array $results {
-                 *     An associative array of query results.
-                 *
-                 *     @type array {
+                 *     An array of associative arrays of query results.
+                 *
+                 *     @type array ...$0 {
                  *         @type int    $ID        Post ID.
                  *         @type string $title     The trimmed, escaped post title.

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

@@ -110 +110 @@
          *     @type string $relation Optional. The MySQL keyword used to join
          *                            the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
-         *     @type array {
+         *     @type array  ...$0 {
          *         Optional. An array of first-order clause parameters, or another fully-formed meta query.
          *

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

@@ -97 +97 @@
          *     @type string $relation Optional. The MySQL keyword used to join
          *                            the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
-         *     @type array {
-         *         Optional. An array of first-order clause parameters, or another fully-formed tax query.
+         *     @type array  ...$0 {
+         *         An array of first-order clause parameters, or another fully-formed tax query.
          *
          *         @type string           $taxonomy         Taxonomy being queried. Optional when field=term_taxonomy_id.