sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Inline documentation improvements for wp_get_playlist().

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


git-svn-id: https://develop.svn.wordpress.org/trunk@27240 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2014-02-24 19:41:24 +00:00
parent 9ff3e7c214
commit 268b688247
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/wp-includes/media.php
View File

@ -941,8 +941,9 @@ 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 array $attr Attributes of the shortcode.
* @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'] )