Pāriet uz saturu

Atribūtu filtrēšana

Blockstudio nodrošina divas metodes bloku atribūtu filtrēšanai.

Atribūtu definīcijas

blockstudio/blocks/attributes filtrē katru lauka definīciju, savukārt Blockstudio izveido un reģistrē bloku. Izmantojiet to, lai pielāgotu redaktora vadīklas, noklusējuma vērtības, nosacījumus, opcijas un definīciju, ko izmanto vērtību validēšanai renderēšanas laikā.

PHP
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
  if (
    ($block['name'] ?? '') === 'my-theme/code-block' &&
    ($attribute['id'] ?? '') === 'lineNumbers'
  ) {
    $attribute['default'] = true;
    $attribute['conditions'] = [
      [
        [
          'id' => 'language',
          'operator' => '==',
          'value' => 'css'
        ]
      ]
    ];
  }

  return $attribute;
}, 10, 2);

Iepriekš minētais kods iestata lineNumbers noklusējuma vērtību uz true un paslēpj lauku, ja vien language nav iestatīts uz css.

Atzvanīšanas funkcija katrā izsaukumā saņem vienu lauka definīciju, tostarp ligzdotus grupu un atkārtotāja laukus. Tā tiek izpildīta bloka reģistrēšanas laikā, nevis katras priekšgala renderēšanas laikā.

Filtrētās opciju definīcijas tiek izmantotas arī renderēšanas atribūtu kartē. Piemēram, opcija, kas pievienota select, radio vai checkbox laukam, ir pieejama redaktorā un paliek derīga, kad Blockstudio iegūst saglabāto veidnes vērtību:

PHP
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
  if (
    ($block['name'] ?? '') === 'bsui/button' &&
    ($attribute['id'] ?? '') === 'variant'
  ) {
    $attribute['options'][] = [
      'label' => 'Brand',
      'value' => 'brand',
    ];
  }

  return $attribute;
}, 10, 2);

Renderētās vērtības

blockstudio/blocks/attributes/render filtrē viena lauka atrisināto vērtību tieši pirms tās nodošanas bloka veidnei. Tas tiek izpildīts katram laukam, tāpēc atzvanāmais saņem vērtību, lauka atslēgu un bloka datus.

PHP
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
  if (($block['name'] ?? '') === 'my-theme/code-block' && 'lineNumbers' === $key) {
    return true;
  }
  return $value;
}, 10, 3);

Iepriekš minētais piemērs ignorē jebkuru vērtību, kas redaktorā saglabāta laukam lineNumbers. Reģistrējiet atzvanāmo funkciju ar trim pieņemtiem argumentiem (pēdējo argumentu funkcijai add_filter), citādi WordPress nodod tikai vērtību.

  • $value: lauka atrisinātā vērtība tādā formā, kādu veidne saņem kā $a[$key]. Atgrieziet vērtību, kas jānodod veidnei.
  • $key: lauka atslēga, kāda izmantota $a. Atkārtotāja rindā tā ir lauka ID šajā rindā.
  • $block: bloka datu masīvs, ko veidnes saņem kā $block vai $b, kopā ar id, name, postId, postType, index, indexTotal, context un salas karodziņiem. Ja paplašinājumi tiek piemēroti blokam, kas nav Blockstudio bloks, $block satur tikai ierakstu blockstudio (attributes un disabled), un tam nav name.

Filtrs tiek izpildīts arī atribūtiem, kas nav Blockstudio lauki, piemēram, className un anchor, kā arī failu lauka elementam <id>__size, tāpēc pirms vērtības maiņas pārbaudiet $key. Atgrieztā vērtība aizstāj tikai $key vērtību; filtrs nevar pievienot jaunas atslēgas objektam $a.

Izmantojiet definīcijas filtru, lai mainītu lauka konfigurāciju, un attēlošanas filtru, lai aprēķinātu vai aizstātu veidnes vērtības konkrētā pieprasījumā.

Ja vērtības nolasa ar bs_block_values(), nevis attēlo, šis filtrs saņem tikai bloka nosaukumu laukā $block. Šī palīgfunkcija neizveido attēlošanas skaitītājus un citus metadatus, kas pieejami tikai attēlošanas laikā.