wp_upload_bits( string $name, null|string $deprecated, string $bits, string|null $time = null ): array

Description

Parameters

$namestring

Filename.

$deprecatednull|string

Not used. Set to null.

$bitsstring

File content

$timestring|nulloptional

Time formatted in 'yyyy/mm'. Default null.Default: null

Return

array

Information about the newly-uploaded file.

• $filestring

  Filename of the newly-uploaded file.

• $urlstring

  URL of the uploaded file.

• $typestring

  File type.

• $errorstring|false

  Error message, if there has been an error.

Hooks fired · 2

2 hooks fire while wp_upload_bits() runs, in this order:

1. 1
   apply_filters( wp_upload_bits )filterline 2931 (+30 into the body)

   Filters whether to treat the upload bits as an error.

2. 2
   apply_filters( wp_handle_upload )filterline 2989 (+88 into the body)

   Filters the data array for the uploaded file.

Uses · 12

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• __()Retrieves the translation of $text.
• wp_check_filetype()Retrieves the file type from the file name.
• current_user_can()Returns whether the current user has the specified capability.
• wp_upload_dir()Returns an array containing the current upload directory's path and URL.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_unique_filename()Gets a filename that is sanitized and unique for the given directory.
• wp_mkdir_p()Recursive directory creation based on full path.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_basename()i18n-friendly version of basename().
• is_multisite()Determines whether Multisite is enabled.
• clean_dirsize_cache()Cleans directory size cache used by recurse_dirsize().

Used by · 2

• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
• wp_xmlrpc_server::mw_newMediaObject()Uploads a file, following your settings.

Source

View on Trac ↗View on GitHub ↗

2901function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {2902	if ( ! empty( $deprecated ) ) {2903		_deprecated_argument( __FUNCTION__, '2.0.0' );2904	}2905 2906	if ( empty( $name ) ) {2907		return array( 'error' => __( 'Empty filename' ) );2908	}2909 2910	$wp_filetype = wp_check_filetype( $name );2911	if ( ! $wp_filetype['ext'] && ! current_user_can( 'unfiltered_upload' ) ) {2912		return array( 'error' => __( 'Sorry, you are not allowed to upload this file type.' ) );2913	}2914 2915	$upload = wp_upload_dir( $time );2916 2917	if ( false !== $upload['error'] ) {2918		return $upload;2919	}2920 2921	/**2922	 * Filters whether to treat the upload bits as an error.2923	 *2924	 * Returning a non-array from the filter will effectively short-circuit preparing the upload bits2925	 * and return that value instead. An error message should be returned as a string.2926	 *2927	 * @since 3.0.02928	 *2929	 * @param array|string $upload_bits_error An array of upload bits data, or error message to return.2930	 */2931	$upload_bits_error = apply_filters(2932		'wp_upload_bits',2933		array(2934			'name' => $name,2935			'bits' => $bits,2936			'time' => $time,2937		)2938	);2939	if ( ! is_array( $upload_bits_error ) ) {2940		$upload['error'] = $upload_bits_error;2941		return $upload;2942	}2943 2944	$filename = wp_unique_filename( $upload['path'], $name );2945 2946	$new_file = $upload['path'] . "/$filename";2947	if ( ! wp_mkdir_p( dirname( $new_file ) ) ) {2948		if ( str_starts_with( $upload['basedir'], ABSPATH ) ) {2949			$error_path = str_replace( ABSPATH, '', $upload['basedir'] ) . $upload['subdir'];2950		} else {2951			$error_path = wp_basename( $upload['basedir'] ) . $upload['subdir'];2952		}2953 2954		$message = sprintf(2955			/* translators: %s: Directory path. */2956			__( 'Unable to create directory %s. Is its parent directory writable by the server?' ),2957			$error_path2958		);2959		return array( 'error' => $message );2960	}2961 2962	$ifp = @fopen( $new_file, 'wb' );2963	if ( ! $ifp ) {2964		return array(2965			/* translators: %s: File name. */2966			'error' => sprintf( __( 'Could not write file %s' ), $new_file ),2967		);2968	}2969 2970	fwrite( $ifp, $bits );2971	fclose( $ifp );2972	clearstatcache();2973 2974	// Set correct file permissions.2975	$stat  = @ stat( dirname( $new_file ) );2976	$perms = $stat['mode'] & 0007777;2977	$perms = $perms & 0000666;2978	chmod( $new_file, $perms );2979	clearstatcache();2980

History

Introduced in 2.0.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 7.0.4 tag, from src/wp-includes/functions.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.