#8458 getViewModel() results in null

[chrisfwd]

Purpose of this pull request

This pull request (PR) fixes documentation about viewmodels that explains to use name="viewModel" in layout.xml and tries to retrieve that viewmodel in the template via $block->getViewModel()

Affected DevDocs pages

https://devdocs.magento.com/guides/v2.4/extension-dev-guide/view-models.html
https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/xml-instructions.html
https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/xml-manage.html

• ...

Fixes #8458

[magento-engcom-team]

@chrisfwd thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

[mrtuvn]

In my point of view this is preference choice. But default magento used argument viewModel instead view_model. Both way should work
Here is example code magento recommend
https://github.com/magento/magento2/blob/2.4-develop/lib/internal/Magento/Framework/View/Element/Template.php#L24
In some case if use $block->getViewModel() maybe get null at variable
CC: @dmytro-ch can you clarify reason of use view_model instead origin viewModel. I see in frontend somewhere use both approach but in backend use view_model. This may lead to inconsistency and make more noise/confusing to dev experience

[dmytro-ch]

In my opinion, the view_model key is the correct one. Since the original idea was to retrieve the view model with the corresponding magic method and conventionally reserve this method name:

$viewModel = $block->getViewModel();

OR using getter in a conventional way, with snake case:

$viewModel = $block->get('view_model');

While the following approach is confusing and seems to be caused by a typo in documentation.

$viewModel = $block->get('viewModel');

I would prefer to fix this doc block accordingly:
https://github.com/magento/magento2/blob/2.4-develop/lib/internal/Magento/Framework/View/Element/Template.php#L24

[dobooth]

running tests

[ghost]

Hi @chrisfwd, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.