Ticket #28678: 28678.2.patch

src/wp-includes/media.php

@@ -1161 +1161 @@
  *
  * @since 3.9.0
  *
- * @param array $attr Playlist shortcode attributes.
+ * @param array $attr {
+ *     Array of default playlist attributes.
+ *
+ *     @type string  $type         Display either 'audio' or 'video'. Default 'audio'.
+ *     @type string  $order        Designates ascending or descending order of items in the playlist.
+ *                                 Accepts 'ASC', 'DESC', or 'RAND'. Default 'ASC'.
+ *     @type string  $orderby      Any column, or columns, to sort the playlist. If $ids are
+ *                                 passed, this defaults to the order of the $ids array ('post__in').
+ *                                 Otherwise defaults to 'menu_order ID'.
+ *     @type integer $id           If an explicit $ids array is not present, this parameter
+ *                                 will determine which attachments are used for the playlist.
+ *                                 Defaults to the current post ID.
+ *     @type array   $ids          Create a playlist out of these explicit attachment IDs. If empty,
+ *                                 a playlist will be created from all $type attachments of $id.
+ *                                 Default empty.
+ *     @type array   $exclude      Specific attachment IDs to exclude from the playlist. Default empty.
+ *     @type string  $style        Playlist style. Core supports 'light' and 'dark'. Default 'light'.
+ *     @type bool    $tracklist    Show or hide the playlist. Default true.
+ *     @type bool    $tracknumbers Show or hide the numbers next to entries in the playlist. Default true.
+ *     @type bool    $images       Show or hide the video or audio thumbnail (featured image/post
+ *                                 thumbnail). Default true.
+ *     @type bool    $artists      Show or hide artist name in the playlist. Default true.
+ * }
+ *
  * @return string Playlist output. Empty string if the passed type is unsupported.
  */
 function wp_playlist_shortcode( $attr ) {