Changeset 27240

Timestamp:

02/24/2014 07:41:24 PM (12 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/media.php (modified) (3 diffs)

trunk/src/wp-includes/media.php

@@ -942 +942 @@
  * @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 ) {
@@ -964 +965 @@
         }
 
-        // 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 != '' ) {
@@ -970 +982 @@
         }
 
-        // 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'] );