Este repositório contém os arquivos iniciais para se ter um projeto WordPress nos moldes do Hacklab. Isso significa que as ferramentas de desenvolvimento e deploy estão protegidas por um padrão.
A ideia é que seja feito um fork deste repositório para começar um novo projeto WordPress. Os arquivos deverão ser modificados conforme as peculiaridades do projeto.
Para o desenvolvimento recomenda-se a utilização do editor Visual Studio Code com as seguintes extenções:
- EditorConfig for VS Code
- PHP Intelephense
- Docker
- Beautify
- Beautify css/sass/scss/less
- GitLens
- ...
Para o desenvolvimento é requisito ter instaladas ao menos as seguintes ferramtas:
- Git
- Docker e Docker Compose - Docker é a ferramenta recomendada para desenvolver localmente. Para instalá-lo siga estas instruções.
- node e npm
Clone o repositório e seus submódulos recursivamente:
$ git clone git@git.hacklab.com.br:open-source/base-wordpress-project.git --recursive
Exemplo aplicando o plugin Hacklab Blocks como submódulo na pasta /plugins. O -f é necessário quando a pasta plugins está no .gitignore
$ git submodule add -f git@gitlab.hacklab.com.br:open-source/hacklab-blocks.git plugins/hacklab-blocks
Abra um terminar, vá até a a pasta themes/midia-ninja-theme/
e execute os comandos abaixo:
$ npm install
$ npm run watch # vai ficar observando as mudanças nos assets
Abra outro terminal e na raíz do repositório execute o comando abaixo:
docker-compose up
Há uma série de scripts úteis na pasta dev-scripts
- dump - faz um dump do banco de desenvolvimento
exemplo de uso:dev-scripts/$ ./dump > dump.sql
- mysql - entra no shell do mysql com o usuário wordpress
- mysql-root - entra no shell do mysql com o usuário root
- wp - executa o comando wp-cli dentro do container wordpress
exemplo de uso:dev-scripts/$ ./wp search-replace https:// http://
Acesse http://localhost para ver o site.
Se você tem um dump de banco de dados .sql
ou .sql.gz
, para importá-lo em sua versão local, copie o arquivo para compose/local/mariadb/data
e execute:
docker-compose down -v # o parametro -v apaga os dados do mariadb
docker-compose up
- midia-ninja-theme pela slug nova ex: fpa-theme
- Tema Mídia Ninja pelo nome (exemplo Tema FPA )
- alterar nome da pasta para corresponder ao slug
- alterar nome do arquivo /languages/*.pot
https://hub.docker.com/_/wordpress
Exemplo: desativando o debug do wordpress
WORDPRESS_DEBUG: 0
Editar arquivo compose/local/wordpress/php/extra.ini e reiniciar container
Exemplo: desativando avisos de recursos depreciados do PHP
error_reporting = E_ALL & ~E_NOTICE & ~E_DEPRECATED
- Você ja deve ter rodado o docker-compose up pelo menos uma vez
- Instale e ative o plugin hacklab-dev-utils (esse plugin é um submódulo desse repositório, caso não tenha clonado o repositório com --recursive, rode
git submodule init
e depoisgit submodule update
)
Para iniciar o ambiente de debug, rode o script ./dev-scripts/dev.sh
Adicione <?php eval(\psy\sh()); ?>
na linha onde deseja debugar. No terminal, o código será interrompido exatamente no lugar onde adicionou o comando e você terá às variavés declaradas, classes instanciadas, funções disponíveis e etc.
Exemplo:
Ao adicionar eval(\psy\sh());
dentro do loop você pode chamar a função get_the_title() no terminal.
- Pressione
ctrl+shift+p
, va em Configure User Snippets - Selecione PHP
- E adicione:
"psy": {
"scope": "php",
"prefix": "psy",
"body": [
"eval(\\psy\\sh());",
],
}
Com isso, ao digitar psy
e pressionar a tecla Tab, o VSCode vai imprimir o códígo eval(\\psy\\sh());
Para sair desbloquear o processo de debug no terminal, utilize o comando exit
.
O conteúdo de wp-content
está excluído do versionamento por padrão. Para adicionar seu plugin ou tema como parte do repositório, você deve colocá-los nas pastas plugins
ou themes
que estão na raiz do repositório.
Quando utilizar o comando wp i18n make-json languages/
para gerar as traduções de arquivos .js e as traduções não funcionarem, uma das possíveis soluções pode ser renomear o arquivo gerado de {locale}-{hash}.json para {domain}-{locale}-{script-handle}.json