Verified Commit fb00dc7d authored by quietone's avatar quietone
Browse files

Issue #3489776 by mstrelan, nicxvan: Add void return to all pageAttachments,... 

Issue #3489776 by mstrelan, nicxvan: Add void return to all pageAttachments, pageTop and pageBottom hook implementations

(cherry picked from commit 9c747cd0)
parent e01542fd

core/.phpstan-baseline.php

+0 −120
Original line number Diff line number Diff line
@@ -11530,12 +11530,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/big_pipe/src/Hook/BigPipeHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\big_pipe\\\\Hook\\\\BigPipeHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/big_pipe/src/Hook/BigPipeHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\big_pipe\\\\Render\\\\BigPipe\\:\\:performPostSendTasks\\(\\) has no return type specified\\.$#',
@@ -11644,12 +11638,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/big_pipe/tests/modules/big_pipe_test/src/Form/BigPipeTestForm.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\big_pipe_test\\\\Hook\\\\BigPipeTestHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/big_pipe/tests/modules/big_pipe_test/src/Hook/BigPipeTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\Tests\\\\big_pipe\\\\Unit\\\\Render\\\\BigPipeResponseAttachmentsProcessorTest\\:\\:attachmentsProvider\\(\\) has no return type specified\\.$#',
@@ -11836,12 +11824,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/block/src/Hook/BlockHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\block\\\\Hook\\\\BlockHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/block/src/Hook/BlockHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\block\\\\Hook\\\\BlockHooks\\:\\:rebuild\\(\\) has no return type specified\\.$#',
@@ -16774,12 +16756,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/content_translation/src/Hook/ContentTranslationHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\content_translation\\\\Hook\\\\ContentTranslationHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/content_translation/src/Hook/ContentTranslationHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\content_translation\\\\Plugin\\\\Validation\\\\Constraint\\\\ContentTranslationSynchronizedFieldsConstraintValidator\\:\\:create\\(\\) has no return type specified\\.$#',
@@ -17122,12 +17098,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/contextual/src/Hook/ContextualHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\contextual\\\\Hook\\\\ContextualHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/contextual/src/Hook/ContextualHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\contextual\\\\Hook\\\\ContextualHooks\\:\\:toolbar\\(\\) has no return type specified\\.$#',
@@ -23434,12 +23404,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/language/tests/language_test/src/Hook/LanguageTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\language_test\\\\Hook\\\\LanguageTestHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/language/tests/language_test/src/Hook/LanguageTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\Tests\\\\language\\\\Functional\\\\ConfigurableLanguageManagerTest\\:\\:setWaitForTerminate\\(\\) has no return type specified\\.$#',
@@ -30114,12 +30078,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/navigation/src/Hook/NavigationHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\navigation\\\\Hook\\\\NavigationHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/navigation/src/Hook/NavigationHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\navigation\\\\NavigationContentLinks\\:\\:create\\(\\) has no return type specified\\.$#',
@@ -30492,12 +30450,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/node/src/Hook/NodeHooks1.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\node\\\\Hook\\\\NodeHooks1\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/node/src/Hook/NodeHooks1.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\node\\\\Hook\\\\NodeHooks1\\:\\:ranking\\(\\) has no return type specified\\.$#',
@@ -34176,12 +34128,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/settings_tray/tests/modules/settings_tray_test/src/Plugin/Block/ValidationErrorBlock.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\settings_tray_test_css\\\\Hook\\\\SettingsTrayTestCssHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/settings_tray/tests/modules/settings_tray_test_css/src/Hook/SettingsTrayTestCssHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\Tests\\\\settings_tray\\\\FunctionalJavascript\\\\SettingsTrayBlockFormTest\\:\\:getBlockTests\\(\\) has no return type specified\\.$#',
@@ -35388,12 +35334,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/src/Hook/SystemHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\system\\\\Hook\\\\SystemHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/src/Hook/SystemHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\system\\\\Hook\\\\SystemHooks\\:\\:updaterInfo\\(\\) has no return type specified\\.$#',
@@ -36306,12 +36246,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/common_test/src/Hook/CommonTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\common_test\\\\Hook\\\\CommonTestHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/common_test/src/Hook/CommonTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\condition_test\\\\FormController\\:\\:submitForm\\(\\) has no return type specified\\.$#',
@@ -36390,12 +36324,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestSuspendQueue.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\css_disable_transitions_test\\\\Hook\\\\CssDisableTransitionsTestHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/css_disable_transitions_test/src/Hook/CssDisableTransitionsTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\database_test\\\\Form\\\\DatabaseTestForm\\:\\:submitForm\\(\\) has no return type specified\\.$#',
@@ -38840,18 +38768,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\js_testing_ajax_request_test\\\\Hook\\\\JsTestingAjaxRequestTestHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/js_testing_ajax_request_test/src/Hook/JsTestingAjaxRequestTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\js_testing_log_test\\\\Hook\\\\JsTestingLogTestHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/js_testing_log_test/src/Hook/JsTestingLogTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\jswebassert_test\\\\Controller\\\\TestController\\:\\:page\\(\\) has no return type specified\\.$#',
@@ -39060,12 +38976,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/new_dependency_test/src/SetterInjection.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\off_canvas_test\\\\Hook\\\\OffCanvasTestHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/off_canvas_test/src/Hook/OffCanvasTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\pager_test\\\\Controller\\\\PagerTestController\\:\\:multiplePagers\\(\\) has no return type specified\\.$#',
@@ -39555,12 +39465,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/services_defaults_test/src/TestService.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\session_exists_cache_context_test\\\\Hook\\\\SessionExistsCacheContextTestHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/session_exists_cache_context_test/src/Hook/SessionExistsCacheContextTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\session_test\\\\Controller\\\\SessionTestController\\:\\:triggerWriteException\\(\\) has no return type specified\\.$#',
@@ -39723,12 +39627,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/system_test/src/Hook/SystemTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\system_test\\\\Hook\\\\SystemTestHooks\\:\\:pageAttachments\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/system_test/src/Hook/SystemTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\system_test\\\\MockFileTransfer\\:\\:getSettingsForm\\(\\) has no return type specified\\.$#',
@@ -39837,12 +39735,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/theme_test/src/EventSubscriber/ThemeTestSubscriber.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\theme_test\\\\Hook\\\\ThemeTestHooks\\:\\:pageBottom\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/system/tests/modules/theme_test/src/Hook/ThemeTestHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\theme_test\\\\ThemeTestController\\:\\:generalSuggestionAlter\\(\\) has no return type specified\\.$#',
@@ -43317,12 +43209,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/toolbar/src/Hook/ToolbarHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\toolbar\\\\Hook\\\\ToolbarHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/toolbar/src/Hook/ToolbarHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\toolbar\\\\Hook\\\\ToolbarHooks\\:\\:toolbar\\(\\) has no return type specified\\.$#',
@@ -43437,12 +43323,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/update/src/Hook/UpdateHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\update\\\\Hook\\\\UpdateHooks\\:\\:pageTop\\(\\) has no return type specified\\.$#',

	'count' => 1,

	'path' => __DIR__ . '/modules/update/src/Hook/UpdateHooks.php',

];

