<!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>[27202] trunk/src/wp-admin/includes/image.php: Inline documentation for hooks in wp-admin/includes/image.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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27202">27202</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-02-20 06:26:51 +0000 (Thu, 20 Feb 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-admin/includes/image.php.

Props theorboman, kpdesign.
Fixes <a href="http://core.trac.wordpress.org/ticket/25832">#25832</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesimagephp">trunk/src/wp-admin/includes/image.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesimagephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/image.php (27201 => 27202)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/image.php    2014-02-20 05:07:39 UTC (rev 27201)
+++ trunk/src/wp-admin/includes/image.php       2014-02-20 06:26:51 UTC (rev 27202)
</span><span class="lines">@@ -102,6 +102,13 @@
</span><span class="cx">                          $sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options
</span><span class="cx">          }
</span><span class="cx"> 
</span><ins>+               /**
+                * Filter the image sizes automatically generated when uploading an image.
+                *
+                * @since 2.9.0
+                *
+                * @param array $sizes An associative array of image sizes.
+                */
</ins><span class="cx">           $sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes );
</span><span class="cx"> 
</span><span class="cx">          if ( $sizes ) {
</span><span class="lines">@@ -155,6 +162,14 @@
</span><span class="cx">  if ( isset( $metadata['image']['data'] ) )
</span><span class="cx">          unset( $metadata['image']['data'] );
</span><span class="cx"> 
</span><ins>+       /**
+        * Filter the generated attachment meta data.
+        *
+        * @since 2.1.0
+        *
+        * @param array $metadata      An array of attachment meta data.
+        * @param int   $attachment_id Current attachment ID.
+        */
</ins><span class="cx">   return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="lines">@@ -268,7 +283,13 @@
</span><span class="cx">           }
</span><span class="cx">  }
</span><span class="cx"> 
</span><del>-       // fetch additional info from exif if available
</del><ins>+        /**
+        * Filter the image types to check for exif data.
+        *
+        * @since 2.5.0
+        *
+        * @param array $image_types Image types to check for exif data.
+        */
</ins><span class="cx">   if ( is_callable( 'exif_read_data' ) && in_array( $sourceImageType, apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) ) ) ) {
</span><span class="cx">          $exif = @exif_read_data( $file );
</span><span class="cx"> 
</span><span class="lines">@@ -316,6 +337,15 @@
</span><span class="cx">                  $meta[ $key ] = utf8_encode( $meta[ $key ] );
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       /**
+        * Filter the array of meta data read from an image's exif data.
+        *
+        * @since 2.5.0
+        *
+        * @param array  $meta            Image meta data.
+        * @param string $file            Path to image file.
+        * @param int    $sourceImageType Type of image.
+        */
</ins><span class="cx">   return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );
</span><span class="cx"> 
</span><span class="cx"> }
</span><span class="lines">@@ -337,7 +367,6 @@
</span><span class="cx">  * Validate that file is suitable for displaying within a web page.
</span><span class="cx">  *
</span><span class="cx">  * @since 2.5.0
</span><del>- * @uses apply_filters() Calls 'file_is_displayable_image' on $result and $path.
</del><span class="cx">  *
</span><span class="cx">  * @param string $path File path to test.
</span><span class="cx">  * @return bool True if suitable, false if not suitable.
</span><span class="lines">@@ -351,7 +380,15 @@
</span><span class="cx">  else
</span><span class="cx">          $result = true;
</span><span class="cx"> 
</span><del>-       return apply_filters('file_is_displayable_image', $result, $path);
</del><ins>+        /**
+        * Filter whether the current image is displayable in the browser.
+        *
+        * @since 2.5.0
+        *
+        * @param bool   $result Whether the image can be displayed. Default true.
+        * @param string $path   Path to the image.
+        */
+       return apply_filters( 'file_is_displayable_image', $result, $path );
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> /**
</span><span class="lines">@@ -384,7 +421,16 @@
</span><span class="cx">                  break;
</span><span class="cx">  }
</span><span class="cx">  if ( is_resource($image) ) {
</span><del>-               $image = apply_filters('load_image_to_edit', $image, $attachment_id, $size);
</del><ins>+                /**
+                * Filter the current image being loaded for editing.
+                *
+                * @since 2.9.0
+                *
+                * @param resource $image         Current image.
+                * @param string   $attachment_id Attachment ID.
+                * @param string   $size          Image size.
+                */
+               $image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );
</ins><span class="cx">           if ( function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
</span><span class="cx">                  imagealphablending($image, false);
</span><span class="cx">                  imagesavealpha($image, true);
</span><span class="lines">@@ -411,12 +457,43 @@
</span><span class="cx"> 
</span><span class="cx">  if ( $filepath && file_exists( $filepath ) ) {
</span><span class="cx">          if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
</span><ins>+                       /**
+                        * Filter the path to the current image.
+                        *
+                        * The filter is evaluated for all image sizes except 'full'.
+                        *
+                        * @since 3.1.0
+                        *
+                        * @param string $path          Path to the current image.
+                        * @param string $attachment_id Attachment ID.
+                        * @param string $size          Size of the image.
+                        */
</ins><span class="cx">                   $filepath = apply_filters( 'load_image_to_edit_filesystempath', path_join( dirname( $filepath ), $data['file'] ), $attachment_id, $size );
</span><span class="cx">          }
</span><span class="cx">  } elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
</span><ins>+               /**
+                * Filter the image URL if not in the local filesystem.
+                *
+                * The filter is only evaluated if fopen is enabled on the server.
+                *
+                * @since 3.1.0
+                *
+                * @param string $image_url     Current image URL.
+                * @param string $attachment_id Attachment ID.
+                * @param string $size          Size of the image.
+                */
</ins><span class="cx">           $filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
</span><span class="cx">  }
</span><span class="cx"> 
</span><ins>+       /**
+        * Filter the returned path or URL of the current image.
+        *
+        * @since 2.9.0
+        *
+        * @param string|bool $filepath      File path or URL to current image, or false.
+        * @param string      $attachment_id Attachment ID.
+        * @param string      $size          Size of the image.
+        */
</ins><span class="cx">   return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
</span><span class="cx"> }
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>