Commit 19e5e814 authored by Drew Jaynes's avatar Drew Jaynes
Browse files

Inline documentation improvements for `wp_get_playlist()`. 

* Adds a missing `@param` description in the PHPDoc.
* Adds hook documentation for the `post_playlist` filter.
* Other comment cleanup.

Built from https://develop.svn.wordpress.org/trunk@27240


git-svn-id: https://core.svn.wordpress.org/trunk@27097 1a063a9b-81f0-0310-95a4-ce76da25c4cd
parent 1d035ac9

wp-includes/media.php

+19 −4
Original line number Diff line number Diff line
@@ -942,7 +942,8 @@ function gallery_shortcode( $attr ) { 
 * @since 3.9.0

 *

 * @param array  $attr Attributes of the shortcode.

 * @return string $type Type of playlist. Defaults to audio, video is also supported

 * @param string $type Type of playlist. Accepts 'audio' and 'video'.

 * @return string Playlist output. Empty string if the passed type is unsupported.

 */

function wp_get_playlist( $attr, $type ) {

	global $content_width;
@@ -963,13 +964,27 @@ function wp_get_playlist( $attr, $type ) { 
		$attr['include'] = $attr['ids'];

	}



	// Allow plugins/themes to override the default gallery template.

	/**

	 * Filter the playlist output.

	 *

	 * Passing a non-empty value to the filter will short-circuit generation

	 * of the default playlist output, returning the passed value instead.

	 *

	 * @since 3.9.0

	 *

	 * @param string $output Playlist output. Default empty.

	 * @param array  $attr   Array of shortcode attributes.

	 * @param string $type   Type of playlist to generate output for.

	 */

	$output = apply_filters( 'post_playlist', '', $attr, $type );

	if ( $output != '' ) {

		return $output;

	}



	// We're trusting author input, so let's at least make sure it looks like a valid orderby statement

	/*

	 * We're trusting author input, so let's at least make sure it looks

	 * like a valid orderby statement.

	 */

	if ( isset( $attr['orderby'] ) ) {

		$attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] );

		if ( ! $attr['orderby'] )