The node views argument default expects node parameter, node_preview provided when previewing nodes

Created on 5 February 2018, about 7 years ago

Updated 3 February 2023, about 2 years ago

Problem/Motivation

When previewing nodes that use a Views Reference Field → with a view that includes a node contextual filter configured to use the default argument using the content id from the URL, the view does not render any results as expected and seen when rendering the node.

The node views argument default expects the node parameter, as seen here.

\Drupal\node\Plugin\views\argument_default\Node::getArgument()

  public function getArgument() {
    if (($node = $this->routeMatch->getParameter('node')) && $node instanceof NodeInterface) {
      return $node->id();
    }
  }

However, the entity.node.preview route provides the node_preview parameter, which is upcasted to the node entity via the Drupal\node\ParamConverter\NodePreviewConverter()

See line 31 of node.routing.yml

entity.node.preview:
  path: '/node/preview/{node_preview}/{view_mode_id}'
  defaults:
    _controller: '\Drupal\node\Controller\NodePreviewController::view'
    _title_callback: '\Drupal\node\Controller\NodePreviewController::title'
  requirements:
    _node_preview_access: '{node_preview}'
  options:
    parameters:
      node_preview:
        type: 'node_preview'

Proposed resolution

Can we simply convert the parameter name in entity.node.preview from node_preview to node?

Remaining tasks

Patch, tests, ?

User interface changes

None

API changes

Unsure

Data model changes

None

🐛 Bug report

Status

Needs work

Version

9.5

Component

Node system →

Last updated about 3 hours ago

No maintainer

Created by

🇺🇸United States jasonawant New Orleans, USA

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Needs Review Queue Initiative
Used to track the progress of issues reviewed by the Drupal Needs Review Queue Initiative.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment about 2 years ago →
🇺🇸United States smustgrave
Was previous tagged for tests in #6 which still needs to happen

Thanks.
Comment 7 months ago →
riyas_nr
This patch addresses an additional scenario where adding a block with a View reference field containing a contextual filter in Layout Builder results in the preview displaying 'Placeholder for the name Views block.'
Comment 25 days ago →
🇦🇺Australia acbramley
Can we simply convert the parameter name in entity.node.preview from node_preview to node?

I think this should definitely be explored. I have no background on why it's the way it is but it seems like changing the parameter name could be a better way forward and reduce some other code duplication we have (e.g in template_preprocess_page). This would however be quite disruptive for BC purposes.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024