BP_Attachment::get_image_data( string $file )

Get full data for an image

Description

Parameters

$file: (Required) Absolute path to the uploaded image.

Return

(bool|array) An associate array containing the width, height and metadatas. False in case an important image attribute is missing.

Source

File: bp-core/classes/class-bp-attachment.php

public static function get_image_data( $file ) {
    // Try to get image basic data.
    list( $width, $height, $sourceImageType ) = @getimagesize( $file );
 
    // No need to carry on if we couldn't get image's basic data.
    if ( is_null( $width ) || is_null( $height ) || is_null( $sourceImageType ) ) {
        return false;
    }
 
    // Initialize the image data.
    $image_data = array(
        'width'  => $width,
        'height' => $height,
    );
 
    /**
     * Make sure the wp_read_image_metadata function is reachable for the old Avatar UI
     * or if WordPress < 3.9 (New Avatar UI is not available in this case)
     */
    if ( ! function_exists( 'wp_read_image_metadata' ) ) {
        require_once( ABSPATH . 'wp-admin/includes/image.php' );
    }
 
    // Now try to get image's meta data.
    $meta = wp_read_image_metadata( $file );
    if ( ! empty( $meta ) ) {
        $image_data['meta'] = $meta;
    }
 
    /**
     * Filter here to add/remove/edit data to the image full data
     *
     * @since BuddyPress 2.4.0
     *
     * @param array $image_data An associate array containing the width, height and metadatas.
     */
    return apply_filters( 'bp_attachments_get_image_data', $image_data );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.4.0	Introduced.

Uses

Uses
Uses	Description
bp-core/classes/class-bp-attachment.php: bp_attachments_get_image_data	Filter here to add/remove/edit data to the image full data

Used By
Used By	Description
bp-core/classes/class-bp-attachment-cover-image.php: BP_Attachment_Cover_Image::fit()	Adjust the cover photo to fit with advised width & height.
bp-core/classes/class-bp-attachment-avatar.php: BP_Attachment_Avatar::shrink()	Maybe shrink the attachment to fit maximum allowed width.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents