Functions file_create_url() and file_url_transform_relative() are deprecated

By nickolaj on 9 July 2021

Change record status:

Published (View all published change records)

Project:

Drupal core

Introduced in branch:

9.3.x

Introduced in version:

9.3.0

Issue links:

https://www.drupal.org/node/2669074

https://www.drupal.org/node/2940025

Description:

Functions file_create_url() and file_url_transform_relative() are deprecated.

Instead, get file_url_generatorservice injected into your service or controller from the container and call its methods.

Before	After
`file_create_url($uri)`	`\Drupal::service('file_url_generator')->generateAbsoluteString($uri)`
`file_url_transform_relative($file_url)`	`\Drupal::service('file_url_generator')->transformRelative($file_url)`
`file_url_transform_relative(file_create_url($uri)`	`\Drupal::service('file_url_generator')->generateString($uri)`
`Drupal\Core\Url::fromUri(file_create_url($uri))`	`\Drupal::service('file_url_generator')->generate($uri)`

The new service 'file_url_generator' is providing the following new methods:

The method generateString() which creates a root-relative web-accessible URL string;
The method generateAbsoluteString() which creates an absolute web-accessible URL string;
The method generate() which creates a root-relative web-accessible URL object;
The method transformRelative() which transforms an absolute URL of a local file to a relative URL.

In addition, Drupal\Core\Asset\CssOptimizer (this is providing the 'asset.css.optimizer' service), Drupal\Core\Asset\JsCollectionRenderer (that is providing the 'asset.js.collection_renderer' service) and Drupal\Core\Asset\CssCollectionRenderer (that is providing the 'asset.css.collection_renderer' service) are now taking the FileUrlGeneratorInterface constructor as an argument.

Impacts:

Module developers

Distribution developers

Updates Done (doc team, etc.)

Online documentation:

Not done

Theming guide:

Not done

Module developer documentation:

Not done

Examples project:

Not done