wp_tempnam( string $filename = '', string $dir = '' ): string

Returns a filename of a temporary unique file.

Contents

Description

Please note that the calling function must unlink() this itself.

The filename is based off the passed parameter or defaults to the current unix timestamp, while the directory can either be passed as well, or by leaving it blank, default to a writable temporary directory.

Top ↑

Parameters

$filename string Optional
Filename to base the Unique file off.

Default: ''

$dir string Optional
Directory to store the file in.

Default: ''

Top ↑

Return

string A writable filename.

Top ↑

Source

File: wp-admin/includes/file.php. View all references 

function wp_tempnam( $filename = '', $dir = '' ) {
	if ( empty( $dir ) ) {
		$dir = get_temp_dir();
	}

	if ( empty( $filename ) || in_array( $filename, array( '.', '/', '\\' ), true ) ) {
		$filename = uniqid();
	}

	// Use the basename of the given file without the extension as the name for the temporary directory.
	$temp_filename = basename( $filename );
	$temp_filename = preg_replace( '|\.[^.]*$|', '', $temp_filename );

	// If the folder is falsey, use its parent directory name instead.
	if ( ! $temp_filename ) {
		return wp_tempnam( dirname( $filename ), $dir );
	}

	// Suffix some random data to avoid filename conflicts.
	$temp_filename .= '-' . wp_generate_password( 6, false );
	$temp_filename .= '.tmp';
	$temp_filename  = $dir . wp_unique_filename( $dir, $temp_filename );

	$fp = @fopen( $temp_filename, 'x' );

	if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
		return wp_tempnam( $filename, $dir );
	}

	if ( $fp ) {
		fclose( $fp );
	}

	return $temp_filename;
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_tempnam() wp-admin/includes/file.php

Returns a filename of a temporary unique file.
wp_generate_password() wp-includes/pluggable.php

Generates a random password drawn from the defined set of characters.
get_temp_dir() wp-includes/functions.php

Determines a writable directory for temporary files.
wp_unique_filename() wp-includes/functions.php

Gets a filename that is sanitized and unique for the given directory.

Top ↑

Used By

Used By
Used By Description
WP_Customize_Manager::import_theme_starter_content() wp-includes/class-wp-customize-manager.php

Imports theme starter content into the customized state.
WP_REST_Attachments_Controller::upload_from_data() wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Handles an upload via raw POST data.
WP_Filesystem_FTPext::get_contents() wp-admin/includes/class-wp-filesystem-ftpext.php

Reads entire file into a string.
WP_Filesystem_FTPext::put_contents() wp-admin/includes/class-wp-filesystem-ftpext.php

Writes a string to a file.
WP_Filesystem_ftpsockets::get_contents() wp-admin/includes/class-wp-filesystem-ftpsockets.php

Reads entire file into a string.
WP_Filesystem_ftpsockets::put_contents() wp-admin/includes/class-wp-filesystem-ftpsockets.php

Writes a string to a file.
wp_tempnam() wp-admin/includes/file.php

Returns a filename of a temporary unique file.
download_url() wp-admin/includes/file.php

Downloads a URL to a local temporary file using the WordPress HTTP API.
Show 3 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Nabil —

    Keep in mind that (1) the function doens’t delete the file and that (2) you can’t use extensions, but you can use my function which supports extensions and deletes files at the end of the script execution:

    Examples:

    // Basic
$filename = 'hello.txt';
$content = 'Hello World!';
$file = wporg_k_tempnam( $file, $content );

// Better - salt in the file name 
$filename = 'hello-' . wp_generate_password( 5, false ) . '.txt';
$content = 'Hello World!';
$file = wporg_k_tempnam( $file, $content );

    The function:

    /**
 * Create temporary file in system temporary directory.
 *
 * @author Nabil Kadimi - https://kadimi.com
 *
 * @param  string $name    File name.
 * @param  string $content File contents.
 * @return string File path.
 */
function wporg_k_tempnam( $name, $content ) {
	$sep = DIRECTORY_SEPARATOR;
	$file = $sep . trim( sys_get_temp_dir(), $sep ) . $sep . ltrim( $name, $sep );
	file_put_contents( $file, $content );
	register_shutdown_function( function() use( $file ) {
		@unlink( $file );
	} );
	return $file;
}

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