WP_Image_Editor::generate_filename( string $suffix = null, string $dest_path = null, string $extension = null ): string

In this article

Builds an output filename based on current file, and adding proper suffix

Parameters

$suffixstringoptional

Default:null

$dest_pathstringoptional

Default:null

$extensionstringoptional

Default:null

Return

string filename

Source

public function generate_filename( $suffix = null, $dest_path = null, $extension = null ) {	// If not empty the $suffix will be appended to the destination filename, just before the extension.	if ( $suffix ) {	$suffix = '-' . $suffix;	} elseif ( '' !== $suffix ) {	$suffix = '-' . $this->get_suffix();	}	$dir = pathinfo( $this->file, PATHINFO_DIRNAME );	$ext = pathinfo( $this->file, PATHINFO_EXTENSION );	$name = wp_basename( $this->file, ".$ext" );	$new_ext = strtolower( $extension ? $extension : $ext );	if ( ! is_null( $dest_path ) ) {	if ( ! wp_is_stream( $dest_path ) ) {	$_dest_path = realpath( $dest_path );	if ( $_dest_path ) {	$dir = $_dest_path;	}	} else {	$dir = $dest_path;	}	}	return trailingslashit( $dir ) . "{$name}{$suffix}.{$new_ext}"; } 

Changelog

VersionDescription
6.8.0Passing an empty string as $suffix will now omit the suffix from the generated filename.
3.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.