core/includes/errors.inc

@@ -55,7 +55,24 @@ function drupal_error_levels(): array {
  *   The line number the error was raised at.
  */
 function _drupal_error_handler_real($error_level, $message, $filename, $line): void {
-  if ($error_level & error_reporting()) {
+  if (($error_level & error_reporting()) || ($error_level === E_USER_DEPRECATED && _drupal_get_deprecation_setting('log_deprecations', FALSE))) {
+    // Filter out deprecations depending on the deprecation settings.
+    $channel = 'php';
+    if ($error_level === E_USER_DEPRECATED) {
+      $ignored_file_patterns = _drupal_get_deprecation_setting('deprecations_ignored_file_patterns', []);
+      foreach ($ignored_file_patterns as $pattern) {
+        if (preg_match($pattern, $filename) === 1) {
+          return;
+        }
+      }
+
+      $ignored_deprecations = _drupal_get_deprecation_setting('ignored_deprecations', []);
+      if (in_array($message, $ignored_deprecations, TRUE)) {
+        return;
+      }
+      $channel = 'deprecation';
+    }
+
     $types = drupal_error_levels();
     [$severity_msg, $severity_level] = $types[$error_level];
     $backtrace = debug_backtrace();
@@ -79,7 +96,7 @@ function _drupal_error_handler_real($error_level, $message, $filename, $line): v
       'backtrace' => $backtrace,
       '@backtrace_string' => (new \Exception())->getTraceAsString(),
       'exception' => NULL,
-    ], $recoverable || $to_string);
+    ], $recoverable || $to_string, $channel);
   }
   // If the site is a test site then fail for user deprecations so they can be
   // caught by the deprecation error handler.
