Skip to content

[Serializer] Add an option to skip null values #10427

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.

Sign up for GitHub

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
Oct 3, 2018
Merged

[Serializer] Add an option to skip null values #10427

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,6 +754,25 @@ This encoder requires the :doc:`Yaml Component </components/yaml>` and
transforms from and to Yaml.


Skipping ``null`` Values
------------------------

By default, the Serializer will preserve properties containing a ``null`` value.
You can change this behavior by setting the ``skip_null_values`` context option
to ``true``::

$dummy = new class {
public $foo;
public $bar = 'notNull';
};

$normalizer = new ObjectNormalizer();
$result = $normalizer->normalize($dummy, 'json', ['skip_null_values' => true]);
// ['bar' => 'notNull']

.. versionadded:: 4.2
The ``skip_null_values`` option was introduced in Symfony 4.2.

.. _component-serializer-handling-circular-references:

Handling Circular References
Expand Down