Pāriet uz saturu

Darba sākšana

Šī pamācība palīdzēs iestatīt Blockstudio un izveidot savu pirmo pielāgoto bloku.

Instalēšana

Apvalks
composer require blockstudio/blockstudio

Blockstudio var instalēt kā spraudni, izmantojot composer/installers, vai iekļaut tieši tēmā. Visas instalēšanas metodes skatiet Composerdokumentācijā.

Composer instalācijas saņem atjauninājumus, izmantojot Composer. Iebūvētais GitHub atjauninātājs tiek automātiski atspējots.

Manuāla instalēšana

Lejupielādējiet jaunāko laidienu no GitHub

Augšupielādējiet ZIP arhīvu savas WordPress spraudņu mapē un aktivizējiet spraudni. Manuālās instalācijas saņem automātiskus paziņojumus par atjauninājumiem WordPress informācijas panelī, izmantojot iebūvēto GitHub atjauninātāju.

Abas instalēšanas metodes komplektā iekļauj privātas Markdown, YAML un atjauninātāja bibliotēku kopijas un to atkarības. Tās neizmanto un neaizstāj versijas, ko nodrošina cits spraudnis vai motīvs. Ja jūsu lietotne kādu no šīm bibliotēkām izmanto tieši, instalējiet savu Composer atkarību; Blockstudio komplektā iekļautās kopijas ir iekšējai lietošanai, nevis publiska PHP API.

Autentificētas atjauninājumu pārbaudes

Manuālas instalācijas pēc noklusējuma anonīmi pārbauda GitHub. Vairākas vietnes, kas koplieto vienu izejošo IP, var iztērēt GitHub anonīmo API atļauto pieprasījumu skaitu un, pārbaudot atjauninājumus, saņemt atbildes HTTP 403. Sākot ar 7.7.4, pirms WordPress ielādes konfigurējiet personīgās piekļuves marķieri GitHub vidē wp-config.php:

PHP
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');

Marķierim nepieciešama tikai piekļuve publiskā repozitorija informācijai. Nepiešķiriet rakstīšanas atļaujas. Glabājiet to servera puses konfigurācijā, ārpus versiju kontroles, blockstudio.json, bloku atribūtiem un priekšgala koda. Atjauninātājs to nodod komplektā iekļautajam GitHub klientam autentificētām pārbaudēm un laidienu lejupielādei. Pieprasījumi uz nesaistītiem repozitorijiem un citām lejupielādes vietnēm marķieri nesaņem.

Konfidenciālu vides mainīgo pārvaldībai MU spraudnis var nodrošināt vai aizstāt marķieri:

PHP
<?php
add_filter('blockstudio/updater/token', function ($token) {
  return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});

Filtrs tiek palaists, kad Blockstudio inicializē savu atjauninātāju, pirms tiek ielādēts motīvs. Reģistrējiet to MU spraudnī, nevis functions.php. Tukšas virknes atgriešana atspējo autentifikāciju pat tad, ja konstante ir definēta. Tukšas vai nevirknes vērtības saglabā anonīmu pārbaudi. Marķieri nav obligāti; bez tā esošā atjaunināšanas darbība nemainās. Composer instalācijas atjauninājumiem joprojām izmanto Composer un šo atjauninātāju neinicializē.

Pirmā bloka izveide

1. Izveidojiet bloka mapi

Izveidojiet jaunu mapi savā tēmā:

Kods
my-theme/
  blockstudio/
    my-first-block/
      block.json
      index.php

2. Definējiet bloka shēmu

Izveidojiet block.json ar bloka konfigurāciju:

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "my-theme/my-first-block",
  "title": "My First Block",
  "category": "common",
  "icon": "star-filled",
  "blockstudio": {
    "attributes": [
      {
        "id": "heading",
        "type": "text",
        "label": "Heading",
        "default": "Hello World"
      },
      {
        "id": "content",
        "type": "textarea",
        "label": "Content"
      }
    ]
  }
}

3. Izveidojiet veidni

Izveidojiet index.php renderēšanai:

PHP
<div class="my-first-block">
  <h2><?php echo $a['heading']; ?></h2>
  <p><?php echo $a['content']; ?></p>
</div>

Veidņu Twig izmantošana

Blockstudio jau sākotnēji atbalsta Twig veidnes. Vienkārši izmantojiet index.twig:

Twig
<div class="my-first-block">
  <h2>{{ a.heading }}</h2>
  <p>{{ a.content }}</p>
</div>

Stilu pievienošana

Izveidojiet style.css failu tajā pašā mapē:

CSS
.my-first-block {
  padding: 2rem;
  background: #f5f5f5;
}

Blockstudio automātiski pievienos šo stilu lapu rindai, kad bloks tiks izmantots.

Tulkojumi

Blockstudio redaktora vadīklas un administrēšanas pārskats ielādē JavaScript tulkojumus teksta domēnam blockstudio, izmantojot WordPress. Instalējiet atbilstošu valodas pakotni vai ģenerējiet skriptu tulkojumu JSON failus ar tulkošanas rīku, kas iekļauts wp-content/languages/plugins/. Virknes, kurām tulkojums nav pieejams, paliek angļu valodā. Tiek tulkots paša Blockstudio interfeiss, nevis saturs vai lauku etiķetes, ko definējat savos blokos.

Nākamie soļi

Bloks tagad ir gatavs lietošanai WordPress redaktorā. Turpiniet iepazīt dokumentāciju, lai uzzinātu par:

Bloku bibliotēkas izveide

Pārejiet no viena bloka uz pilnvērtīgu bibliotēku: dizaina tokeni, sadaļu raksti, atkārtotāji, attēli un lapu kompozīcija.