@@ -144,8 +161,10 @@ function error_displayable($error = NULL) {
  *   - An exception is thrown and not caught by something else.
  *   - A recoverable fatal error, which is a fatal error.
  *   Non-recoverable fatal errors cannot be logged by Drupal.
+ * @param string $channel
+ *   The logger channel to use.
  */
-function _drupal_log_error($error, $fatal = FALSE): void {
+function _drupal_log_error($error, $fatal = FALSE, $channel = 'php') : void {
   $is_installer = InstallerKernel::installationAttempted() && \Drupal::hasContainer();
 
   // Backtrace, exception and 'severity_level' are not valid replacement values
@@ -171,7 +190,7 @@ function _drupal_log_error($error, $fatal = FALSE): void {
       // Provide the PHP backtrace and exception to logger implementations. Add
       // 'severity_level' to the context to maintain BC and allow logging
       // implementations to use it.
-      \Drupal::logger('php')->log($severity, '%type: @message in %function (line %line of %file) @backtrace_string.', $error + ['backtrace' => $backtrace, 'exception' => $exception, 'severity_level' => $severity]);
+      \Drupal::logger($channel)->log($severity, '%type: @message in %function (line %line of %file) @backtrace_string.', $error + ['backtrace' => $backtrace, 'exception' => $exception, 'severity_level' => $severity]);
     }
     catch (\Throwable) {
       // We can't log, for example because the database connection is not
@@ -339,6 +358,28 @@ function _drupal_get_error_level() {
   return $error_level ?: ERROR_REPORTING_DISPLAY_ALL;
 }
 
+/**
+ * Gets a deprecation logging settings.
+ *
+ * @param string $setting
+ *   The setting to get.
+ * @param mixed $default
+ *   The default value.
+ *
+ * @return mixed
+ *   The configuration value.
+ */
+function _drupal_get_deprecation_setting(string $setting, $default): mixed {
+  try {
+    $value = \Drupal::config('system.logging')->get($setting);
+  }
+  catch (\Exception) {
+    $value = $GLOBALS['config']['system.logging'][$setting] ?? $default;
+  }
+
+  return $value;
+}
+
 /**
  * Adds error information to headers so that tests can access it.
  *

core/modules/system/config/install/system.logging.yml

 error_level: hide
+log_deprecations: false
+deprecations_ignored_file_patterns:
+  - /vendor/
+  - /core/
+ignored_deprecations: { }

core/modules/system/config/schema/system.schema.yml

@@ -185,6 +185,21 @@ system.logging:
             - 'some'
             - 'all'
             - 'verbose'
+    log_deprecations:
+      type: boolean
+      label: 'Should deprecations be logged'
+    deprecations_ignored_file_patterns:
+      type: sequence
+      label: 'List of ignored deprecation source file patterns'
+      sequence:
+        type: string
+        label: 'Ignored deprecation source file pattern'
+    ignored_deprecations:
+      type: sequence
+      label: 'List of ignored deprecations'
+      sequence:
+        type: string
+        label: 'Ignored deprecation'
 
 system.performance:
   type: config_object

core/modules/system/src/Form/LoggingForm.php

@@ -3,6 +3,7 @@
 namespace Drupal\system\Form;
 
 use Drupal\Core\Form\ConfigFormBase;
+use Drupal\Core\Form\ConfigTarget;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Form\RedundantEditableConfigNamesTrait;
 
@@ -38,7 +39,72 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#description' => $this->t('It is recommended that sites running on production environments do not display any errors.'),
     ];
 
+    $form['log_deprecations'] = [
+      '#type' => 'checkbox',
+      '#title' => $this->t('Log deprecation messages'),
+      '#config_target' => 'system.logging:log_deprecations',
+      '#description' => $this->t('It is recommended that sites running on production environments do not log deprecations.'),
+    ];
+
+    $form['deprecations_ignored_file_patterns'] = [
+      '#type' => 'textarea',
+      '#title' => $this->t('Ignored deprecation source file patterns'),
+      '#config_target' => new ConfigTarget(
+        'system.logging',
+        'deprecations_ignored_file_patterns',
+        static::class . '::arrayToMultiLineString',
+        static::class . '::multiLineStringToArray'),
+      '#description' => $this->t('List of source file patterns from which deprecations should be ignored, one per line. Regex allowed.'),
+      '#states' => [
+        'visible' => [
+          ':input[name="log_deprecations"]' => ['checked' => TRUE],
+        ],
+      ],
+      '#rows' => 3,
+    ];
+    $form['ignored_deprecations'] = [
+      '#type' => 'textarea',
+      '#title' => $this->t('Ignored deprecation messages'),
+      '#config_target' => new ConfigTarget(
+        'system.logging',
+        'ignored_deprecations',
+        static::class . '::arrayToMultiLineString',
+        static::class . '::multiLineStringToArray'),
+      '#description' => $this->t('List of ignored deprecation messages, one per line'),
+      '#states' => [
+        'visible' => [
+          ':input[name="log_deprecations"]' => ['checked' => TRUE],
+        ],
+      ],
+    ];
+
     return parent::buildForm($form, $form_state);
   }
 
+  /**
+   * Prepares the submitted value to be stored as an array.
+   *
+   * @param string $value
+   *   The submitted value.
+   *
+   * @return array
+   *   The value to be stored in config.
+   */
+  public static function multiLineStringToArray(string $value): array {
+    return array_map('trim', explode("\n", trim($value)));
+  }
+
+  /**
+   * Prepares the stored array to be displayed in the form.
+   *
+   * @param array $value
+   *   The value saved in config.
+   *
+   * @return string
+   *   The value of the form element.
+   */
+  public static function arrayToMultiLineString(array $value): string {
+    return implode("\n", $value);
+  }
+
 }

core/modules/system/system.install

@@ -1799,3 +1799,14 @@ function system_update_11201(): void {
     $schema->addIndex('router', 'alias', ['alias'], $spec);
   }
 }
+
+/**
+ * Set default values for new deprecation logging variables.
+ */
+function system_update_11202(&$sandbox): void {
+  $config = \Drupal::configFactory()->getEditable('system.logging');
+  $config->set('log_deprecations', FALSE);
+  $config->set('deprecations_ignored_file_patterns', ['*/vendor/*', '*/core/*']);
+  $config->set('ignored_deprecations', []);
+  $config->save();
+}

core/modules/system/tests/modules/error_test/error_test.routing.yml

@@ -40,3 +40,10 @@ error_test.trigger_renderer_exception:
     _controller: '\Drupal\error_test\Controller\ErrorTestController::triggerRendererException'
   requirements:
     _access: 'TRUE'
+
+error_test.trigger_deprecation:
+  path: '/error-test/trigger-deprecation'
+  defaults:
+    _controller: '\Drupal\error_test\Controller\ErrorTestController::triggerDeprecation'
+  requirements:
+    _access: 'TRUE'

core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php

@@ -108,4 +108,14 @@ function () {
     ];
   }
 
+  /**
+   * Trigger a deprecation warning.
+   */
+  public function triggerDeprecation(): array {
+    // This will generate a deprecation message. Use to check logging.
+    // phpcs:ignore Drupal.Semantics.FunctionTriggerError
+    trigger_error("Foo is deprecated.", E_USER_DEPRECATED);
+    return [];
+  }
+
 }

core/modules/system/tests/src/Functional/System/ErrorHandlerTest.php

@@ -5,6 +5,7 @@
 namespace Drupal\Tests\system\Functional\System;
 
 use Drupal\Component\Render\FormattableMarkup;
+use Drupal\Core\Database\Database;
 use Drupal\Tests\BrowserTestBase;
 
 /**
@@ -17,7 +18,7 @@ class ErrorHandlerTest extends BrowserTestBase {
   /**
    * {@inheritdoc}
    */
