PHP Hooks
Hieronder vind je een lijst met alle beschikbare hooks van PHP waarmee je de functionaliteit van de plug-in kunt uitbreiden of aanpassen.
Pad
Met dit filter kun je het pad van de blokmap aanpassen. Standaard bevindt deze zich blockstudio in het momenteel actieve thema. Je kunt ook een nieuwe instantie maken voor meerdere bronmappen.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Initialisatie
globaal
Deze actie wordt uitgevoerd nadat de plug-in alle blokken heeft geregistreerd.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
instantie
Deze actie wordt uitgevoerd nadat de plug-in alle blokken van een specifieke instantie heeft geregistreerd.
Het segment $instance is het pad van de instantie ten opzichte van wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Deze actie wordt uitgevoerd voordat de plug-in alle blokken heeft geregistreerd.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Deze actie wordt uitgevoerd voordat de plug-in alle blokken van een specifieke instantie heeft geregistreerd.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Blokken
weergave
Met dit filter kun je de uitvoer van een blok aanpassen voordat het wordt weergegeven.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
metadata
Met dit filter kun je de gegevens van het bestand block.json aanpassen voordat het wordt geregistreerd.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Met de bovenstaande code wordt het pictogram gewijzigd van alle blokken waarvan de naam begint met marketing.
voorwaarden
Met dit filter kunt u aangepaste voorwaarden toevoegen die in blocks kunnen worden gebruikt. Elk voorwaardetype is gekoppeld aan een waarde waarmee de editor value van de voorwaarde vergelijkt. Zie Aangepaste voorwaarden.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
attributen
Met dit filter pas je één velddefinitie aan voordat het blok wordt geregistreerd. De gefilterde definitie bepaalt het editorbesturingselement en de validatie van waarden tijdens het weergeven. Zie Filteren voor meer informatie.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Dit filter past de waarde van één veld aan voordat deze aan de blocktemplate wordt doorgegeven. Het wordt eenmaal per veld uitgevoerd en ontvangt drie argumenten: $value (de opgeloste waarde), $key (de veldsleutel, zoals gebruikt in $a) en $block (de blockgegevensarray die templates ontvangen als $block of $b). Registreer het met drie geaccepteerde argumenten. Zie Filteren voor meer informatie.
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
// Modify the value of one field before rendering.
return $value;
}, 10, 3);
attributes/files/sizes
Een files-veld retourneert elke afbeelding met een sizes-array met de URL, breedte en hoogte van full en van elk geregistreerd afbeeldingsformaat, bijvoorbeeld $image['sizes']['thumbnail'] en $image['sizes']['thumbnail-width']. Elk formaat vereist één aanroep van wp_get_attachment_image_src() per afbeelding, dus de filters ervan blijven van toepassing. Templates die sizes nooit uitlezen, kunnen de lijst weglaten of inkorten.
add_filter('blockstudio/blocks/attributes/files/sizes', function($sizes, $id, $size) {
// Keep only two sizes. Return an empty array to skip them, `sizes` is then null.
return ['full', 'large'];
}, 10, 3);
$sizes is de lijst met formaatsnamen, met full voorop (leeg als er geen tussenformaten zijn geregistreerd). $id is de bijlage-ID en $size het formaat dat is aangevraagd voor de url-waarde. Het filter wijzigt de sizes-array van elke files-waarde in de aanvraag. Zonder dit filter blijft de array ongewijzigd.
Geef groottebenamingen terug als tekenreeksen. Ongeldige items worden genegeerd, dubbele namen worden één keer verwerkt en een niet-arraywaarde slaat de groottes over. De gevraagde url en andere bijlage-eigenschappen blijven ongewijzigd. Deze hook wordt niet uitgevoerd voor een veld voor bestanden met returnFormat: "url", dat geen groottekaart opbouwt.
attributes/validate
Pas bevindingen aan van expliciete bs_validate_block()-aanroepen, bijvoorbeeld wanneer een aangepast renderfilter opgeslagen verwijzingen oplost. Hiermee wordt automatische validatie bij opslaan of renderen niet ingeschakeld.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Geef een lijst met bevindingen terug. Het filter wordt niet aangeroepen als het blok geen velden van het type Blockstudio of overeenkomende extensies heeft (null).
attributes/schema
Pas het JSON-schema aan dat wordt geretourneerd door bs_block_schema(), bijvoorbeeld wanneer een aangepast renderfilter opgeslagen verwijzingen oplost.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Retourneer de schema-array. Het filter wordt niet aangeroepen wanneer het blok geen velden van Blockstudio of overeenkomende extensies heeft (null).
attributes/populate
Met dit filter kun je aangepaste gegevens toevoegen aan de opties van een veld van het type checkbox, select of radio. Zie Opties vullen voor meer informatie.
Het filter ontvangt één argument: een array met alle aangepaste gegevenssets, gekoppeld aan de naam die in "populate": {"type": "custom", "custom": "myCustomOptions"} is gebruikt.
add_filter('blockstudio/blocks/attributes/populate', function($options) {
$options['myCustomOptions'] = [
['value' => '1', 'label' => 'Option 1'],
['value' => '2', 'label' => 'Option 2'],
];
return $options;
});
components/use_block_props/render
Met dit filter kun je de uitvoer van de inhoud van useBlockProps aanpassen.
Alle componentfilters (use_block_props, inner_blocks en rich_text) ontvangen het blok als laatste argument. $block is de WP_Block_Type die is geregistreerd voor het blok dat wordt gerenderd, dus $block->name is de bloknaam, bijvoorbeeld acme/hero.
$props is een tekenreeks met HTML-attributen, geen array. Op de frontend is dit het resultaat van get_block_wrapper_attributes(), bijvoorbeeld class="wp-block-acme-hero my-class". In de editor is het het attribuut class van het element. Geef een tekenreeks terug. In de editor wordt alleen het attribuut class van de teruggegeven tekenreeks toegepast.
add_filter('blockstudio/blocks/components/use_block_props/render', function($props, $block) {
if ($block->name !== 'acme/hero') {
return $props;
}
return str_replace('class="', 'class="my-custom-class ', $props);
}, 10, 2);
components/inner_blocks/render
Met dit filter kun je de uitvoer van de inhoud van <InnerBlocks /> aanpassen.
add_filter('blockstudio/blocks/components/inner_blocks/render', function($content, $block) {
return '<div class="inner-wrapper">' . $content . '</div>';
}, 10, 2);
components/inner_blocks/frontend/wrap
Met dit filter kun je de <InnerBlocks />-wrapper van de frontend verwijderen.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Met dit filter kunt u de uitvoer van de inhoud van <RichText /> aanpassen. Het ontvangt de waarde van het attribuut en het blok.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Bloktags
blockstudio/block_tags/builders
Dit filter registreert builders voor blokarrays die door bloktags en aangepaste blokken worden gebruikt die via blockstudio/parser/element_mapping zijn geselecteerd. Elke builder ontvangt geparseerde attributen en ruwe inhoud binnenin.
add_filter('blockstudio/block_tags/builders', function($builders, $parser) {
$builders['theme/paragraph'] = function(array $attributes, string $inner) {
$attributes['content'] = trim($inner);
return [
'blockName' => 'theme/paragraph',
'attrs' => [
'blockstudio' => [
'attributes' => $attributes,
],
],
'innerBlocks' => [],
'innerHTML' => '',
'innerContent' => [],
];
};
return $builders;
}, 10, 2);
De compatibele filters blockstudio/block_tags/renderers en blockstudio/parser/renderers worden na deze hook uitgevoerd en kunnen dezelfde bloknaam overschrijven.
blockstudio/block_tags/tag_aliases
Met dit filter kunt u aangepaste tags met streepjes registreren die verwijzen naar echte bloknamen voordat wordt teruggevallen op ruwe HTML. Dit is handig wanneer een thema een beknopte, projectspecifieke tagset wil bieden en toch standaard-Blockstudio- of kernblokken wil weergeven.
add_filter('blockstudio/block_tags/tag_aliases', function($aliases) {
$aliases['theme-button'] = 'bsui/button';
$aliases['theme-card'] = 'theme/card';
return $aliases;
});
<theme-button href="/download" label="Download" />
<theme-card title="Fast authoring">
<p>Children are parsed as nested blocks.</p>
</theme-card>
blockstudio/block_tags/prefixes
Met dit filter kunt u afkortingen met voorvoegsels koppelen aan een of meer bloknaamruimten. Elke sleutel is een voorvoegsel in kleine letters, zonder streepjes. Elke waarde kan een naamruimtestring of een geordende lijst met naamruimten zijn.
add_filter('blockstudio/block_tags/prefixes', function($prefixes) {
$prefixes['theme'] = ['theme-components', 'bsui'];
return $prefixes;
});
<theme-card title="Homepage" />
<theme-button label="Get started" />
<theme-ui-feature-matrix />
<theme-card> verwijst naar theme-components/card. <theme-button> probeert eerst theme-components/button en valt daarna terug op bsui/button. Expliciete vermeldingen van blockstudio/block_tags/tag_aliases hebben voorrang voor dezelfde tag, en tags met een voorvoegsel die niet kunnen worden opgelost, blijven ongewijzigd.
Voorvoegsels kunnen worden gecombineerd: als een tag met voorvoegsel niet rechtstreeks kan worden opgelost en de slug zelf een geregistreerde tag met voorvoegsel is, wordt de oplossing recursief gezocht. Met theme => ['theme-components'] en ui => ['bsui'] valt <theme-ui-input> terug op het voorvoegsel ui en wordt bsui/input opgelost. Geregistreerde tags met voorvoegsels en aliastags worden ook weergegeven in de uitvoer van bloktemplates, niet alleen in pagina-inhoud.
Instellingen
pad
Met dit filter kunt u het pad van het bestand blockstudio.json aanpassen. Standaard staat dit bestand in blockstudio.json van het momenteel actieve thema.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Met dit filter kunt u de editor inschakelen voor specifieke gebruikers-ID’s.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Met dit filter kunt u de editor inschakelen voor specifieke gebruikersrollen.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Met dit filter kunt u het laden van assets in de frontend en editor in- of uitschakelen.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Met dit filter kunt u het verwijderen van de kernstijlen voor blokken van WordPress en de reset van de editorindeling in- of uitschakelen.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Met dit filter kunt u bepalen voor welke berichttypen bewerken op volledige breedte wordt gebruikt.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Met dit filter kunt u het verkleinen van CSS in- of uitschakelen.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Met dit filter kunt u het verkleinen van JS in- of uitschakelen.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Met dit filter kunt u de verwerking van SCSS in .css-bestanden in- of uitschakelen.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Met dit filter kunt u de verwerking van .scss-bestanden naar CSS in- of uitschakelen.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Met dit filter kunt u bepalen waar gecompileerde blokassets worden opgeslagen.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Bepaalt hoeveel bytes aan externe CSS-blokgegevens per pagina worden ingesloten.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Met dit filter kunt u alle op bestanden gebaseerde runtime- en editorassetcaches van Blockstudio in- of uitschakelen.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Met dit filter kunt u de cachemap op basis van bestanden van Blockstudio wijzigen.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Met dit filter kunt u bepalen hoelang een niet meer gebruikte cachenamespace wordt bewaard voordat deze wordt opgeschoond.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Met dit filter kunt u zien of de commit-hook PHPStan van Blockstudio is ingeschakeld.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Met dit filter kunt u Content Sync in- of uitschakelen.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Met dit filter kunt u de eigenaarnamespace voor Content Sync instellen.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Met dit filter kunt u de bestandsmap voor Content Sync instellen.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Met dit filter kunt u berichten beheren die door Page Sync worden beheerd, door ze op te nemen of uit te sluiten.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Met dit filter kunt u de afhandeling van auteurs door Content Sync configureren.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Met dit filter kunt u de toegestane lijst met berichttypen voor Content Sync configureren.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Met dit filter kunt u de toegestane lijst met taxonomieën voor Content Sync configureren.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Met dit filter kunt u de media-afhandeling van Content Sync configureren.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Met dit filter kunt u Tailwind in- of uitschakelen.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Met dit filter kunt u een aangepaste configuratie voor Tailwind CSS toevoegen.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Met dit filter kunt u kiezen voor inline- of gekoppelde uitvoer van Tailwind CSS.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Met dit filter kunt u gebundelde componenten van UI in- of uitschakelen.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Met dit filter kunt u het opmaken van code bij het opslaan in- of uitschakelen.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Met dit filter kunt u extra assets in de editor laden.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Met dit filter kunt u extra markup aan het einde van de editor toevoegen.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Met dit filter kunt u voorkomen dat blokken in de blokeditor worden geladen.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Met dit filter kunt u editorfuncties van Blockstudio inschakelen, zoals rustigere focusstijlen en omlijningen bij aanwijzen en selecteren.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Met dit filter kunt u stylesheets toevoegen waarvan de klassen beschikbaar zijn in het klassenveld.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Met dit filter kunt u stylesheets toevoegen waarvan de variabelen van CSS beschikbaar zijn voor automatisch aanvullen in het codeveld.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Met dit filter kunt u bepalen welke bloknamen zijn toegestaan in de invoeger.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Met dit filter kunt u bloknamen uit de invoeger verwijderen.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Met dit filter kunt u de assets van de blokmap van WordPress in- of uitschakelen in de editor.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Met dit filter kunt u bepalen welke slugs van blokcategorieën beschikbaar blijven.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Met dit filter kunt u slugs van blokcategorieën uit de invoeger verwijderen.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Met dit filter kunt u labels van blokcategorieën hernoemen op basis van slug.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Met dit filter kunt u de volgorde van slugs van blokcategorieën in de invoeger bepalen.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Met dit filter kunt u door PHP geregistreerde blokstijlen ongedaan maken op basis van bloknaam.
add_filter('blockstudio/settings/block_editor/blocks/styles/deny', function() {
return [
'my-theme/card' => ['outline'],
'my-theme/media' => ['framed']
];
});
block_editor/blocks/legacy_widgets/hide
Met dit filter kunt u extra verouderde widgets verbergen voor het verouderde widgetblok.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Met dit filter kunt u kernpatronen van WordPress in- of uitschakelen.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Met dit filter kunt u externe patronen uit de patroondirectory van WordPress in- of uitschakelen.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Met dit filter kunt u blokpatronen die door het thema worden geleverd in- of uitschakelen.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Met dit filter kunt u bestandspatronen van Blockstudio in- of uitschakelen.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Met dit filter kunt u bepalen welke slugs van patrooncategorieën beschikbaar blijven.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Met dit filter kunt u slugs van patrooncategorieën uit de patrooninvoeger verwijderen.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Met dit filter kunt u labels van patrooncategorieën hernoemen op basis van slug.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Met dit filter kunt u de volgorde van slugs van patrooncategorieën in de invoeger bepalen.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Met dit filter kunt u de mediacategorie van Openverse in de mediainvoeger van de blokeditor in- of uitschakelen.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Met dit filter kunt u bepalen welke namen van afbeeldingsformaten beschikbaar blijven in de mediabediening van de editor.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Met dit filter kunt u namen van afbeeldingsformaten verwijderen uit de mediabediening van de editor.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Met dit filter kunt u het genereren van contextbestanden voor integratie met LLM-tools in- of uitschakelen. Als dit is ingeschakeld, bundelt het contextbestand actuele blokgegevens, instellingen van Blockstudio voor de huidige installatie, alle relevante schema’s en de documentatie van Blockstudio in één bron voor gebruik met AI-ontwikkelingstools.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Met dit filter kunt u het weergeven van bloktags op paginaniveau in- of uitschakelen.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Met dit filter kunt u afkortingen registreren die voorvoegsels aan naamruimten koppelen voor bloktags.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Met dit filter kunt u de elementgrijper in- of uitschakelen.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Met dit filter kunt u de prestatieprofiler in- of uitschakelen.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Met dit filter kunt u het canvas in- of uitschakelen.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Met dit filter kunt u de beheerbalk van WordPress op het canvas tonen of verbergen.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Filtert het label van elke sleutel die wp bs wpml config wegschrijft. Zie De labels wijzigen voor de contextarray.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Canvas
blockstudio/canvas/inventory
Dit filter past de inventaris aan die Canvas voor een selectie rapporteert. De callback ontvangt het DTO van de inventaris, de oorspronkelijke selectie en de opties waarmee deze is aangeroepen.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Dit filter past de weergegeven documenten aan die Canvas retourneert, met dezelfde drie argumenten als het inventarisfilter.
blockstudio/canvas/item_loaded
Deze actie wordt uitgevoerd voor elk inventarisrecord wanneer het wordt geladen. De actie ontvangt het inventaristype, de canonieke record-ID en het genormaliseerde record.
blockstudio/canvas/source_compiled
Deze actie wordt uitgevoerd nadat een bronbestand voor Canvas is gecompileerd. De actie ontvangt het geselecteerde bronpad en het canonieke bronrecord.
Gebundelde UI
blockstudio/ui/directories
Dit filter past de mappen aan die worden gescand op gebundelde componenten van UI.
blockstudio/ui/inventory
Dit filter past de openbare familie-inventaris van UI aan.
blockstudio/ui/examples
Dit filter past de voorbeeldrecords van UI aan en ontvangt de voorbeelden en de openbare UI-inventaris waaruit ze zijn afgeleid.
Topologie
blockstudio/blocks/topology_refreshed
Deze actie wordt uitgevoerd nadat de bloktopologie opnieuw is opgebouwd.
blockstudio/pages/topology_refreshed
Deze actie wordt uitgevoerd nadat de paginatopologie opnieuw is opgebouwd.
blockstudio/pages/layout_error
Deze actie wordt uitgevoerd wanneer een pagina-indeling niet kan worden weergegeven, in plaats van stilzwijgend te falen.
Runtime
blockstudio/runtime/initialized
Deze actie wordt uitgevoerd zodra de configuratie van de runtime is bepaald.
blockstudio/runtime/changed
Deze actie wordt uitgevoerd wanneer de vastgestelde runtime-identiteit verandert, waardoor cachenamespaces en de statische prerenderstatus worden verplaatst.
blockstudio/performance/default_config
Dit filter past de standaardwaarden voor prestaties aan voordat de eigen waarden van een project in blockstudio.json worden opgenomen.
Inhoud
blockstudio/content/orphan_action
Dit filter bepaalt wat content sync doet met een record waarvoor geen bron meer bestaat.
Bootstrap
blockstudio/url
Dit filter wijzigt de openbare URL die wordt gebruikt voor de editor- en beheerassets van Blockstudio. Integraties van Composer moeten deze registreren voordat het autoload-bestand van Blockstudio wordt geladen. Het tweede argument is de fysieke pakketmap.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Runtimecache
blockstudio/cache/dir
Dit filter ontvangt de vastgestelde basiscachemap voordat een runtime-, editorasset- of andere cachescope wordt toegevoegd.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Dit filter voegt een serialiseerbare runtimevariant toe aan cache-identiteiten. Gebruik dit wanneer dezelfde detectiebron verschillende logische inventarissen kan selecteren.
add_filter('blockstudio/cache/context', function($context, string $scope) {
return [
'preview' => get_query_var('preview_id'),
'site' => get_current_blog_id(),
];
}, 10, 2);
blockstudio/cache/site_key
Dit filter wijzigt de identiteitsgegevens van de netwerk-/blogmap voor hosts met een eigen tenantgrens. De geretourneerde waarde wordt opgeschoond voordat deze wordt gebruikt.
add_filter(
'blockstudio/cache/site_key',
function(string $key, int $networkId, int $blogId) {
return sprintf('tenant-%d-%d', $networkId, $blogId);
},
10,
3
);
blockstudio/runtime/identity
Dit filter voegt hostgegevens toe die van invloed zijn op elk object in een runtimescope. Vingerafdrukken van itembronnen moeten in plaats daarvan als expliciete afhankelijkheden worden doorgegeven door het verantwoordelijke API.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Filtert het aantal seconden dat een gevalideerde momentopname van bestandsbewaking kan worden hergebruikt zonder opnieuw het bestandssysteem te controleren. De standaardwaarde is 0 in lokale en ontwikkelomgevingen en 20 elders.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Filtert hoelang een verzoek, in milliseconden, wacht totdat een gelijktijdige builder de runtimecache publiceert of een update van de gevulde keuzes voltooit, voordat het verzoek wordt afgezwakt. De standaardwaarde is 5000 voor structurele heropbouw en 4000 voor updates van keuzes.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Filtert hoeveel seconden een reeks inhouds-, term-, gebruikers- of metagegevenswijzigingen wordt samengevoegd tot één update van de gevulde keuzes. De eerste wijziging na een rustige periode wordt meteen verwerkt; de laatste wijziging van een reeks is zichtbaar zodra de periode is verstreken. De standaardwaarde is 30. Retourneer 0 om elke wijziging meteen te verwerken.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Filtert metadatatoetsen waarvan schrijfbewerkingen gevulde keuzes nooit vernieuwen. Standaard zijn dit de toetsen die WordPress wegschrijft voor bewerkings- en aanmeldingsregistratie: _edit_lock, vernieuwd door de editor en Heartbeat zolang een bericht geopend is, _edit_last, weggeschreven bij het opslaan van een bericht dat toch al wordt vernieuwd, en session_tokens, weggeschreven bij aan- en afmelden. Voeg toetsen toe die vaak veranderen, maar nooit invloed hebben op een populate-query.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Filtert hoeveel gepubliceerde payloads elke runtimecachescope bewaart.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Filtert of een cachepayload gecomprimeerde geserialiseerde gegevens gebruikt in plaats van een gewone PHP-array. Standaard gebruiken alleen payloads tot 1 MiB de gewone indeling, en alleen wanneer actief gedeeld OPcache-geheugen de bestemming kan cachen. Andere processen, uitgesloten bestanden en grotere payloads gebruiken compressie.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Als u false teruggeeft, wordt ook de groottelimiet opgeheven. Dit kan helpen wanneer WP-CLI zonder opcache.enable_cli bestanden opwarmt voor webworkers met OPcache, maar elke lezer zonder OPcache moet de gegenereerde array parseren. Gebruik compressie voor grote gedeelde payloads, tenzij de extra geheugenkosten aanvaardbaar zijn. Zie cachepayloadindelingen voor de standaardbeveiligingen.
blockstudio/cache/protected_paths
Cachepaden die door opschoning van de bewaartermijn nooit mogen worden verwijderd. Blockstudio vult deze met elk bestand waarnaar de geïnstalleerde kaart voor vroege serververwerking verwijst.
add_filter('blockstudio/cache/protected_paths', function(array $paths, string $scope, string $directory) {
if ('static-prerender' === $scope) {
$paths[] = $directory . '/pinned.html';
}
return $paths;
}, 10, 3);
blockstudio/cache/outcome
Deze actie rapporteert een gedeelde cachescope en een resultaat, zoals hit, build, miss-stale, stale-last-good of write-failure.
add_action('blockstudio/cache/outcome', function(string $scope, string $reason) {
my_metrics()->increment("blockstudio.cache.{$scope}.{$reason}");
}, 10, 2);
blockstudio/static_prerender/request_bypass
Dit filter ontvangt de uiteindelijke beslissing over anonieme veiligheid en de server- en cookie-invoer. Als true wordt geretourneerd, worden statische serververwerking en generatie altijd overgeslagen.
add_filter(
'blockstudio/static_prerender/request_bypass',
function(bool $bypass, array $server, array $cookies) {
return $bypass || isset($cookies['commerce_session']);
},
10,
3
);
blockstudio/static_prerender/public_urls
Dit filter levert de volledige openbare URL-inventaris die wordt gebruikt door de geplande opwarmer en expliciete grafiektools, of past deze aan.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Wat het filter retourneert, is niet de uiteindelijke inventaris. Het resultaat wordt gecontroleerd op cachebaarheid; alles wat overeenkomt met een geconfigureerd dynamisch pad wordt verwijderd, evenals alles wat standaard wordt overgeslagen: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, elk pad met /feed/ en zoekresultaten onder het zoekbasispad op het startpad van de site (standaard /search/). Een URL die u toevoegt, kan dus zonder waarschuwing worden verwijderd. Ontbreekt een verwachte route in de opgebouwde inventaris, controleer dan eerst of deze aan die regels voldoet voordat u ervan uitgaat dat het filter niet is uitgevoerd.
blockstudio/static_prerender/render_internal
Dit filter implementeert het optionele batchtransport binnen hetzelfde proces. Retourneer een genormaliseerde resultaatarray of laat de waarde ongewijzigd, zodat de renderer de geconfigureerde fallback van HTTP gebruikt. Het resultaat bevat html en eventueel status, dependencies, virtualHashes en headers; de headers die in performance.staticPrerender.replayHeaders worden genoemd, worden bij het document opgeslagen.
add_filter(
'blockstudio/static_prerender/render_internal',
function($result, string $url, array $options) {
return my_static_renderer()->render($url, $options);
},
10,
3
);
blockstudio/static_prerender/cacheable_html
Dit filter neemt de uiteindelijke beslissing nadat Blockstudio heeft gecontroleerd of de uitvoer een volledig HTML-document is zonder de no-cache-markering en of de waargenomen responsstatus succesvol is. Het derde argument is de waargenomen status, of null als er geen status is opgegeven.
add_filter('blockstudio/static_prerender/cacheable_html', function(bool $cacheable, string $html, ?int $status) {
return $cacheable && !str_contains($html, 'data-personalized');
}, 10, 3);
blockstudio/static_prerender/outcome
Deze actie rapporteert resultaten van statische prerendering, waaronder treffers, missers, schrijfbewerkingen, graafschrijfbewerkingen, verouderde items en fouten.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Filtert het maximumaantal gecompileerde vermeldingen van Tailwind CSS. De standaardwaarde is 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Filtert de maximale leeftijd in seconden van gecompileerde vermeldingen van Tailwind CSS. De standaardwaarde is 30 dagen en het minimum is één uur.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Beheeromgeving
ingeschakeld
Met dit filter kunt u de beheerpagina van Blockstudio onder Gereedschap > Blockstudio in- of uitschakelen.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Assets
editor/canvas/body_class
Wanneer de assetreset is ingeschakeld, past dit filter de opgeschoonde bodyklassen van de frontend aan die naar het canvas van de blokeditor worden gekopieerd.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
inschakelen
Met dit filter kunt u de assetverwerking en het laden van een specifiek assettype uitschakelen.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
uitschakelen
Met dit filter kunt u specifieke assets op basis van hun ID uitschakelen. Assets met een ID in de geretourneerde array worden niet weergegeven op de frontend.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Met dit filter kunt u extra paden toevoegen aan de statement @import van de compiler SCSS.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Met dit filter kunt u gedeelde code van Sass toevoegen voordat elk bestand van SCSS wordt gecompileerd.
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
return '@import "functions";' . "\n"
. '@import "variables";' . "\n"
. '@import "mixins";';
}, 10, 3);
process/css/content
Met dit filter kunt u de inhoud van het bestand CSS aanpassen voordat het wordt gecompileerd.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Met dit filter kunt u de inhoud van het bestand JS aanpassen voordat het wordt gecompileerd.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Buffer
ingeschakeld
Blockstudio buffert de frontendrespons, zodat stijlen en script-tags voor blokken die in de body worden weergegeven, naar de head en footer kunnen worden verplaatst en zodat Tailwind het volledige document kan scannen. Bufferen betekent dat het volledige document bij elk frontendverzoek wordt vastgehouden en gescand. Een site die geen Blockstudio-blokassets weergeeft en geen Tailwind gebruikt, kan false retourneren om beide over te slaan.
add_filter('blockstudio/buffer/enabled', '__return_false');
Buffering is ook uitgeschakeld in de beheeromgeving en in de Customizer-voorvertoning. Roep bs_is_buffering() aan vanuit wp_enqueue_scripts of later om te bepalen of de huidige response wordt gebufferd. De functie geeft false terug voordat de beslissing bij template_redirect wordt genomen.
uitvoer
Dit filter ontvangt het volledige gebufferde document van HTML voordat het wordt verzonden. Het verplaatsen van assets door Blockstudio gebeurt op prioriteit 1000000 en de compilatie van Tailwind op 999999. Voer het dus eerder uit om het document ervoor te zien, of later om de uiteindelijke uitvoer te zien.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Weergave
afhankelijkheden
Dit filter rapporteert de geselecteerde template- en assetafhankelijkheden telkens wanneer Blockstudio een blok weergeeft. Dit is handig voor statische exporteurs en andere afhankelijkheidverzamelaars binnen het proces.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
globaal
Met dit filter kunt u de uitvoer van de pagina aanpassen voordat deze wordt weergegeven.
add_filter('blockstudio/render', function($content) {
return $content;
});
head
Met dit filter kunt u de uitvoer van de <head>-tag aanpassen voordat deze wordt gerenderd. Het wordt alleen uitgevoerd wanneer Blockstudio de response buffert; zie bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
footer
Met dit filter kunt u de uitvoer van </body> aanpassen voordat deze wordt weergegeven.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Foutafhandeling
error/logged
Actie die wordt uitgevoerd nadat een fout is vastgelegd. Gebruik deze om fouten naar externe logservices te sturen.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Actie die wordt uitgevoerd nadat een uitzondering is afgehandeld.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Database
Alle databasehooks ontvangen één array met $params.
db/before_create
Actie die wordt uitgevoerd voordat een record wordt aangemaakt.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Actie die wordt uitgevoerd nadat een record is aangemaakt.
add_action('blockstudio/db/after_create', function($params) {
// $params: block, schema, record, storage
wp_mail($params['record']['email'], 'Welcome!', 'Thanks for subscribing.');
});
db/before_update
Actie die wordt uitgevoerd voordat een record wordt bijgewerkt.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Actie die wordt uitgevoerd nadat een record is bijgewerkt.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Actie die wordt uitgevoerd voordat een record wordt verwijderd.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Actie die wordt uitgevoerd nadat een record is verwijderd.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Alle hooks van RPC ontvangen één array met $params.
rpc/before_call
Actie die wordt uitgevoerd voordat een functie van RPC wordt aangeroepen.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Actie die wordt uitgevoerd nadat een functie van RPC is aangeroepen.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});