Skip to content

Media: Add unit tests for pre_wp_get_image_alttext filter #14063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robelsust wants to merge 4 commits into
base: trunk
Choose a base branch
from
Open

Media: Add unit tests for pre_wp_get_image_alttext filter #14063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03e3811
Media: Add unit tests for `pre_wp_get_image_alttext` filter.
robelsust Oct 7, 2026
8df4aff
Media: Add `wp_read_image_metadata_allowed_keys` filter in `wp_read_i…
robelsust Oct 8, 2026
7e24989
Media: Decouple title and caption in image metadata extraction and dr…
robelsust Oct 14, 2026
67c170f
Merge branch 'trunk' into feature/66248-pre-wp-get-image-alttext
robelsust Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 89 additions & 50 deletions src/wp-admin/includes/image.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -857,13 +857,37 @@ function wp_read_image_metadata( $file ) {
'alt' => '',
);

/**
* Filters the list of allowed metadata keys to extract from an image.
*
* Allows customizing or disabling extraction of specific metadata fields
* (such as 'alt', 'caption', 'title', 'copyright', etc.), or disabling metadata extraction entirely.
*
* @since 7.2.0
*
* @param string[] $allowed_keys Array of metadata keys to extract. Defaults to all keys:
* 'aperture', 'credit', 'camera', 'caption', 'created_timestamp',
* 'copyright', 'focal_length', 'iso', 'shutter_speed', 'title',
* 'orientation', 'keywords', 'alt'.
* @param string $file Path to the image file.
* @param int $image_type Type of image, one of the `IMAGETYPE_*` constants.
*/
$allowed_keys = apply_filters( 'wp_read_image_metadata_allowed_keys', array_keys( $meta ), $file, $image_type );

if ( ! is_array( $allowed_keys ) ) {
$allowed_keys = array();
}

$iptc_keys = array( 'title', 'caption', 'credit', 'created_timestamp', 'copyright', 'keywords' );
$extract_iptc = ! empty( array_intersect( $iptc_keys, $allowed_keys ) );

$iptc = array();
$info = array();
/*
* Read IPTC first, since it might contain data not available in exif such
* as caption, description etc.
*/
if ( is_callable( 'iptcparse' ) ) {
if ( $extract_iptc && is_callable( 'iptcparse' ) ) {
wp_getimagesize( $file, $info );

if ( ! empty( $info['APP13'] ) ) {
Expand All @@ -882,52 +906,63 @@ function wp_read_image_metadata( $file ) {
}

// Headline, "A brief synopsis of the caption".
if ( ! empty( $iptc['2#105'][0] ) ) {
$meta['title'] = trim( $iptc['2#105'][0] );
/*
* Title, "Many use the Title field to store the filename of the image,
* though the field may be used in many ways".
*/
} elseif ( ! empty( $iptc['2#005'][0] ) ) {
$meta['title'] = trim( $iptc['2#005'][0] );
if ( in_array( 'title', $allowed_keys, true ) ) {
if ( ! empty( $iptc['2#105'][0] ) ) {
$meta['title'] = trim( $iptc['2#105'][0] );
/*
* Title, "Many use the Title field to store the filename of the image,
* though the field may be used in many ways".
*/
} elseif ( ! empty( $iptc['2#005'][0] ) ) {
$meta['title'] = trim( $iptc['2#005'][0] );
}
}

if ( ! empty( $iptc['2#120'][0] ) ) { // Description / legacy caption.
if ( ( in_array( 'title', $allowed_keys, true ) || in_array( 'caption', $allowed_keys, true ) ) && ! empty( $iptc['2#120'][0] ) ) { // Description / legacy caption.
$caption = trim( $iptc['2#120'][0] );

mbstring_binary_safe_encoding();
$caption_length = strlen( $caption );
reset_mbstring_encoding();

if ( empty( $meta['title'] ) && $caption_length < 80 ) {
if ( in_array( 'title', $allowed_keys, true ) && empty( $meta['title'] ) && $caption_length < 80 ) {
// Assume the title is stored in 2:120 if it's short.
$meta['title'] = $caption;

@siliconforks siliconforks Oct 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To execute this line, you need to have both caption and title in $allowed_keys. I think you should only need title?

}

$meta['caption'] = $caption;
if ( in_array( 'caption', $allowed_keys, true ) ) {
$meta['caption'] = $caption;
}
}

if ( ! empty( $iptc['2#110'][0] ) ) { // Credit.
$meta['credit'] = trim( $iptc['2#110'][0] );
} elseif ( ! empty( $iptc['2#080'][0] ) ) { // Creator / legacy byline.
$meta['credit'] = trim( $iptc['2#080'][0] );
if ( in_array( 'credit', $allowed_keys, true ) ) {
if ( ! empty( $iptc['2#110'][0] ) ) { // Credit.
$meta['credit'] = trim( $iptc['2#110'][0] );
} elseif ( ! empty( $iptc['2#080'][0] ) ) { // Creator / legacy byline.
$meta['credit'] = trim( $iptc['2#080'][0] );
}
}

if ( ! empty( $iptc['2#055'][0] ) && ! empty( $iptc['2#060'][0] ) ) { // Created date and time.
if ( in_array( 'created_timestamp', $allowed_keys, true ) && ! empty( $iptc['2#055'][0] ) && ! empty( $iptc['2#060'][0] ) ) { // Created date and time.
$meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );
}

if ( ! empty( $iptc['2#116'][0] ) ) { // Copyright.
if ( in_array( 'copyright', $allowed_keys, true ) && ! empty( $iptc['2#116'][0] ) ) { // Copyright.
$meta['copyright'] = trim( $iptc['2#116'][0] );
}

if ( ! empty( $iptc['2#025'][0] ) ) { // Keywords array.
if ( in_array( 'keywords', $allowed_keys, true ) && ! empty( $iptc['2#025'][0] ) ) { // Keywords array.
$meta['keywords'] = $iptc['2#025'];
}
}
}

$meta['alt'] = wp_get_image_alttext( $file );
if ( in_array( 'alt', $allowed_keys, true ) ) {
$meta['alt'] = wp_get_image_alttext( $file );
}

$exif_keys = array( 'aperture', 'credit', 'camera', 'caption', 'created_timestamp', 'copyright', 'focal_length', 'iso', 'shutter_speed', 'title', 'orientation' );
$extract_exif = ! empty( array_intersect( $exif_keys, $allowed_keys ) );

$exif = array();

Expand All @@ -941,7 +976,7 @@ function wp_read_image_metadata( $file ) {
*/
$exif_image_types = apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) );

if ( is_callable( 'exif_read_data' ) && in_array( $image_type, $exif_image_types, true ) ) {
if ( $extract_exif && is_callable( 'exif_read_data' ) && in_array( $image_type, $exif_image_types, true ) ) {
// Don't silence errors when in debug mode, unless running unit tests.
if ( defined( 'WP_DEBUG' ) && WP_DEBUG
&& ! defined( 'WP_RUN_CORE_TESTS' )
Expand Down Expand Up @@ -970,79 +1005,83 @@ function wp_read_image_metadata( $file ) {
mbstring_binary_safe_encoding();
$description_length = strlen( $exif_description );
reset_mbstring_encoding();
if ( empty( $meta['title'] ) && $description_length < 80 ) {
if ( in_array( 'title', $allowed_keys, true ) && empty( $meta['title'] ) && $description_length < 80 ) {
// Assume the title is stored in ImageDescription.
$meta['title'] = $exif_description;
}

// If both user comments and description are present.
if ( empty( $meta['caption'] ) && $exif_usercomment ) {
if ( ! empty( $meta['title'] ) && $exif_description === $meta['title'] ) {
$caption = $exif_usercomment;
} else {
if ( $exif_description === $exif_usercomment ) {
$caption = $exif_description;
if ( in_array( 'caption', $allowed_keys, true ) ) {
// If both user comments and description are present.
if ( empty( $meta['caption'] ) && $exif_usercomment ) {
if ( ! empty( $meta['title'] ) && $exif_description === $meta['title'] ) {
$caption = $exif_usercomment;
} else {
$caption = trim( $exif_description . ' ' . $exif_usercomment );
if ( $exif_description === $exif_usercomment ) {
$caption = $exif_description;
} else {
$caption = trim( $exif_description . ' ' . $exif_usercomment );
}
}
$meta['caption'] = $caption;
}
$meta['caption'] = $caption;
}

if ( empty( $meta['caption'] ) && $exif_usercomment ) {
$meta['caption'] = $exif_usercomment;
}
if ( empty( $meta['caption'] ) && $exif_usercomment ) {
$meta['caption'] = $exif_usercomment;
}

if ( empty( $meta['caption'] ) ) {
$meta['caption'] = $exif_description;
if ( empty( $meta['caption'] ) ) {
$meta['caption'] = $exif_description;
}
}
} elseif ( $exif_usercomment && ( ( in_array( 'caption', $allowed_keys, true ) && empty( $meta['caption'] ) ) || ( in_array( 'title', $allowed_keys, true ) && empty( $meta['title'] ) ) ) ) {
if ( in_array( 'caption', $allowed_keys, true ) && empty( $meta['caption'] ) ) {
$meta['caption'] = $exif_usercomment;
}
} elseif ( empty( $meta['caption'] ) && $exif_usercomment ) {
$meta['caption'] = $exif_usercomment;
$description_length = strlen( $exif_usercomment );
if ( empty( $meta['title'] ) && $description_length < 80 ) {
if ( in_array( 'title', $allowed_keys, true ) && empty( $meta['title'] ) && $description_length < 80 ) {
$meta['title'] = trim( $exif_usercomment );

@siliconforks siliconforks Oct 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here as above - you need to have both caption and title in $allowed_keys. I think it should just be title.

}
} elseif ( empty( $meta['caption'] ) && ! empty( $exif['Comments'] ) ) {
} elseif ( in_array( 'caption', $allowed_keys, true ) && empty( $meta['caption'] ) && ! empty( $exif['Comments'] ) ) {
$meta['caption'] = trim( $exif['Comments'] );
}

if ( empty( $meta['credit'] ) ) {
if ( in_array( 'credit', $allowed_keys, true ) && empty( $meta['credit'] ) ) {
if ( ! empty( $exif['Artist'] ) ) {
$meta['credit'] = trim( $exif['Artist'] );
} elseif ( ! empty( $exif['Author'] ) ) {
$meta['credit'] = trim( $exif['Author'] );
}
}

if ( empty( $meta['copyright'] ) && ! empty( $exif['Copyright'] ) ) {
if ( in_array( 'copyright', $allowed_keys, true ) && empty( $meta['copyright'] ) && ! empty( $exif['Copyright'] ) ) {
$meta['copyright'] = trim( $exif['Copyright'] );
}
if ( ! empty( $exif['FNumber'] ) && is_scalar( $exif['FNumber'] ) ) {
if ( in_array( 'aperture', $allowed_keys, true ) && ! empty( $exif['FNumber'] ) && is_scalar( $exif['FNumber'] ) ) {
$meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );
}
if ( ! empty( $exif['Model'] ) ) {
if ( in_array( 'camera', $allowed_keys, true ) && ! empty( $exif['Model'] ) ) {
$meta['camera'] = trim( $exif['Model'] );
}
if ( empty( $meta['created_timestamp'] ) && ! empty( $exif['DateTimeDigitized'] ) ) {
if ( in_array( 'created_timestamp', $allowed_keys, true ) && empty( $meta['created_timestamp'] ) && ! empty( $exif['DateTimeDigitized'] ) ) {
$meta['created_timestamp'] = wp_exif_date2ts( $exif['DateTimeDigitized'] );
}
if ( ! empty( $exif['FocalLength'] ) ) {
if ( in_array( 'focal_length', $allowed_keys, true ) && ! empty( $exif['FocalLength'] ) ) {
$meta['focal_length'] = (string) $exif['FocalLength'];
if ( is_scalar( $exif['FocalLength'] ) ) {
$meta['focal_length'] = (string) wp_exif_frac2dec( $exif['FocalLength'] );
}
}
if ( ! empty( $exif['ISOSpeedRatings'] ) ) {
if ( in_array( 'iso', $allowed_keys, true ) && ! empty( $exif['ISOSpeedRatings'] ) ) {
$meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];
$meta['iso'] = trim( $meta['iso'] );
}
if ( ! empty( $exif['ExposureTime'] ) ) {
if ( in_array( 'shutter_speed', $allowed_keys, true ) && ! empty( $exif['ExposureTime'] ) ) {
$meta['shutter_speed'] = (string) $exif['ExposureTime'];
if ( is_scalar( $exif['ExposureTime'] ) ) {
$meta['shutter_speed'] = (string) wp_exif_frac2dec( $exif['ExposureTime'] );
}
}
if ( ! empty( $exif['Orientation'] ) ) {
if ( in_array( 'orientation', $allowed_keys, true ) && ! empty( $exif['Orientation'] ) ) {
$meta['orientation'] = $exif['Orientation'];
}
}
Expand Down
Loading
Loading