<!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>[31530] trunk/src/wp-includes/media.php: Clarify a wide variety of function, parameter, and return descriptions in DocBlocks throughout wp-includes/media.php.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/31530">31530</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/31530","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-02-24 07:41:24 +0000 (Tue, 24 Feb 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Clarify a wide variety of function, parameter, and return descriptions in DocBlocks throughout wp-includes/media.php.
Props stevegrunwell, DrewAPicture.
Fixes <a href="https://core.trac.wordpress.org/ticket/28408">#28408</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 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2015-02-24 06:06:59 UTC (rev 31529)
+++ trunk/src/wp-includes/media.php 2015-02-24 07:41:24 UTC (rev 31530)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,10 +59,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // if no width is set, default to the theme content width if available
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> elseif ( $size == 'large' ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We're inserting a large size image into the editor. If it's a really
- // big image we'll scale it down to fit reasonably within the editor
- // itself, and within the theme's content width if it's known. The user
- // can resize it in the editor if they wish.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * We're inserting a large size image into the editor. If it's a really
+ * big image we'll scale it down to fit reasonably within the editor
+ * itself, and within the theme's content width if it's known. The user
+ * can resize it in the editor if they wish.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $max_width = intval(get_option('large_size_w'));
</span><span class="cx" style="display: block; padding: 0 10px"> $max_height = intval(get_option('large_size_h'));
</span><span class="cx" style="display: block; padding: 0 10px"> if ( intval($content_width) > 0 )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,11 +111,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|string $width Optional. Width attribute value.
- * @param int|string $height Optional. Height attribute value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|string $width Image width in pixels.
+ * @param int|string $height Image height in pixels.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML attributes for width and, or height.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function image_hwstring($width, $height) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function image_hwstring( $width, $height ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $out = '';
</span><span class="cx" style="display: block; padding: 0 10px"> if ($width)
</span><span class="cx" style="display: block; padding: 0 10px"> $out .= 'width="'.intval($width).'" ';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,11 +142,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $id Attachment ID for image.
- * @param array|string $size Optional, default is 'medium'. Size of image, either array or string.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $id Attachment ID for image.
+ * @param array|string $size Optional. Image size to scale to. Accepts a registered image size
+ * or flat array of height and width values. Default 'medium'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|array False on failure, array on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function image_downsize($id, $size = 'medium') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function image_downsize( $id, $size = 'medium' ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !wp_attachment_is_image($id) )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,7 +287,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * An <img src /> tag for an image attachment, scaling it down if requested.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets an img tag for an image attachment, scaling it down if requested.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The filter 'get_image_tag_class' allows for changing the class name for the
</span><span class="cx" style="display: block; padding: 0 10px"> * image without having to use regular expressions on the HTML content. The
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -297,14 +300,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $id Attachment ID.
- * @param string $alt Image Description for the alt attribute.
- * @param string $title Image Description for the title attribute.
- * @param string $align Part of the class name for aligning the image.
- * @param string $size Optional. Default is 'medium'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $id Attachment ID.
+ * @param string $alt Image Description for the alt attribute.
+ * @param string $title Image Description for the title attribute.
+ * @param string $align Part of the class name for aligning the image.
+ * @param string|array $size Optional. Registered image size to retrieve a tag for, or flat array
+ * of height and width values. Default 'medium'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML IMG element for given image attachment
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_image_tag($id, $alt, $title, $align, $size='medium') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> list( $img_src, $width, $height ) = image_downsize($id, $size);
</span><span class="cx" style="display: block; padding: 0 10px"> $hwstring = image_hwstring($width, $height);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,20 +349,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Calculates the new dimensions for a downsampled image.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calculates the new dimensions for a down-sampled image.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If either width or height are empty, no constraint is applied on
</span><span class="cx" style="display: block; padding: 0 10px"> * that dimension.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $current_width Current width of the image.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $current_width Current width of the image.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $current_height Current height of the image.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $max_width Optional. Maximum wanted width.
- * @param int $max_height Optional. Maximum wanted height.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $max_width Optional. Max width in pixels to constrain to. Default 0.
+ * @param int $max_height Optional. Max height in pixels to constrain to. Default 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array First item is the width, the second item is the height.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, $max_height=0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_constrain_dimensions( $current_width, $current_height, $max_width = 0, $max_height = 0 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( !$max_width && !$max_height )
</span><span class="cx" style="display: block; padding: 0 10px"> return array( $current_width, $current_height );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -405,11 +409,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $h = $max_height; // Round it up
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filter dimensions to constrain down-sampled images to.
+ *
+ * @since 4.1.0
+ *
+ * @param array $dimensions The image width and height.
+ * @param int $current_width The current width of the image.
+ * @param int $current_height The current height of the image.
+ * @param int $max_width The maximum width permitted.
+ * @param int $max_height The maximum height permitted.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve calculated resize dimensions for use in WP_Image_Editor.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves calculated resize dimensions for use in WP_Image_Editor.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Calculates dimensions and coordinates for a resized image that fits
</span><span class="cx" style="display: block; padding: 0 10px"> * within a specified width and height.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -523,7 +538,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Resize an image to make a thumbnail or intermediate size.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Resizes an image to make a thumbnail or intermediate size.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The returned array has the file size, the image width, and image height. The
</span><span class="cx" style="display: block; padding: 0 10px"> * filter 'image_make_intermediate_size' can be used to hook in and change the
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -531,10 +546,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $file File path.
- * @param int $width Image width.
- * @param int $height Image height.
- * @param bool $crop Optional, default is false. Whether to crop image to specified height and width or resize.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file File path.
+ * @param int $width Image width.
+ * @param int $height Image height.
+ * @param bool $crop Optional. Whether to crop image to specified height and width or resize.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|array False, if no image was created. Metadata array on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -555,7 +571,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve the image's intermediate size (resized) path, width, and height.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the image's intermediate size (resized) path, width, and height.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The $size parameter can be an array with the width and height respectively.
</span><span class="cx" style="display: block; padding: 0 10px"> * If the size matches the 'sizes' metadata array for width and height, then it
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -574,13 +590,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * browser scale down the image.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see add_image_size()
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $post_id Attachment ID for image.
- * @param array|string $size Optional, default is 'thumbnail'. Size of image, either array or string.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $post_id Attachment ID.
+ * @param array|string $size Optional. Registered image size to retrieve or flat array of height
+ * and width dimensions. Default 'thumbnail'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|array False on failure or array of file path, width, and height on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function image_get_intermediate_size($post_id, $size='thumbnail') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -633,9 +649,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get the available image sizes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the available intermediate image sizes.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Returns a filtered array of image size strings
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global array $_wp_additional_image_sizes
+ *
+ * @return array Returns a filtered array of image size strings.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_intermediate_image_sizes() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $_wp_additional_image_sizes;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -661,12 +681,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $attachment_id Image attachment ID.
- * @param string $size Optional, default is 'thumbnail'.
- * @param bool $icon Optional, default is false. Whether it is an icon.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $attachment_id Image attachment ID.
+ * @param string|array $size Optional. Registered image size to retrieve the source for or a flat
+ * array of height and width dimensions. Default 'thumbnail'.
+ * @param bool $icon Optional. Whether the image should be treated as an icon. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|array Returns an array (url, width, height), or false, if no image is available.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = false) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // get a thumbnail or intermediate image if there is one
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $image = image_downsize($attachment_id, $size) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -677,6 +698,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $icon && $src = wp_mime_type_icon($attachment_id) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/post.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $src_file = $icon_dir . '/' . wp_basename($src);
</span><span class="cx" style="display: block; padding: 0 10px"> @list($width, $height) = getimagesize($src_file);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -688,19 +710,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get an HTML img element representing an image attachment
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * While $size will accept an array, it is better to register a size with
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * While `$size` will accept an array, it is better to register a size with
</ins><span class="cx" style="display: block; padding: 0 10px"> * add_image_size() so that a cropped version is generated. It's much more
</span><span class="cx" style="display: block; padding: 0 10px"> * efficient than having to find the closest-sized image and then having the
</span><span class="cx" style="display: block; padding: 0 10px"> * browser scale down the image.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see add_image_size()
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param int $attachment_id Image attachment ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|array $size Optional. Default 'thumbnail'.
- * @param bool $icon Optional. Whether it is an icon. Default false.
- * @param string|array $attr Optional. Attributes for the image markup. Default empty string.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $size Optional. Registered image size or flat array of height and width
+ * dimensions. Default 'thumbnail'.
+ * @param bool $icon Optional. Whether the image should be treated as an icon. Default false.
+ * @param string|array $attr Optional. Attributes for the image markup. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML img element or empty string on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -749,13 +770,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Adds a 'wp-post-image' class to post thumbnails
- * Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
- * dynamically add/remove itself so as to only filter post thumbnails
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds a 'wp-post-image' class to post thumbnails. Internal use only.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Uses the 'begin_fetch_post_thumbnail_html' and 'end_fetch_post_thumbnail_html' action hooks to
+ * dynamically add/remove itself so as to only filter post thumbnails.
+ *
+ * @ignore
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $attr Attributes including src, class, alt, title
- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param array $attr Thumbnail attributes including src, class, alt, title.
+ * @return array Modified array of attributes including the new 'wp-post-image' class.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_post_thumbnail_class_filter( $attr ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $attr['class'] .= ' wp-post-image';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -763,18 +787,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds '_wp_post_thumbnail_class_filter' callback to the 'wp_get_attachment_image_attributes'
+ * filter hook. Internal use only.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ignore
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param array $attr Thumbnail attributes including src, class, alt, title.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_post_thumbnail_class_filter_add( $attr ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes the '_wp_post_thumbnail_class_filter' callback from the 'wp_get_attachment_image_attributes'
+ * filter hook. Internal use only.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ignore
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param array $attr Thumbnail attributes including src, class, alt, title.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_post_thumbnail_class_filter_remove( $attr ) {
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -784,7 +816,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_shortcode('caption', 'img_caption_shortcode');
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The Caption shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Builds the Caption shortcode output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Allows a plugin to replace the content that would otherwise be returned. The
</span><span class="cx" style="display: block; padding: 0 10px"> * filter is 'img_caption_shortcode' and passes an empty string, the attr
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -795,7 +827,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $attr {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $attr {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Attributes of the caption shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $id ID of the div element for the caption.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -805,7 +837,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $caption The caption text.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $class Additional class name(s) added to the caption container.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $content Optional. Shortcode content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $content Shortcode content.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML content to display the caption.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function img_caption_shortcode( $attr, $content = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -887,7 +919,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_shortcode('gallery', 'gallery_shortcode');
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The Gallery shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Builds the Gallery shortcode output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This implements the functionality of the Gallery Shortcode for displaying
</span><span class="cx" style="display: block; padding: 0 10px"> * WordPress images on a post.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1105,7 +1137,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output the templates used by playlists.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs the templates used by playlists.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1143,7 +1175,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output and enqueue default scripts and styles for playlists.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs and enqueue default scripts and styles for playlists.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1160,7 +1192,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The playlist shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Builds the Playlist shortcode output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This implements the functionality of the playlist shortcode for displaying
</span><span class="cx" style="display: block; padding: 0 10px"> * a collection of WordPress audio or video files in a post.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1406,12 +1438,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_shortcode( 'playlist', 'wp_playlist_shortcode' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Provide a No-JS Flash fallback as a last resort for audio / video
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Provides a No-JS Flash fallback as a last resort for audio / video.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $url
- * @return string Fallback HTML
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $url The media element URL.
+ * @return string Fallback HTML.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_mediaelement_fallback( $url ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1426,10 +1458,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return a filtered list of WP-supported audio formats.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns a filtered list of WP-supported audio formats.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return array Supported audio formats.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_audio_extensions() {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1444,12 +1477,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return useful keys to use to lookup data from an attachment's stored metadata.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns useful keys to use to lookup data from an attachment's stored metadata.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $attachment The current attachment, provided for context.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $context The context. Accepts 'edit', 'display'. Default 'display'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $context Optional. The context. Accepts 'edit', 'display'. Default 'display'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Key/value pairs of field keys to labels.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1479,14 +1512,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The Audio shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Builds the Audio shortcode output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This implements the functionality of the Audio Shortcode for displaying
</span><span class="cx" style="display: block; padding: 0 10px"> * WordPress mp3s in a post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $attr {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $attr {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Attributes of the audio shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $src URL to the source of the audio file. Default empty.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1497,7 +1530,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $id The 'id' attribute for the `<audio>` element. Default 'audio-{$post_id}-{$instance}'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $style The 'style' attribute for the `<audio>` element. Default 'width: 100%'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $content Optional. Shortcode content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $content Shortcode content.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML content to display audio.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_audio_shortcode( $attr, $content = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1653,10 +1686,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_shortcode( 'audio', 'wp_audio_shortcode' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return a filtered list of WP-supported video formats
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns a filtered list of WP-supported video formats.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return array List of supported video formats.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_video_extensions() {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1671,14 +1705,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The Video shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Builds the Video shortcode output.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This implements the functionality of the Video Shortcode for displaying
</span><span class="cx" style="display: block; padding: 0 10px"> * WordPress mp4s in a post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $attr {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $attr {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Attributes of the shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $src URL to the source of the video file. Default empty.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1694,7 +1728,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $id The 'id' attribute for the `<video>` element.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'video-{$post_id}-{$instance}'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $content Optional. Shortcode content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $content Shortcode content.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML content to display video.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_video_shortcode( $attr, $content = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1906,39 +1940,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_shortcode( 'video', 'wp_video_shortcode' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display previous image link that has the same post parent.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays previous image link that has the same post parent.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
- * @param string $text Optional, default is false. If included, link will reflect $text variable.
- * @return string HTML content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @see adjacent_image_link()
+ *
+ * @param string|array $size Optional. Registered image size or flat array of height and width dimensions.
+ * 0 or 'none' will default to 'post_title' or `$text`. Default 'thumbnail'.
+ * @param string $text Optional. Link text. Default false.
+ * @return string HTML output for the previous image link.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function previous_image_link($size = 'thumbnail', $text = false) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function previous_image_link( $size = 'thumbnail', $text = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> adjacent_image_link(true, $size, $text);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display next image link that has the same post parent.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays next image link that has the same post parent.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. 0 or 'none' will default to post_title or $text;
- * @param string $text Optional, default is false. If included, link will reflect $text variable.
- * @return string HTML content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @see adjacent_image_link()
+ *
+ * @param string|array $size Optional. Registered image size or flat array of height and width dimensions.
+ * 0 or 'none' will default to 'post_title' or `$text`. Default 'thumbnail'.
+ * @param string $text Optional. Link text. Default false.
+ * @return string HTML output for the next image link.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function next_image_link($size = 'thumbnail', $text = false) {
</span><span class="cx" style="display: block; padding: 0 10px"> adjacent_image_link(false, $size, $text);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display next or previous image link that has the same post parent.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays next or previous image link that has the same post parent.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the current attachment object from the $post global.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $prev Optional. Default is true to display previous link, false for next.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $prev Optional. Whether to display the next (false) or previous (true) link. Default true.
+ * @param string|array $size Optional. Registered image size or flat array of height and width dimensions.
+ * Default 'thumbnail'.
+ * @param bool $text Optional. Link text. Default false.
+ * @return string The adjacent image link.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post = get_post();
</span><span class="cx" style="display: block; padding: 0 10px"> $attachments = array_values( get_children( array( 'post_parent' => $post->post_parent, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => 'ASC', 'orderby' => 'menu_order ID' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1979,14 +2025,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve taxonomies attached to the attachment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves taxonomies attached to given the attachment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|array|object $attachment Attachment ID, Attachment data array, or Attachment data object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|array|object $attachment Attachment ID, data array, or data object.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Empty array on failure. List of taxonomies on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_attachment_taxonomies($attachment) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_attachment_taxonomies( $attachment ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_int( $attachment ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment = get_post( $attachment );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_array( $attachment ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2018,14 +2064,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return all of the taxonomy names that are registered for attachments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves all of the taxonomy names that are registered for attachments.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see get_attachment_taxonomies()
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see get_taxonomies()
+ *
+ * @param string $output Optional. The type of taxonomy output to return. Accepts 'names' or 'objects'.
+ * Default 'names'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array The names of all taxonomy of $object_type.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_taxonomies_for_attachments( $output = 'names' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2047,13 +2095,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Create new GD image resource with transparency support
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @TODO: Deprecate if possible.
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @todo: Deprecate if possible.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $width Image width
- * @param int $height Image height
- * @return resource resource
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $width Image width in pixels.
+ * @param int $height Image height in pixels..
+ * @return resource The GD image resource.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_imagecreatetruecolor($width, $height) {
</span><span class="cx" style="display: block; padding: 0 10px"> $img = imagecreatetruecolor($width, $height);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2065,16 +2114,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Register an embed handler. This function should probably only be used for sites that do not support oEmbed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers an embed handler.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Should probably only be used for sites that do not support oEmbed.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Embed::register_handler()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global WP_Embed $wp_embed
- * @param string $id
- * @param string $regex
- * @param callable $callback
- * @param int $priority
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id An internal ID/name for the handler. Needs to be unique.
+ * @param string $regex The regex that will be used to see if this handler should be used for a URL.
+ * @param callback $callback The callback function that will be called if the regex is matched.
+ * @param int $priority Optional. Used to specify the order in which the registered handlers will
+ * be tested. Default 10.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_embed;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2082,14 +2134,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Unregister a previously registered embed handler.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Unregisters a previously-registered embed handler.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Embed::unregister_handler()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global WP_Embed $wp_embed
- * @param string $id
- * @param int $priority
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id The handler ID that should be removed.
+ * @param int $priority Optional. The priority of the handler to be removed. Default 10.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_embed_unregister_handler( $id, $priority = 10 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_embed;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2138,10 +2190,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $example_width The width of an example embed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see wp_constrain_dimensions()
+ *
+ * @param int $example_width The width of an example embed.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $example_height The height of an example embed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $max_width The maximum allowed width.
- * @param int $max_height The maximum allowed height.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $max_width The maximum allowed width.
+ * @param int $max_height The maximum allowed height.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array The maximum possible width and height based on the example ratio.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2157,10 +2211,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Attempts to fetch the embed HTML for a provided URL using oEmbed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_oEmbed
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $url The URL that should be embedded.
- * @param array $args Additional arguments and parameters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $url The URL that should be embedded.
+ * @param array $args Optional. Additional arguments and parameters for retrieving embed HTML.
+ * Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return false|string False on failure or the embed HTML on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_oembed_get( $url, $args = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2173,11 +2229,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds a URL format and oEmbed provider URL pair.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_oEmbed
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
- * @param string $provider The URL to the oEmbed provider.
- * @param boolean $regex Whether the $format parameter is in a regex format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $format The format of URL that this provider can handle. You can use asterisks
+ * as wildcards.
+ * @param string $provider The URL to the oEmbed provider.
+ * @param boolean $regex Optional. Whether the `$format` parameter is in a RegEx format. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_oembed_add_provider( $format, $provider, $regex = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( ABSPATH . WPINC . '/class-oembed.php' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2194,9 +2252,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Removes an oEmbed provider.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_oEmbed
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format The URL format for the oEmbed provider to remove.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Was the provider removed successfully?
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_oembed_remove_provider( $format ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( ABSPATH . WPINC . '/class-oembed.php' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2222,6 +2282,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * it hasn't, then it will load the embeds library.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @see wp_embed_register_handler()
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_maybe_load_embeds() {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2261,15 +2323,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The Google Video embed handler callback. Google Video does not support oEmbed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The Google Video embed handler callback.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Google Video does not support oEmbed.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Embed::register_handler()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Embed::shortcode()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
- * @param array $attr Embed attributes.
- * @param string $url The original URL that was matched by the regex.
- * @param array $rawattr The original unmodified attributes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $matches The RegEx matches from the provided regex when calling wp_embed_register_handler().
+ * @param array $attr Embed attributes.
+ * @param string $url The original URL that was matched by the regex.
+ * @param array $rawattr The original unmodified attributes.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The embed HTML.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2287,7 +2351,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $html Google Video HTML embed markup.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $matches The regex matches from the provided regex.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $matches The RegEx matches from the provided regex.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $attr An array of embed attributes.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The original URL that was matched by the regex.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $rawattr The original unmodified attributes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2302,8 +2366,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $matches The regex matches from the provided regex when calling
- * {@see wp_embed_register_handler()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $matches The RegEx matches from the provided regex when calling
+ * wp_embed_register_handler().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $attr Embed attributes.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The original URL that was matched by the regex.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $rawattr The original unmodified attributes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2312,6 +2376,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_embed;
</span><span class="cx" style="display: block; padding: 0 10px"> $embed = $wp_embed->autoembed( "https://youtube.com/watch?v={$matches[2]}" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter the YoutTube embed output.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2332,7 +2397,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $matches The RegEx matches from the provided regex when calling wp_embed_register_handler().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $attr Embed attributes.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The original URL that was matched by the regex.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $rawattr The original unmodified attributes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2359,10 +2424,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
- * @param array $attr Embed attributes.
- * @param string $url The original URL that was matched by the regex.
- * @param array $rawattr The original unmodified attributes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $matches The RegEx matches from the provided regex when calling wp_embed_register_handler().
+ * @param array $attr Embed attributes.
+ * @param string $url The original URL that was matched by the regex.
+ * @param array $rawattr The original unmodified attributes.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The embed HTML.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_embed_handler_video( $matches, $attr, $url, $rawattr ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2407,7 +2472,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Determine the maximum upload size allowed in php.ini.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines the maximum upload size allowed in php.ini.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2433,11 +2498,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns a WP_Image_Editor instance and loads file into it.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @access public
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $path Path to file to load
- * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
- * @return WP_Image_Editor|WP_Error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Path to the file to load.
+ * @param array $args Optional. Additional arguments for retrieving the image editor.
+ * Default empty array.
+ * @return WP_Image_Editor|WP_Error The WP_Image_Editor object if successful, an WP_Error
+ * object otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_image_editor( $path, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args['path'] = $path;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2470,10 +2536,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests whether there is an editor that supports a given mime type or methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @access public
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|array $args Array of requirements. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
- * @return boolean true if an eligible editor is found; false otherwise
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $args Optional. Array of arguments to retrieve the image editor supports.
+ * Default empty array.
+ * @return bool True if an eligible editor is found; false otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_image_editor_supports( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return (bool) _wp_image_editor_choose( $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2482,11 +2548,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests which editors are capable of supporting the request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ignore
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @access private
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Additional data. Accepts { 'mime_type'=>string, 'methods'=>{string, string, ...} }
- * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Array of arguments for choosing a capable editor. Default empty array.
+ * @return string|bool Class name for the first editor that claims to support the request. False if no
+ * editor claims to support the request.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _wp_image_editor_choose( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2798,6 +2865,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * all media JS APIs.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param array $args {
+ * Arguments for enqueuing media scripts.
+ *
+ * @type int|WP_Post A post object or ID.
+ * }
+ * @return array List of media view settings.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_enqueue_media( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3089,7 +3163,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve media attached to the passed post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves media attached to the passed post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3141,8 +3215,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $content A string which might contain media data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $types array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'
- * @return array A list of found HTML media embeds
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $types An array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'.
+ * @return array A list of found HTML media embeds.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_media_embedded_in_content( $content, $types = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $html = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3163,14 +3237,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve galleries from the passed post's content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves galleries from the passed post's content.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Optional. Post ID or object.
- * @param bool $html Whether to return HTML or data in the array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Post ID or object.
+ * @param bool $html Optional. Whether to return HTML or data in the array. Default true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array A list of arrays, each containing gallery data and srcs parsed
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * from the expanded shortcode.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * from the expanded shortcode.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_post_galleries( $post, $html = true ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $post = get_post( $post ) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3220,7 +3294,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $html Whether to return HTML or data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $html Optional. Whether to return HTML or data. Default is true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|array Gallery data and srcs parsed from the expanded shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_post_gallery( $post = 0, $html = true ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3244,9 +3318,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see get_post_galleries()
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array A list of lists, each containing image srcs parsed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * from an expanded shortcode
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * from an expanded shortcode
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_post_galleries_images( $post = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $galleries = get_post_galleries( $post, false );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3254,11 +3330,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check a post's content for galleries and return the image srcs for the first found gallery
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks a post's content for galleries and return the image srcs for the first found gallery
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see get_post_gallery()
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array A list of a gallery's image srcs in order.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_post_gallery_images( $post = 0 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3267,7 +3345,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Maybe attempt to generate attachment metadata, if missing.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Maybe attempts to generate attachment metadata, if missing.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3292,7 +3370,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Try to convert an attachment URL into a post ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tries to convert an attachment URL into a post ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3321,7 +3399,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>