WordPress.org

Make WordPress Core

Changeset 28901


Ignore:
Timestamp:
06/29/2014 09:28:54 PM (5 years ago)
Author:
DrewAPicture
Message:

Add documentation for the default playlist shortcode attributes in wp_playlist_shortcode().

Props taylorde.
Fixes #28678.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/media.php

    r28847 r28901  
    11621162 * @since 3.9.0
    11631163 *
    1164  * @param array $attr Playlist shortcode attributes.
     1164 * @param array $attr {
     1165 *     Array of default playlist attributes.
     1166 *
     1167 *     @type string  $type         Type of playlist to display. Accepts 'audio' or 'video'. Default 'audio'.
     1168 *     @type string  $order        Designates ascending or descending order of items in the playlist.
     1169 *                                 Accepts 'ASC', 'DESC', or 'RAND'. Default 'ASC'.
     1170 *     @type string  $orderby      Any column, or columns, to sort the playlist. If $ids are
     1171 *                                 passed, this defaults to the order of the $ids array ('post__in').
     1172 *                                 Otherwise default is 'menu_order ID'.
     1173 *     @type int     $id           If an explicit $ids array is not present, this parameter
     1174 *                                 will determine which attachments are used for the playlist.
     1175 *                                 Default is the current post ID.
     1176 *     @type array   $ids          Create a playlist out of these explicit attachment IDs. If empty,
     1177 *                                 a playlist will be created from all $type attachments of $id.
     1178 *                                 Default empty.
     1179 *     @type array   $exclude      List of specific attachment IDs to exclude from the playlist. Default empty.
     1180 *     @type string  $style        Playlist style to use. Accepts 'light' or 'dark'. Default 'light'.
     1181 *     @type bool    $tracklist    Whether to show or hide the playlist. Default true.
     1182 *     @type bool    $tracknumbers Whether to show or hide the numbers next to entries in the playlist. Default true.
     1183 *     @type bool    $images       Show or hide the video or audio thumbnail (Featured Image/post
     1184 *                                 thumbnail). Default true.
     1185 *     @type bool    $artists      Whether to show or hide artist name in the playlist. Default true.
     1186 * }
     1187 *
    11651188 * @return string Playlist output. Empty string if the passed type is unsupported.
    11661189 */
Note: See TracChangeset for help on using the changeset viewer.