Changeset 42640

Timestamp:

02/02/2018 09:37:47 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Convert $args array description for wp_get_themes() to a hash notation.

Props milana_cap.
Fixes #43213.

File:

• trunk/src/wp-includes/theme.php (modified) (1 diff)

trunk/src/wp-includes/theme.php

@@ -18 +18 @@
  * @staticvar array $_themes
  *
- * @param array $args The search arguments. Optional.
- * - errors      mixed  True to return themes with errors, false to return themes without errors, null
- *                      to return all themes. Defaults to false.
- * - allowed     mixed  (Multisite) True to return only allowed themes for a site. False to return only
- *                      disallowed themes for a site. 'site' to return only site-allowed themes. 'network'
- *                      to return only network-allowed themes. Null to return all themes. Defaults to null.
- * - blog_id     int    (Multisite) The blog ID used to calculate which themes are allowed. Defaults to 0,
- *                      synonymous for the current blog.
+ * @param array $args {
+ *     Optional. The search arguments.
+ *
+ *     @type mixed $errors  True to return themes with errors, false to return themes without errors, null to return all themes.
+ *                          Defaults to false.
+ *     @type mixed $allowed (Multisite) True to return only allowed themes for a site. False to return only disallowed themes for a site.
+ *                          'site' to return only site-allowed themes. 'network' to return only network-allowed themes.
+ *                          Null to return all themes. Defaults to null.
+ *     @type int   $blog_id (Multisite) The blog ID used to calculate which themes are allowed.
+ *                          Defaults to 0, synonymous for the current blog.
+ * }
  * @return array Array of WP_Theme objects.
  */