Krdytkyu

How to display registered customers in terminal using custom console command?Can anyone please help me out.

First, you need to create di.xml in your customer module(I am assuming that you already know how to create a module)

app/code/VENDOR/MODULE/etc/di.xml

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <type name="MagentoFrameworkConsoleCommandList">

            <arguments>

                <argument name="commands" xsi:type="array">

                    <item name="registered_customer_list" xsi:type="object">VENDORMODULEConsoleCommandGetRegisteredCustomerList</item>

                </argument>

            </arguments>

        </type>    

</config>

Now you need to create GetRegisteredCustomerList.php

app/code/VENDOR/MODULE/Console/Command/GetRegisteredCustomerList.php

<?php



namespace VendorMODULEConsoleCommand;



use SymfonyComponentConsoleCommandCommand;

use SymfonyComponentConsoleInputInputInterface;

use SymfonyComponentConsoleOutputOutputInterface;

use MagentoCustomerModelResourceModelCustomerCollectionFactory;





class GetRegisteredCustomerList extends Command

{

    const COMMAND = 'customer:list';





    private $customerCollectionFactory;





    public function __construct(

        CollectionFactory $customerCollectionFactory

    )

    {

        parent::__construct();



        $this->customerCollectionFactory = $customerCollectionFactory;

    }



    /**

     * @inheritdoc

     */

    protected function configure()

    {

        $this->setName(self::COMMAND);

        $desc = 'Registered customers list';

        $this->setDescription($desc);

    }





    protected function execute(InputInterface $input, OutputInterface $output)

    {

        try {

            $table = $this->getHelperSet()->get('table');

            $table->setHeaders(['ID', 'Website ID', 'Group ID', 'First Name', 'Last Name', 'Email']);



            $customerCollection = $this->customerCollectionFactory->create();

            foreach ($customerCollection as $customer) {

                $table->addRow([

                    $customer->getData('entity_id'),

                    $customer->getData('website_id'),

                    $customer->getData('group_id'),

                    $customer->getData('firstname'),

                    $customer->getData('lastname'),

                    $customer->getData('email'),

                ]);

            }



            $table->render($output);

        } catch (Exception $e) {

            $output->writeln("<error>Error executing command: {$e->getMessage()}</error>");

        }

    }

}

Now you need to execute the php bin/magento setup:di:compile command from the magento root directory

and php bin/magento cache:clean

And now you can get your registered customer list by executing below command,

php bin/magento customer:list

it will print something like this,

$ php bin/magento customer:list

+----+------------+----------+------------+-----------+------------------------------+

| ID | Website ID | Group ID | First Name | Last Name | Email                        |

+----+------------+----------+------------+-----------+------------------------------+

| 1  | 1          | 1        | Keyur      | Shah1     | keyurtest@gmail.com   |

| 2  | 1          | 1        | Keyur      | Shah      | keyur@gmail.com              |

| 3  | 1          | 1        | Keyur      | Shah      | keyurdemo@gmail.com  |

| 4  | 1          | 1        | Keyur      | Shah      | demo@gmail.com |

| 5  | 1          | 1        | Keyur      | Shah      | test@gmail.com    |

+----+------------+----------+------------+-----------+------------------------------+

You can add your own commands for listing customers:

add your command class through di.

<type name="MagentoFrameworkConsoleCommandListInterface">

    <arguments>

        <argument name="commands" xsi:type="array">

            <item name="customersList" xsi:type="object">ComapanyModuleNameConsoleCommandCustomersList</item>

        </argument>

    </arguments>

</type>

Create your class. Take help from magento created command classes. Here i create class from MagentoCatalogConsoleCommandProductAttributesCleanUp

<?php



namespace ComapanyModuleNameConsoleCommand;



use SymfonyComponentConsoleInputInputInterface;

use SymfonyComponentConsoleOutputOutputInterface;



/**

 * Class ProductAttributesCleanUp

 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)

 */

class CustomersList extends SymfonyComponentConsoleCommandCommand

{



     /**

     * @var MagentoFrameworkAppState

     */

    protected $appState;



    /**

     * @var  MagentoCustomerModelResourceModelCustomerCollectionFactory

     */

    protected $customerCollectionFactory;





    /**

     * @param MagentoFrameworkAppState $appState

     * @param MagentoCustomerModelResourceModelCustomerCollectionFactory

     */

    public function __construct(

        MagentoFrameworkAppState $appState,

        MagentoCustomerModelResourceModelCustomerCollectionFactory $customerCollectionFactory



    ) {

        $this->appState = $appState;

        $this->customerCollectionFactory = $customerCollectionFactory;

        parent::__construct();

    }



    /**

     * {@inheritdoc}

     */

    protected function configure()

    {

        $this->setName('customers:list');

        $this->setDescription('List All Customers.');

    }



    /**

     * {@inheritdoc}

     */

    protected function execute(InputInterface $input, OutputInterface $output)

    {

        $output->setDecorated(true);

        $this->appState->setAreaCode(MagentoFrameworkAppArea::AREA_GLOBAL);





        $output->writeln("");

        $collection =$this->customerCollectionFactory->create();

        $output->writeln("<info>Customers:</info>");

        foreach ($collection as $customer) {

            $output->writeln("<comment> ".$customer->getEmail()." </comment>");

        }





        return MagentoFrameworkConsoleCli::RETURN_SUCCESS;



    }





}