Deprecation¶

Note

For information how to handle deprecations in the TYPO3 Core, see the Contribution Guide: How to deprecate classes, methods, arguments and hooks in the TYPO3 core.

Since TYPO3 v4.3, calls to deprecated functions are logged to track usage of deprecated/outdated methods in the TYPO3 Core. Developers have to make sure to adjust their code to avoid using this old functionality since deprecated methods will be removed in future TYPO3 releases.

Introduction¶

Deprecations use the PHP method trigger_error('a message', E_USER_DEPRECATED) and run through the logging and exception stack of the TYPO3 Core. There are several methods that help extension developers in dispatching deprecation errors. In development context deprecations are turned into exceptions by default and ignored in production context.

Therefore calls to deprecated functions within the Core are no longer written to their own log file (typo3conf/deprecation_xxxxxxx.log). The deprecation log related methods have been deprecated themselves.

Hint

Even though calls to functions within the Core are no longer being written to the old deprecation log calls to functions within extensions might still be written to the old deprecation log.

Disabling deprecation errors¶

Deprecation errors are automatically being ignored in production context. If you need to disable them in development context you can do so in the config/system/additional.php:

config/system/additional.php | typo3conf/system/additional.php¶

$GLOBALS['TYPO3_CONF_VARS']['LOG']['TYPO3']['CMS']['deprecations']['writerConfiguration'][\TYPO3\CMS\Core\Log\LogLevel::NOTICE] = [];

Note: Due to how the configuration files are being merged, this disabling can only be done in config/system/additional.php and not in config/system/settings.php.

For more information on how to configure the writing of deprecation logs see Writer configuration.

Finding calls to deprecated functions¶

The extension scanner provides an interactive interface to scan extension code for usage of removed or deprecated TYPO3 Core API. See Extension scanner for more information.

It is also possible to do a file search for "@deprecated" and "E_USER_DEPRECATED". Then using an IDE you can find all calls to the affected functions.

Deprecate functions in extensions¶

Functions that will be removed in future versions of your extension should be marked as deprecated by both the doc-comment and a call to the PHP error method:

EXT:some_extension/Classes/SomeClass.php¶

/**
 * @param array $record
 * @param int $dec
 * @return int
 * @deprecated since version 3.0.4, will be removed in version 4.0.0
 * @codeCoverageIgnore
 */
public function decreaseColPosCountByRecord(array $record, int $dec = 1): int
{
   trigger_error(
      'Method "decreaseColPosCountByRecord" is deprecated since version 3.0.4, will be removed in version 4.0.0',
      E_USER_DEPRECATED
   );
   //[ ...]
}

For more information about how to deprecate classes, arguments and hooks and how the TYPO3 Core handles deprecations, see How to deprecate classes, methods, arguments and hooks in the TYPO3 core.