Skip to content

[HttpFoundation] document Request::getPayload() #18235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions components/http_foundation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,18 @@ If the request body is a JSON string, it can be accessed using

$data = $request->toArray();

If the request data could be ``$_POST`` data *or* a JSON string, you can use
the :method:`Symfony\\Component\\HttpFoundation\\Request::getPayload` method
which returns an instance of :class:`Symfony\\Component\\HttpFoundation\\InputBag`
wrapping this data::

$data = $request->getPayload();

.. versionadded:: 6.3

The :method:`Symfony\\Component\\HttpFoundation\\Request::getPayload`
method was introduced in Symfony 6.3.

Identifying a Request
~~~~~~~~~~~~~~~~~~~~~

Expand Down