Izris atributov
V datotekah predlog lahko do vseh atributov dostopate s spremenljivkama $attributes ali $a ter z ID-jem ustreznega polja.
PHP
<h1><?php echo $attributes['message']; ?></h1>
<h1><?php echo $a['message']; ?></h1>
Twig
<h1>{{ attributes.message }}</h1>
<h1>{{ a.message }}</h1>
Programski zapis atributov
Urejevalnik ugnezdi shranjene vrednosti pod blockstudio.attributes. Vsak del, ki zapisuje blok zunaj urejevalnika, na primer REST API, WP-CLI, selitev vsebine ali strežnik MCP, poišče blok prek atributov, ki jih Blockstudio registrira na WP_Block_Type, in jih zapiše na najvišjo raven. Izris deluje pri obeh strukturah:
// Top level, as a programmatic writer produces it.
echo do_blocks( '<!-- wp:acme/hero {"visual_type":"media"} /-->' );
// Nested, as the editor saves it.
echo do_blocks( '<!-- wp:acme/hero {"blockstudio":{"attributes":{"visual_type":"media"}}} /-->' );
Preberejo se samo ID-ji, ki jih blok deklarira na najvišji ravni, zato lastni atributi WordPress, kot so anchor, className, lock, metadata in style, niso nikoli prevzeti kot vrednosti polj. Če se isti ID pojavi na obeh mestih, ima prednost ugnezdena vrednost.
Programski dostop do atributov
Koda, ki se izvaja zunaj predloge, na primer strukturirani podatki v save_post, izvozi, indeksiranje iskanja ali filter render_block, pogosto potrebuje vrednosti shranjenega bloka, kot jih vidi predloga. bs_block_values() jih vrne brez izrisa bloka. Pokličite jo po registraciji bloka (init ali pozneje) s celotnim poljem attrs iz parse_blocks():
foreach (parse_blocks($post->post_content) as $block) {
if ($block['blockName'] === null) {
continue;
}
$a = bs_block_values($block['blockName'], $block['attrs']);
if ($a === null) {
// Not a Blockstudio block, and no extension applies.
continue;
}
echo esc_html($a['title'] ?? '');
}
Rezultat je polje $a predloge, indeksirano po ID-ju polja:
- Uporabijo se privzete vrednosti polj, ponavljalnik z
minpa vsebuje začetne vrstice. - Vrednosti najvišje ravni in
blockstudio.attributesse združijo, pri čemer zmaga ugnezdena vrednost. Z najvišje ravni se berejo samo deklarirani ID-ji, WordPress pa zavrže vrednost najvišje ravni, ki se ne ujema z registrirano vrsto polja, na primer niz izbirnika, natanko tako kot pri izrisu. - Vključena so polja ujemajočih se razširitev razširitve z njihovimi privzetimi vrednostmi. Razširitev osnovnega ali bloka tretje osebe bere samo
blockstudio.attributes, tako kot pri izrisu. - Uporabijo se povratne oblike, zato izbirnik z
returnFormatvrednostilabelvrne oznako, polje datotek pa podatke o prilogi. - Onemogočena in prazna polja so
false, tako kot v predlogi.
null pomeni, da bloka ali razširitve ne upravlja Blockstudio. Blok Blockstudio brez polj vrne [].
Funkcija izvede enako pretvorbo kot izris, zato ima enake stranske učinke: polja datotek poizvedujejo po prilogah, blokovno polje, ki ne vrne data, izriše sklicani blok, filter blockstudio/blocks/attributes/render pa se izvede za vsako vrednost. Funkcija ne izriše predloge samega bloka in ne razreši innerBlocks; obhodite jih sami. Polje kode ohrani ustvarjeni ID %selector%, ki se med klici razlikuje.
Razreševanje uporablja trenutni kontekst WordPress. Metapodatki, ki so na voljo samo pri izrisu, kot so števci blokov in innerBlocks, se ne ustvarijo; filtri za izris atributov prejmejo ime bloka, ne metapodatkov popolnoma izrisanega bloka.
Za shranjene vrednosti brez pretvorbe ni možnosti. Zanje preberite neposredno polje attrs ali jih preverite z bs_validate_block().
Prazne vrednosti
Vrednosti atributov vrnejo false, če je polje prazno ali ni izbrana nobena možnost.
PHP
<?php if ($a['message']) : ?>
<h1><?php echo $a['message']; ?></h1>
<?php endif; ?>
Twig
{% if a.message %}
<h1>{{ a.message }}</h1>
{% endif %}
Kompleksne vrste
Datoteke
Privzeto (brez returnFormat ali z "returnFormat": "object") polje datotek vrne polje s podatki o prilogi. Z "multiple": true vrne seznam teh polj. Datoteka, katere priloga ne obstaja več, je false.
| Ključ | Opis |
|---|---|
ID |
ID priloge. |
title |
Naslov priloge. |
alt |
Nadomestno besedilo. Če je prazno, se uporabi naslov priloge. |
caption |
Napis. |
description |
Opis. |
href |
Trajna povezava do strani priloge. |
url |
URL datoteke. Pri spustnem seznamu velikosti ("size": true) je to URL izbrane velikosti. |
sizes |
URL in mere vseh registriranih velikosti slik; glejte spodaj. |
PHP
<?php if ($a['image']) :
$image = $a['image'];
$sizes = $image['sizes'] ?? [];
?>
<img
src="<?php echo esc_url($sizes['large'] ?? $image['url']); ?>"
alt="<?php echo esc_attr($image['alt']); ?>"
<?php if (isset($sizes['large-width'], $sizes['large-height'])) : ?>
width="<?php echo esc_attr($sizes['large-width']); ?>"
height="<?php echo esc_attr($sizes['large-height']); ?>"
<?php endif; ?>
/>
<?php endif; ?>
Twig
{% if a.image %}
<img
src="{{ (a.image.sizes.large ?? a.image.url)|e('html_attr') }}"
alt="{{ a.image.alt|e('html_attr') }}"
{% if a.image.sizes['large-width'] is defined and a.image.sizes['large-height'] is defined %}
width="{{ a.image.sizes['large-width']|e('html_attr') }}"
height="{{ a.image.sizes['large-height']|e('html_attr') }}"
{% endif %}
/>
{% endif %}
sizes vsebuje en vnos za vsako registrirano velikost slike in še full: URL pod imenom velikosti ter mere pod <size>-width in <size>-height. Če velikost WordPress za prilogo ni bila ustvarjena, se razreši na izvirno datoteko z njenimi merami. Če WordPress ne more razrešiti slike ali predogleda, ključa sizes ni. Na primer, PDF brez ustvarjenega predogleda nima sizes, PDF z metapodatki predogleda pa lahko vsebuje velikosti slik. sizes je null, kadar ni registrirana nobena velikost slike ali kadar jih filter files/sizesfilter onemogoči. Ta filter lahko tudi skrajša zemljevid, zato pred branjem mer preverite, ali velikost obstaja, kot je prikazano v zgornjih primerih.
Objekt nima ključev width, height, mime, type ali size. Mere preberite iz sizes ali uporabite ID s funkcijami, kot sta wp_get_attachment_image() in get_post_mime_type().
Oblike vrnjene vrednosti
returnFormat spremeni, kaj polje vrne:
returnFormat |
Vrednost |
|---|---|
"object" (privzeto) |
Zgoraj opisano polje. |
"id" |
ID priloge, kot je shranjen, ali seznam ID-jev z "multiple": true. |
"url" |
URL kot niz ali seznam URL-jev z "multiple": true. Slike uporabljajo velikost, nastavljeno z returnSize (privzeto full), druge datoteke pa svoj URL. |
Povezava
Polje povezave vrne objekt z atributi URL:
PHP
<?php if ($a['link']) : ?>
<a
href="<?php echo $a['link']['url']; ?>"
target="<?php echo $a['link']['target']; ?>"
>
<?php echo $a['link']['title']; ?>
</a>
<?php endif; ?>
Twig
{% if a.link %}
<a href="{{ a.link.url }}" target="{{ a.link.target }}">
{{ a.link.title }}
</a>
{% endif %}
Ikona
Polje ikone vrne objekt s ključi set, subSet in icon. Za izpis SVG uporabite pomožni funkciji bs_render_icon() in bs_icon():
PHP
<?php if ($a['icon']) : ?>
<div class="icon">
<?php bs_render_icon($a['icon']); ?>
</div>
<?php endif; ?>
Twig
{% if a.icon %}
<div class="icon">
{{ bs_icon(a.icon) }}
</div>
{% endif %}
bs_render_icon() izpiše SVG neposredno. bs_icon() ga vrne kot niz.
Atributi
Vrsta polja »attributes« vrne polje parov {attribute, value} za izris kot atribute HTML. Za njihov izpis uporabite bs_render_data_attributes():
PHP
<div <?php bs_render_data_attributes($a['attributes']); ?>>
Content
</div>
Twig
<div {{ fn('bs_render_data_attributes', a.attributes) }}>
Content
</div>
bs_render_data_attributes() izpiše atribute neposredno. bs_data_attributes() vrne niz.
Skupina
Polja skupine predpone ID-jem podrejenih atributov dodajo ime skupine. Uporabite bs_get_group(), da polja skupine izluščite v pregledno polje:
PHP
<?php $group = bs_get_group($a, 'settings'); ?>
<h1><?php echo $group['title']; ?></h1>
<p><?php echo $group['description']; ?></p>
Twig
{% set group = fn('bs_get_group', a, 'settings') %}
<h1>{{ group.title }}</h1>
<p>{{ group.description }}</p>
S tem se iz ključev atributov odstrani predpona skupine. Na primer, $a['settings_title'] postane $group['title'].
Pomožna funkcija deluje tudi, ko skupina izvira iz ponovno uporabljenega polja po meri:
{
"name": "section-header",
"attributes": [
{
"id": "section-header",
"type": "group",
"attributes": [
{ "id": "kicker", "type": "text" },
{ "id": "title", "type": "text" }
]
}
]
}
{
"blockstudio": {
"attributes": [
{ "type": "custom/section-header" }
]
}
}
{% set sectionHeader = fn('bs_get_group', a, 'section-header') %}
<p>{{ sectionHeader.kicker }}</p>
<h2>{{ sectionHeader.title }}</h2>
Ponavljalnik
Pojdite skozi elemente ponavljalnika:
PHP
<?php foreach ($a['items'] as $item) : ?>
<div class="item">
<h3><?php echo $item['title']; ?></h3>
<p><?php echo $item['description']; ?></p>
</div>
<?php endforeach; ?>
Twig
{% for item in a.items %}
<div class="item">
<h3>{{ item.title }}</h3>
<p>{{ item.description }}</p>
</div>
{% endfor %}