Documentation » Admin

12. Saving hooks »

« 10. Deleting objects

11. The Export action

This document will cover the Export action and related configuration options.


This article assumes you are using Symfony 4. Using Symfony 2.8 or 3 will require to slightly modify some namespaces and paths when creating entities and admins.

11.1. Basic configuration

If you have registered the SonataExporterBundle bundle, you can benefit from a lot of flexibility:

  • You can configure default exporters globally.
  • You can add custom exporters, also globally.
  • You can configure every default writer.

See the exporter bundle documentation for more information.

11.1.1. Translation

All field names are translated by default. An internal mechanism checks if a field matching the translator strategy label exists in the current translation file and will use the field name as a fallback.

11.1.2. Picking which fields to export

By default, all fields are exported. More accurately, it depends on the persistence backend you are using, but for instance, the doctrine ORM backend exports all fields (associations are not exported). If you want to change this behavior for a specific admin, you can override the getExportFields() method:


public function getExportFields()
    return ['givenName', 'familyName', '', 'getAddress'];


Note that you can use to access the phone property of Contact entity. Or use a getter if you have some virtual field.

You can also tweak the list by creating an admin extension that implements the configureExportFields() method.

public function configureExportFields(AdminInterface $admin, array $fields)

    return $fields;

11.1.3. Overriding the export formats for a specific admin

Changing the export formats can be done by defining a getExportFormats() method in your admin class.


public function getExportFormats()
    return ['pdf', 'html'];

11.1.4. Customizing the query used to fetch the results

If you want to customize the query used to fetch the results for a specific admin, you can override the getDataSourceIterator() method:

// src/Admin/PersonAdmin.php

class PersonAdmin extends AbstractAdmin
    public function getDataSourceIterator()
        $iterator = parent::getDataSourceIterator();
        $iterator->setDateTimeFormat('d/m/Y'); //change this to suit your needs
        return $iterator;


TODO: * customising the templates used to render the output * publish the exporter documentation on the project’s website and update the link

Found a typo? Something is wrong in this documentation? Just fork and edit it!