$ignoreErrors[] = [

	// identifier: missingType.return

	'message' => '#^Method Drupal\\\\update\\\\Hook\\\\UpdateHooks\\:\\:themesInstalled\\(\\) has no return type specified\\.$#',

core/lib/Drupal/Core/Render/theme.api.php

+4 −4
Original line number Diff line number Diff line
@@ -1093,7 +1093,7 @@ function hook_css_alter(&$css, \Drupal\Core\Asset\AttachedAssetsInterface $asset 
 *

 * @see hook_page_attachments_alter()

 */

function hook_page_attachments(array &$attachments) {

function hook_page_attachments(array &$attachments): void {

  // Unconditionally attach an asset to the page.

  $attachments['#attached']['library'][] = 'core/drupalSettings';
@@ -1119,7 +1119,7 @@ function hook_page_attachments(array &$attachments) { 
 *

 * @see hook_page_attachments()

 */

function hook_page_attachments_alter(array &$attachments) {

function hook_page_attachments_alter(array &$attachments): void {

  // Conditionally remove an asset.

  if (in_array('core/jquery', $attachments['#attached']['library'])) {

    $index = array_search('core/jquery', $attachments['#attached']['library']);
@@ -1133,7 +1133,7 @@ function hook_page_attachments_alter(array &$attachments) { 
 * @param array $page_top

 *   A renderable array representing the top of the page.

 */

function hook_page_top(array &$page_top) {

function hook_page_top(array &$page_top): void {

  $page_top['my_module'] = ['#markup' => 'This is the top.'];

}
@@ -1143,7 +1143,7 @@ function hook_page_top(array &$page_top) { 
 * @param array $page_bottom

 *   A renderable array representing the bottom of the page.

 */

function hook_page_bottom(array &$page_bottom) {

function hook_page_bottom(array &$page_bottom): void {

  $page_bottom['my_module'] = ['#markup' => 'This is the bottom.'];

}

core/modules/big_pipe/src/Hook/BigPipeHooks.php

+1 −1
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ public function help($route_name, RouteMatchInterface $route_match) { 
   * @see \Drupal\big_pipe\Controller\BigPipeController::setNoJsCookie()

   */

  #[Hook('page_attachments')]

  public function pageAttachments(array &$page) {

  public function pageAttachments(array &$page): void {

    // Routes that don't use BigPipe also don't need no-JS detection.

    if (\Drupal::routeMatch()->getRouteObject()->getOption('_no_big_pipe')) {

      return;

core/modules/big_pipe/tests/modules/big_pipe_test/src/Hook/BigPipeTestHooks.php

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ class BigPipeTestHooks { 
   * Implements hook_page_top().

   */

  #[Hook('page_top')]

  public function pageTop(array &$page_top) {

  public function pageTop(array &$page_top): void {

    // Ensure this hook is invoked on every page load.

    $page_top['#cache']['max-age'] = 0;

    $request = \Drupal::request();

core/modules/block/src/Hook/BlockHooks.php

+1 −1
Original line number Diff line number Diff line
@@ -65,7 +65,7 @@ public function theme() : array { 
   * Implements hook_page_top().

   */

  #[Hook('page_top')]

  public function pageTop(array &$page_top) {

  public function pageTop(array &$page_top): void {

    if (\Drupal::routeMatch()->getRouteName() === 'block.admin_demo') {

      $theme = \Drupal::theme()->getActiveTheme()->getName();

      $page_top['backlink'] = [