wp_mime_type_icon( string|int $mime = 0, string $preferred_ext = '.png' ): string|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$mimestring|intoptional

MIME type or attachment ID.Default: 0

$preferred_extstringoptional

File format to prefer in return. Default '.png'.Default: '.png'

Return value

string|false

Icon, false otherwise.

Performance profile

How much work a call to wp_mime_type_icon() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

16–153

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 244.

Plugin surface

4 hooks

Third-party callbacks on 'icon_dir', 'icon_dir_uri', 'icon_dirs' run inside this call, and their cost is not bounded by anything here.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• cacheobject cachewp_cache_get()called directly
• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 68 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_mime_type_icon() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 4

4 hooks fire while wp_mime_type_icon() runs, in this order:

1. 1
   apply_filters( icon_dir )filterline 7088 (+45 into the body)

   Filters the icon directory path.

2. 2
   apply_filters( icon_dir_uri )filterline 7097 (+54 into the body)

   Filters the icon directory URI.

3. 3
   apply_filters( icon_dirs )filterline 7106 (+63 into the body)

   Filters the array of icon directory URIs.

4. 4
   apply_filters( wp_mime_type_icon )filterline 7183 (+140 into the body)

   Filters the mime type icon.

Uses · 10

• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• get_post()Retrieves post data given a post ID or post object.
• get_attached_file()Retrieves attached file path based on attachment ID.
• wp_ext2type()Retrieves the file type based on the extension name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• includes_url()Retrieves the URL to the includes directory.
• wp_basename()i18n-friendly version of basename().
• wp_cache_add()Adds data to the cache, if the cache key doesn't already exist.
• wp_match_mime_types()Checks a MIME-Type against a list.

Used by · 5

• WP_Customize_Media_Control::to_json()Refresh the parameters passed to the JavaScript via JSON.
• get_attachment_icon_src()Retrieve icon URL and Path.
• wp_get_attachment_image_src()Retrieves an image to represent an attachment.
• wp_playlist_shortcode()Builds the Playlist shortcode output.
• wp_prepare_attachment_for_js()Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.

Source code

View on Trac ↗View on GitHub ↗

7043function wp_mime_type_icon( $mime = 0, $preferred_ext = '.png' ) {7044	if ( ! is_numeric( $mime ) ) {7045		$icon = wp_cache_get( "mime_type_icon_$mime" );7046	}7047 7048	// Check if preferred file format variable is present and is a validly formatted file extension.7049	if ( ! empty( $preferred_ext ) && is_string( $preferred_ext ) && ! str_starts_with( $preferred_ext, '.' ) ) {7050		$preferred_ext = '.' . strtolower( $preferred_ext );7051	}7052 7053	$post_id = 0;7054	if ( empty( $icon ) ) {7055		$post_mimes = array();7056		if ( is_numeric( $mime ) ) {7057			$mime = (int) $mime;7058			$post = get_post( $mime );7059			if ( $post ) {7060				$post_id = (int) $post->ID;7061				$file    = get_attached_file( $post_id );7062				$ext     = preg_replace( '/^.+?\.([^.]+)$/', '$1', $file );7063				if ( ! empty( $ext ) ) {7064					$post_mimes[] = $ext;7065					$ext_type     = wp_ext2type( $ext );7066					if ( $ext_type ) {7067						$post_mimes[] = $ext_type;7068					}7069				}7070				$mime = $post->post_mime_type;7071			} else {7072				$mime = 0;7073			}7074		} else {7075			$post_mimes[] = $mime;7076		}7077 7078		$icon_files = wp_cache_get( 'icon_files' );7079 7080		if ( ! is_array( $icon_files ) ) {7081			/**7082			 * Filters the icon directory path.7083			 *7084			 * @since 2.0.07085			 *7086			 * @param string $path Icon directory absolute path.7087			 */7088			$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );7089 7090			/**7091			 * Filters the icon directory URI.7092			 *7093			 * @since 2.0.07094			 *7095			 * @param string $uri Icon directory URI.7096			 */7097			$icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url( 'images/media' ) );7098 7099			/**7100			 * Filters the array of icon directory URIs.7101			 *7102			 * @since 2.5.07103			 *7104			 * @param string[] $uris Array of icon directory URIs keyed by directory absolute path.7105			 */7106			$dirs       = apply_filters( 'icon_dirs', array( $icon_dir => $icon_dir_uri ) );7107			$icon_files = array();7108			$all_icons  = array();7109			while ( $dirs ) {7110				$keys = array_keys( $dirs );7111				$dir  = array_shift( $keys );7112				$uri  = array_shift( $dirs );7113				$dh   = opendir( $dir );7114				if ( $dh ) {7115					while ( false !== $file = readdir( $dh ) ) {7116						$file = wp_basename( $file );7117						if ( str_starts_with( $file, '.' ) ) {7118							continue;7119						}7120 7121						$ext = strtolower( substr( $file, -4 ) );7122						if ( ! in_array( $ext, array( '.svg', '.png', '.gif', '.jpg' ), true ) ) {

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.