public function AttachmentsResponseProcessorInterface::processAttachments in Drupal 10

Same name and namespace in other branches

8 core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php \Drupal\Core\Render\AttachmentsResponseProcessorInterface::processAttachments()
9 core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php \Drupal\Core\Render\AttachmentsResponseProcessorInterface::processAttachments()

Processes the attachments of a response that has attachments.

Libraries, JavaScript settings, feeds, HTML <head> tags, HTML <head> links, HTTP headers, and the HTTP status code are attached to render arrays using the #attached property. The #attached property is an associative array, where the keys are the attachment types and the values are the attached data. For example:

$build['#attached']['library'][] = [
  'library' => [
    'core/jquery',
  ],
];
$build['#attached']['http_header'] = [
  [
    'Content-Type',
    'application/rss+xml; charset=utf-8',
  ],
];

The available keys are:

'library' (asset libraries)
'drupalSettings' (JavaScript settings)
'feed' (RSS feeds)
'html_head' (tags in HTML <head>)
'html_head_link' (<link> tags in HTML <head>)
'http_header' (HTTP headers and status code)

Parameters

\Drupal\Core\Render\AttachmentsInterface $response: The response to process.

Return value

\Drupal\Core\Render\AttachmentsInterface The processed response, with the attachments updated to reflect their final values.

Throws

\InvalidArgumentException Thrown when the $response parameter is not the type of response object the processor expects.

File

core/lib/Drupal/Core/Render/AttachmentsResponseProcessorInterface.php, line 52

Class

AttachmentsResponseProcessorInterface: Defines an interface for processing attachments of responses that have them.

Namespace

Drupal\Core\Render

Code

public function processAttachments(AttachmentsInterface $response);

You are here