Gerenciar extensões de terceiros
O código que estende ou personaliza o comportamento do Adobe Commerce é chamado de extensão. Opcionalmente, é possível empacotar e distribuir extensões no Commerce Marketplace ou em outro sistema de distribuição de extensões.
As extensões incluem:
- Módulos (estenda os recursos do Adobe Commerce)
- Temas (altere a aparência da loja e do administrador)
- Pacotes de idioma (localize a loja e o Administrador)
composer.json
da extensão e anote os valores de "name"
e "version"
.Instalar
Antes da instalação, talvez você queira:
-
Faça backup do banco de dados.
-
Habilitar modo de manutenção:
code language-bash bin/magento maintenance:enable
Para instalar uma extensão, você deve:
-
Obtenha uma extensão do Commerce Marketplace ou de outro desenvolvedor de extensão.
-
Se você instalar uma extensão do Commerce Marketplace, verifique se o repositório
repo.magento.com
existe no arquivocomposer.json
:code language-bash "repositories": [ { "type": "composer", "url": "https://repo.magento.com/" } ]
-
Obtenha o nome e a versão do Compositor da extensão.
-
Atualize o arquivo
composer.json
em seu projeto com o nome e a versão da extensão. -
Verifique se a extensão foi instalada corretamente.
-
Ative e configure a extensão.
Obter informações de extensão
Se você já sabe o nome e a versão do Composer da extensão, ignore esta etapa e continue com Atualize seu arquivo composer.json
.
Para obter o nome e a versão do Compositor da extensão do Commerce Marketplace:
-
Faça logon em Commerce Marketplace com o nome de usuário e a senha que você usou para comprar a extensão.
-
No canto superior direito, clique em Seu nome > Meu perfil.
-
Clique em Minhas compras.
-
Localize a extensão que você deseja instalar e clique em Detalhes Técnicos.
composer.json
da extensão.Atualizar dependências do Composer
Adicione o nome e a versão da extensão ao arquivo composer.json
:
-
Navegue até o diretório do projeto e atualize o arquivo
composer.json
.code language-bash composer require <component-name>:<version>
Por exemplo,
code language-bash composer require j2t/module-payplug:2.0.2
-
Insira suas chaves de autenticação. Sua chave pública é seu nome de usuário; sua chave privada é sua senha.
-
Aguarde até que o Composer conclua a atualização das dependências do projeto e verifique se não há erros:
code language-none Updating dependencies (including require-dev) Package operations: 1 install, 0 updates, 0 removals - Installing j2t/module-payplug (2.0.2): Downloading (100%) Writing lock file Generating autoload files
Verificar instalação
Para verificar se a extensão foi instalada corretamente, execute o seguinte comando:
bin/magento module:status J2t_Payplug
Por padrão, a extensão provavelmente está desativada:
Module is disabled
O nome da extensão está no formato <VendorName>_<ComponentName>
; esse é um formato diferente do nome do Compositor. Use esse formato para habilitar a extensão. Se não tiver certeza do nome da extensão, execute:
bin/magento module:status
E procure a extensão em "Lista de módulos desativados".
Ativar
Algumas extensões não funcionam corretamente, a menos que você limpe primeiro os arquivos de exibição estáticos gerados. Use a opção --clear-static-content
para limpar arquivos de exibição estáticos quando estiver habilitando uma extensão.
-
Habilite a extensão e limpe os arquivos de exibição estáticos:
code language-bash bin/magento module:enable J2t_Payplug --clear-static-content
Você deve ver a seguinte saída:
code language-none The following modules have been enabled: - J2t_Payplug To make sure that the enabled modules are properly registered, run 'setup:upgrade'. Cache cleared successfully. Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes. Generated static view files cleared successfully.
-
Registre a extensão:
code language-bash bin/magento setup:upgrade
-
Recompile o projeto: no modo de Produção, você pode receber uma mensagem para "Execute novamente o comando Magento compile". O aplicativo não solicita que você execute o comando compile no modo de Desenvolvedor.
code language-bash bin/magento setup:di:compile
-
Verifique se a extensão está ativada:
code language-bash bin/magento module:status J2t_Payplug
Você deve ver a saída verificando se a extensão não está mais desativada:
code language-none Module is enabled
-
Limpe o cache:
code language-bash bin/magento cache:clean
-
Configure a extensão no Admin conforme necessário.
bin/magento cache:flush
.Atualizar
Para atualizar ou atualizar um módulo ou uma extensão:
-
Baixe o arquivo atualizado do Marketplace ou de outro desenvolvedor de extensão. Anote o nome e a versão do módulo.
-
Exporte o conteúdo para o diretório raiz do aplicativo.
-
Se existir um pacote do Composer para o módulo, execute um dos procedimentos a seguir.
Atualizar por nome de módulo:
code language-bash composer update vendor/module-name
Atualizar por versão:
code language-bash composer require vendor/module-name ^x.x.x
-
Execute os seguintes comandos para atualizar, implantar e limpar o cache.
code language-bash bin/magento setup:upgrade --keep-generated
code language-bash bin/magento setup:static-content:deploy
code language-bash bin/magento cache:clean
Desinstalar
Você deve entrar em contato com o fornecedor da extensão para obter instruções sobre como remover uma extensão de terceiros. As instruções devem fornecer as seguintes informações:
- Como reverter alterações na tabela do banco de dados
- Como reverter alterações de dados do banco de dados
- Quais arquivos devem ser removidos ou revertidos
As instruções a seguir fornecem informações gerais para a desinstalação de extensões de terceiros:
-
Remova a extensão do repositório de projetos do Adobe Commerce.
-
Para extensões baseadas no Composer, remova a extensão do arquivo Adobe Commerce
composer.json
.code language-bash composer remove <package-name>
-
Para extensões não baseadas no Composer, remova os arquivos físicos do repositório do projeto do Adobe Commerce.
code language-bash rm -rf app/code/<vendor-name>/<module-name>
-
-
Se o arquivo
config.php
estiver sob controle do código-fonte no repositório de projetos do Adobe Commerce, remova a extensão do arquivoconfig.php
. -
Teste o banco de dados local para garantir que as instruções fornecidas pelo fornecedor funcionem conforme esperado.
-
Verifique se a extensão está desativada corretamente e se o site funciona conforme esperado em seu ambiente de preparo.
-
Implante as alterações no ambiente de produção.