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

Parameters

$mimestring|intoptional

MIME type or attachment ID.Default: 0

$preferred_extstringoptional

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

Return

string|false

Icon, false otherwise.

Hooks fired · 4

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

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

   Filters the icon directory path.

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

   Filters the icon directory URI.

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

   Filters the array of icon directory URIs.

4. 4
   apply_filters( wp_mime_type_icon )filterline 7324 (+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

View on Trac ↗View on GitHub ↗

7184function wp_mime_type_icon( $mime = 0, $preferred_ext = '.png' ) {7185	if ( ! is_numeric( $mime ) ) {7186		$icon = wp_cache_get( "mime_type_icon_$mime" );7187	}7188 7189	// Check if preferred file format variable is present and is a validly formatted file extension.7190	if ( ! empty( $preferred_ext ) && is_string( $preferred_ext ) && ! str_starts_with( $preferred_ext, '.' ) ) {7191		$preferred_ext = '.' . strtolower( $preferred_ext );7192	}7193 7194	$post_id = 0;7195	if ( empty( $icon ) ) {7196		$post_mimes = array();7197		if ( is_numeric( $mime ) ) {7198			$mime = (int) $mime;7199			$post = get_post( $mime );7200			if ( $post ) {7201				$post_id = (int) $post->ID;7202				$file    = get_attached_file( $post_id );7203				$ext     = preg_replace( '/^.+?\.([^.]+)$/', '$1', $file );7204				if ( ! empty( $ext ) ) {7205					$post_mimes[] = $ext;7206					$ext_type     = wp_ext2type( $ext );7207					if ( $ext_type ) {7208						$post_mimes[] = $ext_type;7209					}7210				}7211				$mime = $post->post_mime_type;7212			} else {7213				$mime = 0;7214			}7215		} else {7216			$post_mimes[] = $mime;7217		}7218 7219		$icon_files = wp_cache_get( 'icon_files' );7220 7221		if ( ! is_array( $icon_files ) ) {7222			/**7223			 * Filters the icon directory path.7224			 *7225			 * @since 2.0.07226			 *7227			 * @param string $path Icon directory absolute path.7228			 */7229			$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );7230 7231			/**7232			 * Filters the icon directory URI.7233			 *7234			 * @since 2.0.07235			 *7236			 * @param string $uri Icon directory URI.7237			 */7238			$icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url( 'images/media' ) );7239 7240			/**7241			 * Filters the array of icon directory URIs.7242			 *7243			 * @since 2.5.07244			 *7245			 * @param string[] $uris Array of icon directory URIs keyed by directory absolute path.7246			 */7247			$dirs       = apply_filters( 'icon_dirs', array( $icon_dir => $icon_dir_uri ) );7248			$icon_files = array();7249			$all_icons  = array();7250			while ( $dirs ) {7251				$keys = array_keys( $dirs );7252				$dir  = array_shift( $keys );7253				$uri  = array_shift( $dirs );7254				$dh   = opendir( $dir );7255				if ( $dh ) {7256					while ( false !== $file = readdir( $dh ) ) {7257						$file = wp_basename( $file );7258						if ( str_starts_with( $file, '.' ) ) {7259							continue;7260						}7261 7262						$ext = strtolower( substr( $file, -4 ) );7263						if ( ! in_array( $ext, array( '.svg', '.png', '.gif', '.jpg' ), true ) ) {

History

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.9.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.