acf_validate_is_image_attachment() │ ACF 6.8.7

Validates that an attachment is an image for image and gallery fields.

Returns

Array.

Usage

acf_validate_is_image_attachment( $errors, $file, $attachment, $field, $context );

$errors(array) (required)

Existing validation errors.

$file(array) (required)

Normalized file data.

$attachment(array) (required)

Raw attachment data for the current context.

$field(array) (required)

The field array.

$context(string) (required)

The validation context.

Changelog

acf_validate_is_image_attachment() acf validate is image attachment code ^{ACF 6.8.8}

function acf_validate_is_image_attachment( $errors, $file, $attachment, $field, $context ) {
	if ( ! acf_is_image_field( $field ) ) {
		return $errors;
	}

	/**
	 * Filters the error message used when an attachment is not a valid image.
	 *
	 * @since 6.8.7
	 *
	 * @param string $error_message The default error message.
	 * @param array  $field         The field array.
	 * @param string $context       The current context (uploading, preparing, basic_upload).
	 * @param array  $file          An array of data for a single file.
	 * @param array  $attachment    An array of attachment data which differs based on the context.
	 */
	$error_message = apply_filters( 'acf/validate_is_image_attachment/error_message', __( 'File must be a valid image.', 'acf' ), $field, $context, $file, $attachment );

	if ( 'upload' === $context ) {
		return acf_validate_is_image_attachment_upload( $errors, $file, $attachment, $field, $context, $error_message );
	}

	if ( 'prepare' === $context ) {
		return acf_validate_is_image_attachment_prepare( $errors, $file, $attachment, $field, $context, $error_message );
	}

	return acf_validate_is_image_attachment_basic_upload( $errors, $file, $attachment, $field, $context, $error_message );
}