DocumentaçãoCommerceGuia de instalação

Instalar uma extensão

Last update: Fri May 19 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Experienced
  • Admin
  • Developer

O código que estende ou personaliza o comportamento Adobe Commerce e Magento Open Source é chamado de extensão. Opcionalmente, é possível empacotar e distribuir extensões na Commerce Marketplace ou outro sistema de distribuição de extensões.

As extensões incluem:

  • Módulos (estenda os recursos do Adobe Commerce e do Magento Open Source)
  • Temas (altere a aparência da loja e do administrador)
  • Pacotes de idioma (localize a loja e o Administrador)
TIP
Este tópico explica como usar a linha de comando para instalar extensões compradas do Commerce Marketplace. Você pode usar o mesmo procedimento para instalar o qualquer extensão; tudo o que você precisa é do nome e da versão do Compositor da extensão. Para encontrá-la, abra a extensão do composer.json arquivo e observe os valores de "name" e "version".

Antes da instalação, talvez você queira:

  1. Faça backup do banco de dados.

  2. Habilitar modo de manutenção:

    code language-bash 
    bin/magento maintenance:enable

Para instalar uma extensão, você deve:

  1. Obtenha uma extensão do Commerce Marketplace ou de outro desenvolvedor de extensão.

  2. Se você instalar uma extensão do Commerce Marketplace, verifique se repo.magento.com o repositório existe em seu composer.json arquivo:

    code language-bash 
    "repositories": [
    {
        "type": "composer",
        "url": "https://repo.magento.com/"
    }
]

  3. Obtenha o nome e a versão do Compositor da extensão.

  4. Atualize o composer.json arquivo no seu projeto com o nome e a versão da extensão.

  5. Verifique se a extensão foi instalada corretamente.

  6. Ative e configure a extensão.

Obter o nome e a versão do Compositor da extensão

Se você já sabe o nome e a versão do Composer da extensão, ignore esta etapa e continue em Atualize seu composer.json arquivo.

Para obter o nome e a versão do Compositor da extensão do Commerce Marketplace:

  1. Efetue logon no Commerce Marketplace com o nome de usuário e a senha que você usou para comprar a extensão.

  2. No canto superior direito, clique em Seu nome > Meu perfil.

    Acessar sua conta do Marketplace

  3. Clique em Minhas compras.

    Histórico de compras do Marketplace

  4. Localize a extensão que deseja instalar e clique em Detalhes técnicos.

    Detalhes técnicos mostra o nome do Compositor da extensão

TIP
Como alternativa, você pode encontrar o nome do Compositor e a versão de qualquer extensão (independentemente de você tê-la comprado no Commerce Marketplace ou em outro lugar) no composer.json arquivo.

Atualizar o arquivo do Composer

Adicione o nome e a versão da extensão à composer.json arquivo:

  1. Navegue até o diretório do projeto e atualize o composer.json arquivo.

    code language-bash 
    composer require <component-name>:<version>

    Por exemplo,

    code language-bash 
    composer require j2t/module-payplug:2.0.2

  2. Insira seu chaves de autenticação. Sua chave pública é seu nome de usuário; sua chave privada é sua senha.

  3. Aguarde até que o Composer conclua a atualização das dependências do projeto e verifique se não há erros:

    code language-terminal 
    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 a extensã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>; este é 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 a extensão

Algumas extensões não funcionam corretamente, a menos que você limpe primeiro os arquivos de exibição estáticos gerados. Use o --clear-static-content opção para limpar arquivos de visualização estáticos quando estiver ativando uma extensão.

  1. 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-terminal 
    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.

  2. Registre a extensão:

    code language-bash 
    bin/magento setup:upgrade

  3. 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

  4. 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-terminal 
    Module is enabled

  5. Limpe o cache:

    code language-bash 
    bin/magento cache:clean

  6. Configure a extensão no Admin conforme necessário.

TIP
Se encontrar erros ao carregar a loja em um navegador, use o seguinte comando para limpar o cache: bin/magento cache:flush.

Atualizar uma extensão

Para atualizar ou atualizar um módulo ou uma extensão:

  1. Baixe o arquivo atualizado do Marketplace ou de outro desenvolvedor de extensão. Anote o nome e a versão do módulo.

  2. Exporte o conteúdo para o diretório raiz do aplicativo.

  3. 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

  4. 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
recommendation-more-help
0f8e7db5-0e9c-4002-a5b8-a0088077d995