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

Timestamp:

11/24/2020 09:25:46 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Upgrade more parameters in docblocks to used typed array notation.

See #51800, #41756

File:

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

trunk/src/wp-includes/post.php

@@ -1308 +1308 @@
  *     @type string       $label                 Name of the post type shown in the menu. Usually plural.
  *                                               Default is value of $labels['name'].
- *     @type array        $labels                An array of labels for this post type. If not set, post
+ *     @type string[]     $labels                An array of labels for this post type. If not set, post
  *                                               labels are inherited for non-hierarchical types and page
  *                                               labels for hierarchical ones. See get_post_type_labels() for a full
@@ -1357 +1357 @@
  *                                               this argument as a base to construct the capabilities, e.g.
  *                                               array('story', 'stories'). Default 'post'.
- *     @type array        $capabilities          Array of capabilities for this post type. $capability_type is used
+ *     @type string[]     $capabilities          Array of capabilities for this post type. $capability_type is used
  *                                               as a base to construct capabilities by default.
  *                                               See get_post_type_capabilities().
@@ -1376 +1376 @@
  *                                               edit form. Do remove_meta_box() and add_meta_box() calls in the
  *                                               callback. Default null.
- *     @type array        $taxonomies            An array of taxonomy identifiers that will be registered for the
+ *     @type string[]     $taxonomies            An array of taxonomy identifiers that will be registered for the
  *                                               post type. Taxonomies can be registered later with register_taxonomy()
  *                                               or register_taxonomy_for_object_type().
@@ -2723 +2723 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string|array $mime_type Optional. Array or comma-separated list of
- *                                MIME patterns. Default empty.
+ * @param string|string[] $mime_type Optional. Array or comma-separated list of
+ *                                   MIME patterns. Default empty.
  * @return object An object containing the attachment counts by mime type.
  */
@@ -2864 +2864 @@
  * @since 2.5.0
  *
- * @param string|array $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*)
- *                                          or flash (same as *flash*).
- * @param string|array $real_mime_types     Real post mime type values.
+ * @param string|string[] $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*)
+ *                                             or flash (same as *flash*).
+ * @param string|string[] $real_mime_types     Real post mime type values.
  * @return array array(wildcard=>array(real types)).
  */
@@ -2916 +2916 @@
  * @since 2.5.0
  *
- * @param string|array $post_mime_types List of mime types or comma separated string
- *                                      of mime types.
- * @param string       $table_alias     Optional. Specify a table alias, if needed.
- *                                      Default empty.
+ * @param string|string[] $post_mime_types List of mime types or comma separated string
+ *                                         of mime types.
+ * @param string          $table_alias     Optional. Specify a table alias, if needed.
+ *                                         Default empty.
  * @return string The SQL AND clause for mime searching.
  */
@@ -3521 +3521 @@
  * @since 2.8.0
  *
- * @param int          $post_id  Optional. The Post ID. Does not default to the ID of the
- *                               global $post. Default 0.
- * @param string|array $taxonomy Optional. The taxonomy slug or array of slugs for which
- *                               to retrieve terms. Default 'post_tag'.
- * @param array        $args     {
+ * @param int             $post_id  Optional. The Post ID. Does not default to the ID of the
+ *                                  global $post. Default 0.
+ * @param string|string[] $taxonomy Optional. The taxonomy slug or array of slugs for which
+ *                                  to retrieve terms. Default 'post_tag'.
+ * @param array           $args     {
  *     Optional. Term query parameters. See WP_Term_Query::__construct() for supported arguments.
  *