Changeset 41288

Timestamp:

08/22/2017 11:11:23 AM (7 years ago)

Author:

johnbillion

Message:

Media: Rename several attachment related parameters from $post_id to $attachment_id for clarity, and improve related
documentation.

See #41017

Location:

trunk/src

Files:

• wp-admin/includes/image-edit.php (modified) (3 diffs)
• wp-includes/class-wp-image-editor-gd.php (modified) (1 diff)
• wp-includes/class-wp-image-editor-imagick.php (modified) (1 diff)
• wp-includes/class-wp-image-editor.php (modified) (1 diff)
• wp-includes/post.php (modified) (6 diffs)

trunk/src/wp-admin/includes/image-edit.php

@@ -232 +232 @@
 /**
  * Streams image in WP_Image_Editor to browser.
- * Provided for backcompat reasons
- *
- * @param WP_Image_Editor $image
- * @param string $mime_type
- * @param int $post_id
- * @return bool
- */
-function wp_stream_image( $image, $mime_type, $post_id ) {
+ *
+ * @param WP_Image_Editor $image         The image editor instance.
+ * @param string          $mime_type     The mime type of the image.
+ * @param int             $attachment_id The image's attachment post ID.
+ * @return bool True on success, false on failure.
+ */
+function wp_stream_image( $image, $mime_type, $attachment_id ) {
     if ( $image instanceof WP_Image_Editor ) {
 
@@ -247 +246 @@
          * @since 3.5.0
          *
-         * @param WP_Image_Editor $image   WP_Image_Editor instance.
-         * @param int             $post_id Post ID.
+         * @param WP_Image_Editor $image         The image editor instance.
+         * @param int             $attachment_id The attachment post ID.
          */
-        $image = apply_filters( 'image_editor_save_pre', $image, $post_id );
+        $image = apply_filters( 'image_editor_save_pre', $image, $attachment_id );
 
         if ( is_wp_error( $image->stream( $mime_type ) ) )
@@ -265 +264 @@
          * @deprecated 3.5.0 Use image_editor_save_pre instead.
          *
-         * @param resource $image   Image resource to be streamed.
-         * @param int      $post_id Post ID.
+         * @param resource $image         Image resource to be streamed.
+         * @param int      $attachment_id The attachment post ID.
          */
-        $image = apply_filters( 'image_save_pre', $image, $post_id );
+        $image = apply_filters( 'image_save_pre', $image, $attachment_id );
 
         switch ( $mime_type ) {

trunk/src/wp-includes/class-wp-image-editor-gd.php

@@ -430 +430 @@
      * @since 3.5.0
      *
-     * @param string $mime_type
-     * @return bool
+     * @param string $mime_type The mime type of the image.
+     * @return bool True on success, false on failure.
      */
     public function stream( $mime_type = null ) {

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -653 +653 @@
      * @since 3.5.0
      *
-     * @param string $mime_type
-     * @return true|WP_Error
+     * @param string $mime_type The mime type of the image.
+     * @return bool|WP_Error True on success, WP_Error object on failure.
      */
     public function stream( $mime_type = null ) {

trunk/src/wp-includes/class-wp-image-editor.php

@@ -165 +165 @@
      * @abstract
      *
-     * @param string $mime_type
-     * @return bool|WP_Error
+     * @param string $mime_type The mime type of the image.
+     * @return bool|WP_Error True on success, WP_Error object or false on failure.
      */
     abstract public function stream( $mime_type = null );

trunk/src/wp-includes/post.php

@@ -4964 +4964 @@
  * @since 2.1.0
  *
- * @param int  $post_id    Attachment ID. Default 0.
- * @param bool $unfiltered Optional. If true, filters are not run. Default false.
+ * @param int  $attachment_id Attachment post ID. Defaults to global $post.
+ * @param bool $unfiltered    Optional. If true, filters are not run. Default false.
  * @return mixed Attachment meta field. False on failure.
  */
-function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
-    $post_id = (int) $post_id;
-    if ( !$post = get_post( $post_id ) )
+function wp_get_attachment_metadata( $attachment_id = 0, $unfiltered = false ) {
+    $attachment_id = (int) $attachment_id;
+    if ( ! $post = get_post( $attachment_id ) ) {
         return false;
+    }
 
     $data = get_post_meta( $post->ID, '_wp_attachment_metadata', true );
@@ -4983 +4984 @@
      * @since 2.1.0
      *
-     * @param array|bool $data    Array of meta data for the given attachment, or false
-     *                            if the object does not exist.
-     * @param int        $post_id Attachment ID.
+     * @param array|bool $data          Array of meta data for the given attachment, or false
+     *                                  if the object does not exist.
+     * @param int        $attachment_id Attachment post ID.
      */
     return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID );
@@ -4995 +4996 @@
  * @since 2.1.0
  *
- * @param int   $post_id Attachment ID.
- * @param array $data    Attachment data.
+ * @param int   $attachment_id Attachment post ID.
+ * @param array $data          Attachment meta data.
  * @return int|bool False if $post is invalid.
  */
-function wp_update_attachment_metadata( $post_id, $data ) {
-    $post_id = (int) $post_id;
-    if ( !$post = get_post( $post_id ) )
+function wp_update_attachment_metadata( $attachment_id, $data ) {
+    $attachment_id = (int) $attachment_id;
+    if ( ! $post = get_post( $attachment_id ) ) {
         return false;
+    }
 
     /**
@@ -5009 +5011 @@
      * @since 2.1.0
      *
-     * @param array $data    Array of updated attachment meta data.
-     * @param int   $post_id Attachment ID.
+     * @param array $data          Array of updated attachment meta data.
+     * @param int   $attachment_id Attachment post ID.
      */
     if ( $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ) )
@@ -5025 +5027 @@
  * @global string $pagenow
  *
- * @param int $post_id Optional. Attachment ID. Default 0.
+ * @param int $attachment_id Optional. Attachment post ID. Defaults to global $post.
  * @return string|false Attachment URL, otherwise false.
  */
-function wp_get_attachment_url( $post_id = 0 ) {
-    $post_id = (int) $post_id;
-    if ( !$post = get_post( $post_id ) )
+function wp_get_attachment_url( $attachment_id = 0 ) {
+    $attachment_id = (int) $attachment_id;
+    if ( ! $post = get_post( $attachment_id ) ) {
         return false;
+    }
 
     if ( 'attachment' != $post->post_type )
@@ -5073 +5076 @@
      * @since 2.1.0
      *
-     * @param string $url     URL for the given attachment.
-     * @param int    $post_id Attachment ID.
+     * @param string $url           URL for the given attachment.
+     * @param int    $attachment_id Attachment post ID.
      */
     $url = apply_filters( 'wp_get_attachment_url', $url, $post->ID );