<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"

"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />

<title>[28004] trunk/src/wp-includes/media.php: General PHPDoc improvements in wp-includes/media.php for 3.9 functionality.</title>

</head>

<body>

<style type="text/css"><!--

#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }

#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }

#msg dt:after { content:':';}

#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }

#msg dl a { font-weight: bold}

#msg dl a:link    { color:#fc3; }

#msg dl a:active  { color:#ff0; }

#msg dl a:visited { color:#cc6; }

h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }

#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }

#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }

#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }

#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }

#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }

#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }

#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }

#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }

#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }

#logmsg pre { background: #eee; padding: 1em; }

#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}

#logmsg dl { margin: 0; }

#logmsg dt { font-weight: bold; }

#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }

#logmsg dd:before { content:'\00bb';}

#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }

#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }

#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }

#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }

#logmsg table th.Corner { text-align: left; }

#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }

#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }

#patch { width: 100%; }

#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}

#patch .propset h4, #patch .binary h4 {margin:0;}

#patch pre {padding:0;line-height:1.2em;margin:0;}

#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}

#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}

#patch span {display:block;padding:0 10px;}

#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}

#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}

#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}

#patch .lines, .info {color:#888;background:#fff;}

--></style>

<div id="msg">

<dl class="meta">

<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28004">28004</a></dd>

<dt>Author</dt> <dd>DrewAPicture</dd>

<dt>Date</dt> <dd>2014-04-07 20:37:17 +0000 (Mon, 07 Apr 2014)</dd>

</dl>

<h3>Log Message</h3>

<pre>General PHPDoc improvements in wp-includes/media.php for 3.9 functionality.

See <a href="http://core.trac.wordpress.org/ticket/27700">#27700</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludesmediaphp"></a>

<div class="modfile"><h4>Modified: trunk/src/wp-includes/media.php (28003 => 28004)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/src/wp-includes/media.php  2014-04-07 20:28:05 UTC (rev 28003)

+++ trunk/src/wp-includes/media.php     2014-04-07 20:37:17 UTC (rev 28004)

</span><span class="lines">@@ -1009,7 +1009,7 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

</span><del>- * Output the templates used by playlists

</del><ins>+ * Output the templates used by playlists.

</ins><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  */

</span><span class="lines">@@ -1051,7 +1051,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  *

</span><del>- * @param string $type Type of playlist: "audio" or "video."

</del><ins>+ * @param string $type Type of playlist. Accepts 'audio' or 'video'.

</ins><span class="cx">  */

</span><span class="cx"> function wp_playlist_scripts( $type ) {

</span><span class="cx">  wp_enqueue_style( 'wp-mediaelement' );

</span><span class="lines">@@ -1064,14 +1064,14 @@

</span><span class="cx"> add_action( 'wp_playlist_scripts', 'wp_playlist_scripts' );

</span><span class="cx"> 

</span><span class="cx"> /**

<del>- * The Playlist shortcode.

</del><ins>+ * The playlist shortcode.

</ins><span class="cx">  *

</span><del>- * This implements the functionality of the Playlist Shortcode for displaying

</del><ins>+ * This implements the functionality of the playlist shortcode for displaying

</ins><span class="cx">  * a collection of WordPress audio or video files in a post.

</span><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  *

<del>- * @param array  $attr Attributes of the shortcode.

</del><ins>+ * @param array $attr Playlist shortcode attributes.

</ins><span class="cx">  * @return string Playlist output. Empty string if the passed type is unsupported.

</span><span class="cx">  */

</span><span class="cx"> function wp_playlist_shortcode( $attr ) {

</span><span class="lines">@@ -1260,8 +1260,8 @@

</span><span class="cx">           *

</span><span class="cx">           * @since 3.9.0

</span><span class="cx">           *

</span><del>-                * @param string $type   Type of playlist: "audio" or "video."

-                * @param string $style  The "theme" for the playlist. Core provides "light" and "dark."

</del><ins>+                 * @param string $type  Type of playlist. Possible values are 'audio' or 'video'.

+                * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.

</ins><span class="cx">            */

</span><span class="cx">          do_action( 'wp_playlist_scripts', $type, $style );

</span><span class="cx">  } ?>

</span><span class="lines">@@ -1317,9 +1317,9 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  *

<del>- * @param WP_Post $attachment The attachment in question, provided for context.

</del><ins>+ * @param WP_Post $attachment The current attachment, provided for context.

</ins><span class="cx">  * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.

</span><del>- * @return array

</del><ins>+ * @return array Key/value pairs of field keys to labels.

</ins><span class="cx">  */

</span><span class="cx"> function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {

</span><span class="cx">  $fields = array(

</span><span class="lines">@@ -2734,11 +2734,11 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

<del>- * If an attachment is missing its metadata, try to generate it.

</del><ins>+ * Maybe attempt to generate attachment metadata, if missing.

</ins><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  *

<del>- * @param post $attachment Post object.

</del><ins>+ * @param WP_Post $attachment Attachment object.

</ins><span class="cx">  */

</span><span class="cx"> function wp_maybe_generate_attachment_metadata( $attachment ) {

</span><span class="cx">  if ( empty( $attachment ) || ( empty( $attachment->ID ) || ! $attachment_id = (int) $attachment->ID ) ) {

</span><span class="lines">@@ -2759,13 +2759,13 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

</span><del>- * Determine if a post supports thumbnails based on the passed $post

</del><ins>+ * Determine if a post supports thumbnails based on the passed post object.

</ins><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  *

</span><del>- * @param WP_Post $post

</del><ins>+ * @param WP_Post $post Post object.

</ins><span class="cx">  *

</span><del>- * @return boolean

</del><ins>+ * @return bool Whether the post type supports thumbnails.

</ins><span class="cx">  */

</span><span class="cx"> function post_supports_thumbnails( $post ) {

</span><span class="cx">  if ( 'attachment' === $post->post_type ) {

</span><span class="lines">@@ -2780,13 +2780,13 @@

</span><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

</span><del>- * Determine if a theme supports thumbnails based on the passed $post

</del><ins>+ * Determine if a theme supports thumbnails based on the passed post object.

</ins><span class="cx">  *

</span><span class="cx">  * @since 3.9.0

</span><span class="cx">  *

</span><del>- * @param WP_Post $post

</del><ins>+ * @param WP_Post $post Post object.

</ins><span class="cx">  *

</span><del>- * @return boolean

</del><ins>+ * @return bool Whether the current theme supports thumbnails.

</ins><span class="cx">  */

</span><span class="cx"> function theme_supports_thumbnails( $post ) {

</span><span class="cx">  if ( 'attachment' === $post->post_type ) {

</span></span></pre>

</div>

</div>

</body>

</html>