-  protected static $modules = ['error_test'];
+  protected static $modules = ['dblog', 'error_test'];
 
   /**
    * {@inheritdoc}
@@ -26,6 +27,11 @@ class ErrorHandlerTest extends BrowserTestBase {
 
   /**
    * Tests the error handler.
+   *
+   * Since this tests the logging of deprecation messages, it is in the 'legacy'
+   * group.
+   *
+   * @group legacy
    */
   public function testErrorHandler(): void {
     $config = $this->config('system.logging');
@@ -90,6 +96,55 @@ public function testErrorHandler(): void {
     $this->assertNoErrorMessage($error_user_notice);
     $this->assertNoMessages();
     $this->assertSession()->responseNotContains('<pre class="backtrace">');
+
+    // Login as a user with access to the logging and errors page.
+    $this->drupalLogin($this->drupalCreateUser([
+      'administer site configuration',
+      'access administration pages',
+      'access site reports',
+      'administer users',
+    ]));
+
+    // Test the default of no logging.
+    $this->drupalGet('error-test/trigger-deprecation');
+    $this->assertLogCount('0');
+
+    // Enable logging. The default ignored file patterns are '/vendor/' and
+    // '/core'/ so there should be no logged messages.
+    $this->drupalGet('/admin/config/development/logging');
+    $edits = [
+      'log_deprecations' => TRUE,
+    ];
+    $this->submitForm($edits, 'Save configuration');
+    $this->drupalGet('error-test/trigger-deprecation');
+    $this->assertLogCount('0');
+
+    // Allow logging of messages from the 'core' file path.
+    $this->drupalGet('/admin/config/development/logging');
+    $edits = [
+      'log_deprecations' => TRUE,
+      'deprecations_ignored_file_patterns' => '/vendor/',
+    ];
+    $this->submitForm($edits, 'Save configuration');
+    $this->resetAll();
+
+    // There should now be one logged message.
+    $this->drupalGet('error-test/trigger-deprecation');
+    $this->assertLogCount('1');
+
+    // Test ignoring a deprecation message.
+    $this->drupalGet('/admin/config/development/logging');
+    $edits = [
+      'log_deprecations' => TRUE,
+      'deprecations_ignored_file_patterns' => '/vendor/',
+      'ignored_deprecations' => 'Foo is deprecated.',
+    ];
+    $this->submitForm($edits, 'Save configuration');
+    $this->resetAll();
+
+    // The message should not be logged again. The count remains at 1.
+    $this->drupalGet('error-test/trigger-deprecation');
+    $this->assertLogCount('1');
   }
 
   /**
@@ -211,4 +266,21 @@ protected function assertNoMessages(): void {
     $this->assertSession()->elementNotExists('xpath', '//div[contains(@class, "messages")]');
   }
 
+  /**
+   * Asserts the number of 'deprecation' type messaged logged.
+   *
+   * @param string $expected_count
+   *   The expected number of deprecation messages.
+   *
+   * @internal
+   */
+  protected function assertLogCount(string $expected_count): void {
+    $count = Database::getConnection()->select('watchdog')
+      ->condition('type', 'deprecation')
+      ->countQuery()
+      ->execute()
+      ->fetchField();
+    $this->assertSame($expected_count, $count);
+  }
+
 }

core/modules/system/tests/src/Kernel/Migrate/d6/MigrateSystemConfigurationTest.php

@@ -65,6 +65,12 @@ class MigrateSystemConfigurationTest extends MigrateDrupal6TestBase {
     ],
     'system.logging' => [
       'error_level' => 'some',
+      'log_deprecations' => FALSE,
+      'deprecations_ignored_file_patterns' => [
+        0 => '/vendor/',
+        1 => '/core/',
+      ],
+      'ignored_deprecations' => [],
     ],
     'system.maintenance' => [
       // Langcode is not handled by the migration.

core/modules/system/tests/src/Kernel/Migrate/d7/MigrateSystemConfigurationTest.php

@@ -64,6 +64,12 @@ class MigrateSystemConfigurationTest extends MigrateDrupal7TestBase {
     ],
     'system.logging' => [
       'error_level' => 'some',
+      'log_deprecations' => FALSE,
+      'deprecations_ignored_file_patterns' => [
+        0 => '/vendor/',
+        1 => '/core/',
+      ],
+      'ignored_deprecations' => [],
     ],
     'system.mail' => [
       'interface' => [

core/tests/Drupal/KernelTests/Core/Routing/ExceptionHandlingTest.php

@@ -28,6 +28,7 @@ class ExceptionHandlingTest extends KernelTestBase {
   protected function setUp(): void {
     parent::setUp();
 
+    $this->installConfig('system');
     $this->installEntitySchema('date_format');
   }