Hoppa till innehåll

PHP Hooks

Nedan finns en lista över alla tillgängliga PHP-hooks som kan användas för att utöka eller anpassa tilläggets funktionalitet.

Sökväg

Med det här filtret kan du ändra sökvägen till blockmappen. Som standard ligger den blockstudio i det aktiva temat. Du kan också skapa en ny instans med flera källkataloger.

PHP
add_filter('blockstudio/path', function() {
  $path = get_stylesheet_directory() . '/blocks';
  return $path;
});

Initiering

global

Den här åtgärden körs när tillägget har registrerat alla block.

PHP
add_action('blockstudio/init', function($blocks) {
  // All blocks have been registered
});

instans

Den här åtgärden körs när tillägget har registrerat alla block i en viss instans. Segmentet $instance är instansens sökväg i förhållande till wp-content.

PHP
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
  // All blocks of this instance have been registered
});

global/before

Den här åtgärden körs innan tillägget har registrerat alla block.

PHP
add_action('blockstudio/init/before', function() {
  // Before blocks are registered
});

global/before/$instance

Den här åtgärden körs innan tillägget har registrerat alla block i en viss instans.

PHP
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
  // Before blocks of this instance are registered
});

Block

rendera

Med det här filtret kan du ändra ett blocks utdata innan det renderas.

PHP
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
  // Modify the block content
  return $content;
}, 10, 3);

metadata

Med det här filtret kan du ändra data i filen block.json innan den registreras.

PHP
add_filter('blockstudio/blocks/meta', function($meta, $block) {
  if (str_starts_with($block['name'], 'marketing')) {
    $meta['icon'] = 'megaphone';
  }
  return $meta;
}, 10, 2);

Koden ovan ändrar ikonen för alla block vars namn börjar med marketing.

villkor

Med det här filtret kan du lägga till anpassade villkor som kan användas i block. Varje villkorstyp motsvarar ett värde som redigeraren jämför med villkorets value. Se Anpassade villkor.

PHP
add_filter('blockstudio/blocks/conditions', function($conditions) {
  $conditions['myCustomCondition'] = 'expected';
  return $conditions;
});

attribut

Med det här filtret ändrar du en fältdefinition innan blocket registreras. Den filtrerade definitionen styr redigerarens kontroll och valideringen av värden vid rendering. Mer information finns i Filtrering.

PHP
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
  // Modify this field definition before registration.
  return $attribute;
}, 10, 2);

attributes/render

Det här filtret justerar värdet för ett fält innan det skickas till blockmallen. Det körs en gång per fält och tar emot tre argument: $value (det lösta värdet), $key (fältets nyckel, som används i $a) och $block (blockets dataarray, som mallar får som $block eller $b). Registrera det med tre accepterade argument. Se Filtrering för mer information.

PHP
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

Ett fält av typen files returnerar varje bild med en sizes-array som innehåller URL, bredd och höjd för full och för varje registrerad bildstorlek, till exempel $image['sizes']['thumbnail'] och $image['sizes']['thumbnail-width']. Varje storlek innebär ett wp_get_attachment_image_src()-anrop per bild, så filtren tillämpas fortfarande. Mallar som aldrig läser sizes kan ta bort eller förkorta listan.

PHP
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 är listan med storleksnamn, med full först (tom om inga mellanstorlekar har registrerats). $id är bilagans ID och $size den storlek som begärs för värdets url. Filtret ändrar arrayen sizes för varje filvärde i förfrågan. Utan filtret förblir arrayen oförändrad.

Returnera storleksnamn som strängar. Ogiltiga poster ignoreras, dubbletter löses en gång och ett returvärde som inte är en array gör att storlekarna hoppas över. De begärda url och andra bilageegenskaperna förblir oförändrade. Den här hooken körs inte för ett files-fält med returnFormat: "url", som inte bygger någon storlekskarta.

attributes/validate

Justera resultat från uttryckliga anrop till bs_validate_block(), till exempel när ett anpassat renderingsfilter löser lagrade referenser. Detta aktiverar inte automatisk validering vid sparning eller rendering.

PHP
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
  return $findings;
}, 10, 3);

Returnera en lista med resultat. Filtret anropas inte när blocket saknar fält av typen Blockstudio eller matchande tillägg (null).

attributes/schema

Justera JSON-schemat som returneras av bs_block_schema(), till exempel när ett anpassat renderingsfilter löser lagrade referenser.

PHP
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
  return $schema;
}, 10, 2);

Returnera schemaarrayen. Filtret anropas inte när blocket saknar fält av typen Blockstudio eller matchande utökningar (null).

attributes/populate

Med det här filtret kan du lägga till anpassade data i alternativen för ett checkbox-, select– eller radio-fält. Mer information finns i Fylla i alternativ.

Filtret får ett argument: en array med alla anpassade datamängder, där nyckeln är namnet som används i "populate": {"type": "custom", "custom": "myCustomOptions"}.

PHP
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

Med det här filtret kan du ändra utdata från innehållet i useBlockProps.

Alla komponentfilter (use_block_props, inner_blocks och rich_text) tar emot blocket som sitt sista argument. $block är den WP_Block_Type som registrerats för blocket som renderas, så $block->name är blocknamnet, till exempel acme/hero.

$props är en sträng med HTML-attribut, inte en array. På frontend är det resultatet av get_block_wrapper_attributes(), till exempel class="wp-block-acme-hero my-class". I redigeraren är det elementets class-attribut. Returnera en sträng. I redigeraren tillämpas endast class-attributet från den returnerade strängen.

PHP
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

Med det här filtret kan du ändra utdata från innehållet i <InnerBlocks />.

PHP
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

Med det här filtret kan du ta bort omslaget <InnerBlocks /> från frontend.

PHP
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
  return false; // Remove wrapper
}, 10, 2);

components/rich_text/render

Med det här filtret kan du justera utdata från innehållet i <RichText />. Det tar emot attributets värde och blocket.

PHP
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
  return wp_kses_post($content);
}, 10, 2);

Blocktaggar

blockstudio/block_tags/builders

Det här filtret registrerar blockmatrisbyggare som används av blocktaggar och anpassade block som valts via blockstudio/parser/element_mapping. Varje byggare får parsade attribut och rått inre innehåll.

PHP
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 kompatibla filtren blockstudio/block_tags/renderers och blockstudio/parser/renderers körs efter den här hooken och kan åsidosätta samma blocknamn.

blockstudio/block_tags/tag_aliases

Med det här filtret kan du registrera anpassade bindestrecksavgränsade författartaggar som löses till riktiga blocknamn före reservlösningen med råa HTML. Det är användbart när ett tema vill erbjuda en kortfattad, projektspecifik tagguppsättning och ändå rendera standard-Blockstudio- eller kärnblock.

PHP
add_filter('blockstudio/block_tags/tag_aliases', function($aliases) {
  $aliases['theme-button'] = 'bsui/button';
  $aliases['theme-card'] = 'theme/card';

  return $aliases;
});
HTML
<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

Med det här filtret kan du mappa prefixförkortningar till ett eller flera blocknamnrymder. Varje nyckel är ett prefix med gemener och utan bindestreck. Varje värde kan vara en namnrymdssträng eller en ordnad lista med namnrymder.

PHP
add_filter('blockstudio/block_tags/prefixes', function($prefixes) {
  $prefixes['theme'] = ['theme-components', 'bsui'];

  return $prefixes;
});
HTML
<theme-card title="Homepage" />
<theme-button label="Get started" />
<theme-ui-feature-matrix />

<theme-card> löses till theme-components/card. <theme-button> provar först theme-components/button och faller sedan tillbaka på bsui/button. Explicita poster för blockstudio/block_tags/tag_aliases har företräde för samma tagg, och prefixförsedda taggar som inte kan lösas lämnas oförändrade.

Prefix kan kombineras: om en prefixförsedd tagg inte löses direkt och dess slug själv är en registrerad prefixstagg, fortsätter lösningen rekursivt. Med theme => ['theme-components'] och ui => ['bsui'] faller <theme-ui-input> igenom till prefixet ui och löses till bsui/input. Registrerade prefix- och aliastaggar renderas också i blockmallens utdata, inte bara i sidinnehåll.

Inställningar

sökväg

Med det här filtret kan du justera sökvägen till filen blockstudio.json. Som standard är den blockstudio.json i det för närvarande aktiva temat.

PHP
add_filter('blockstudio/settings/path', function() {
  return get_stylesheet_directory() . '/config/blockstudio.json';
});

users/ids

Med det här filtret kan du aktivera redigeraren för specifika användar-ID:n.

PHP
add_filter('blockstudio/settings/users/ids', function() {
  return [1];
});

users/roles

Med det här filtret kan du aktivera redigeraren för specifika användarroller.

PHP
add_filter('blockstudio/settings/users/roles', function() {
  return ['administrator', 'editor'];
});

assets/enqueue

Med det här filtret kan du aktivera eller inaktivera köandet av resurser i frontend och redigeraren.

PHP
add_filter('blockstudio/settings/assets/enqueue', function() {
  return false;
});

assets/reset/enabled

Med det här filtret kan du aktivera eller inaktivera borttagningen av kärnblockens stilar i WordPress och återställningen av redigerarens hjälplayout.

PHP
add_filter('blockstudio/settings/assets/reset/enabled', function() {
  return true;
});

assets/reset/full_width

Med det här filtret kan du styra vilka inläggstyper som använder redigering i full bredd.

PHP
add_filter('blockstudio/settings/assets/reset/full_width', function() {
  return ['page'];
});

assets/minify/css

Med det här filtret kan du aktivera eller inaktivera minifiering av CSS.

PHP
add_filter('blockstudio/settings/assets/minify/css', function() {
  return true;
});

assets/minify/js

Med det här filtret kan du aktivera eller inaktivera minifiering av JS.

PHP
add_filter('blockstudio/settings/assets/minify/js', function() {
  return true;
});

assets/process/scss

Med det här filtret kan du aktivera eller inaktivera bearbetning av SCSS i .css-filer.

PHP
add_filter('blockstudio/settings/assets/process/scss', function() {
  return true;
});

assets/process/scss_files

Med det här filtret kan du aktivera eller inaktivera bearbetning av .scss-filer till CSS.

PHP
add_filter('blockstudio/settings/assets/process/scss_files', function() {
  return true;
});

assets/output

Med det här filtret kan du styra var kompilerade blockresurser skrivs.

PHP
add_filter('blockstudio/settings/assets/output', function() {
  return 'cache';
});

assets/inline_limit

Filtrerar hur många byte extern block-CSS som bäddas in per sida.

PHP
add_filter('blockstudio/settings/assets/inline_limit', function() {
  return 40000;
});

cache/enabled

Med det här filtret kan du aktivera eller inaktivera alla filbaserade körnings- och redigeringsresurscachar i Blockstudio.

PHP
add_filter('blockstudio/settings/cache/enabled', function() {
  return false;
});

cache/path

Med det här filtret kan du ändra den filbaserade cachekatalogen för Blockstudio.

PHP
add_filter('blockstudio/settings/cache/path', function() {
  return 'cache/blockstudio';
});

cache/namespace_grace

Med det här filtret kan du ändra hur länge ett avvecklat cacheutrymme sparas innan det rensas.

PHP
add_filter('blockstudio/settings/cache/namespace_grace', function() {
  return 777600;
});

githooks/commit

Med det här filtret visas om commit-hooken PHPStan som ägs av Blockstudio är aktiverad.

PHP
add_filter('blockstudio/settings/githooks/commit', function() {
  return true;
});

content/enabled

Med det här filtret kan du aktivera eller inaktivera Content Sync.

PHP
add_filter('blockstudio/settings/content/enabled', function() {
  return true;
});

content/id

Med det här filtret kan du ange ägarnamnrymden för Content Sync.

PHP
add_filter('blockstudio/settings/content/id', function() {
  return 'docs';
});

content/path

Med det här filtret kan du ange filkatalogen för Content Sync.

PHP
add_filter('blockstudio/settings/content/path', function() {
  return 'content';
});

content/include_page_sync_managed

Med det här filtret kan du inkludera eller exkludera inlägg som hanteras av Page Sync.

PHP
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
  return false;
});

content/authors

Med det här filtret kan du konfigurera hanteringen av författare i Content Sync.

PHP
add_filter('blockstudio/settings/content/authors', function() {
  return 'ignore';
});

content/post_types

Med det här filtret kan du konfigurera tillåtelselistor för inläggstyper i Content Sync.

PHP
add_filter('blockstudio/settings/content/post_types', function() {
  return ['team_member'];
});

content/taxonomies

Med det här filtret kan du konfigurera tillåtelselistor för taxonomier i Content Sync.

PHP
add_filter('blockstudio/settings/content/taxonomies', function() {
  return ['category', 'post_tag'];
});

content/media

Med det här filtret kan du konfigurera mediehanteringen i Content Sync.

PHP
add_filter('blockstudio/settings/content/media', function() {
  return 'manifest';
});

tailwind/enabled

Med det här filtret kan du aktivera eller inaktivera Tailwind.

PHP
add_filter('blockstudio/settings/tailwind/enabled', function() {
  return true;
});

tailwind/config

Med det här filtret kan du lägga till en anpassad konfiguration för Tailwind CSS.

PHP
add_filter('blockstudio/settings/tailwind/config', function() {
  return '@theme { --color-primary: pink; }';
});

tailwind/output

Med det här filtret kan du välja inline- eller länkad utdata för Tailwind CSS.

PHP
add_filter('blockstudio/settings/tailwind/output', function() {
  return 'link';
});

ui/enabled

Med det här filtret kan du aktivera eller inaktivera de medföljande komponenterna för UI.

PHP
add_filter('blockstudio/settings/ui/enabled', function() {
  return true;
});

editor/format_on_save

Med det här filtret kan du aktivera eller inaktivera kodformatering när du sparar.

PHP
add_filter('blockstudio/settings/editor/format_on_save', function() {
  return true;
});

editor/assets

Med det här filtret kan du köa ytterligare resurser i redigeraren.

PHP
add_filter('blockstudio/settings/editor/assets', function() {
  return ['my-stylesheet', 'another-stylesheet'];
});

editor/markup

Med det här filtret kan du lägga till ytterligare markup i slutet av redigeraren.

PHP
add_filter('blockstudio/settings/editor/markup', function() {
  return '<style>body { background: black; }</style>';
});

block_editor/disable_loading

Med det här filtret kan du inaktivera inläsning av block i Block Editor.

PHP
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
  return true;
});

block_editor/enhance

Med det här filtret kan du aktivera redigerarfunktioner i Blockstudio, till exempel renare fokusstilar och konturer vid hovring eller markering.

PHP
add_filter('blockstudio/settings/block_editor/enhance', function() {
  return true;
});

block_editor/css_classes

Med det här filtret kan du lägga till formatmallar vars klasser ska gå att välja i klassfältet.

PHP
add_filter('blockstudio/settings/block_editor/css_classes', function() {
  return ['my-stylesheet', 'another-stylesheet'];
});

block_editor/css_variables

Med det här filtret kan du lägga till formatmallar vars variabler i CSS ska vara tillgängliga för autokomplettering i kodfältet.

PHP
add_filter('blockstudio/settings/block_editor/css_variables', function() {
  return ['my-stylesheet', 'another-stylesheet'];
});

block_editor/blocks/allow

Med det här filtret kan du styra vilka blocknamn som är tillåtna i infogaren.

PHP
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
  return ['core/*', 'acf/*', 'my-theme/*'];
});

block_editor/blocks/deny

Med det här filtret kan du ta bort blocknamn från infogaren.

PHP
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
  return ['core/embed', 'core/freeform'];
});

block_editor/blocks/directory

Med det här filtret kan du aktivera eller inaktivera katalogresurser för block i WordPress i redigeraren.

PHP
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
  return false;
});

block_editor/blocks/categories/allow

Med det här filtret kan du styra vilka sluggar för blockkategorier som förblir tillgängliga.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
  return ['text', 'media', 'design'];
});

block_editor/blocks/categories/deny

Med det här filtret kan du ta bort sluggar för blockkategorier från infogaren.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
  return ['embed'];
});

block_editor/blocks/categories/rename

Med det här filtret kan du byta namn på etiketter för blockkategorier utifrån slug.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
  return [
    'text' => 'Writing',
    'design' => 'Layout'
  ];
});

block_editor/blocks/categories/order

Med det här filtret kan du ordna sluggar för blockkategorier i infogaren.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
  return ['my-theme', 'text', 'media'];
});

block_editor/blocks/styles/deny

Med det här filtret kan du avregistrera blockstilar som registrerats av PHP, utifrån blocknamn.

PHP
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

Med det här filtret kan du dölja ytterligare äldre widgetar i det äldre widgetblocket.

PHP
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
  return ['archives', 'calendar'];
});

block_editor/patterns/core

Med det här filtret kan du aktivera eller inaktivera kärnmönster för block i WordPress.

PHP
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
  return false;
});

block_editor/patterns/remote

Med det här filtret kan du aktivera eller inaktivera fjärrmönster från mönsterkatalogen i WordPress.

PHP
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
  return false;
});

block_editor/patterns/theme

Med det här filtret kan du aktivera eller inaktivera blockmönster från temat.

PHP
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
  return false;
});

block_editor/patterns/blockstudio

Med det här filtret kan du aktivera eller inaktivera filbaserade mönster i Blockstudio.

PHP
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
  return false;
});

block_editor/patterns/categories/allow

Med det här filtret kan du styra vilka sluggar för mönsterkategorier som förblir tillgängliga.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
  return ['featured', 'buttons', 'columns'];
});

block_editor/patterns/categories/deny

Med det här filtret kan du ta bort sluggar för mönsterkategorier från mönsterinfogaren.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
  return ['gallery'];
});

block_editor/patterns/categories/rename

Med det här filtret kan du byta namn på etiketter för mönsterkategorier utifrån slug.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
  return [
    'featured' => 'Featured Layouts'
  ];
});

block_editor/patterns/categories/order

Med det här filtret kan du ordna sluggar för mönsterkategorier i infogaren.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
  return ['featured', 'buttons'];
});

block_editor/media/openverse

Med det här filtret kan du aktivera eller inaktivera mediakategorin Openverse i medieinfogaren i blockredigeraren.

PHP
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
  return false;
});

block_editor/media/image_sizes/allow

Med det här filtret kan du styra vilka bildstorleksnamn som förblir tillgängliga i redigerarens mediekontroller.

PHP
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
  return ['thumbnail', 'large'];
});

block_editor/media/image_sizes/deny

Med det här filtret kan du ta bort bildstorleksnamn från redigerarens mediekontroller.

PHP
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
  return ['medium_large'];
});

ai/enable_context_generation

Med det här filtret kan du aktivera eller inaktivera generering av kontextfiler för integrering med LLM-verktyg. När funktionen är aktiverad samlar kontextfilen aktuella blockdata, inställningarna för Blockstudio i den aktuella installationen, alla relevanta scheman och dokumentationen för Blockstudio i en enda källa som AI-utvecklingsverktyg kan använda.

PHP
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
  return true;
});

block_tags/enabled

Med det här filtret kan du aktivera eller inaktivera rendering av blocktaggar på sidnivå.

PHP
add_filter('blockstudio/settings/block_tags/enabled', function() {
  return true;
});

block_tags/prefixes

Med det här filtret kan du registrera förkortningar som mappar prefix till namnrymder för blocktaggar.

PHP
add_filter('blockstudio/settings/block_tags/prefixes', function() {
  return [
    'theme' => ['theme-components', 'bsui']
  ];
});

dev/grab/enabled

Med det här filtret kan du aktivera eller inaktivera elementgrabbern.

PHP
add_filter('blockstudio/settings/dev/grab/enabled', function() {
  return false;
});

dev/perf

Med det här filtret kan du aktivera eller inaktivera prestandaprofileraren.

PHP
add_filter('blockstudio/settings/dev/perf', function() {
  return false;
});

dev/canvas/enabled

Med det här filtret kan du aktivera eller inaktivera arbetsytan.

PHP
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
  return false;
});

dev/canvas/admin_bar

Med det här filtret kan du visa eller dölja adminfältet WordPress på arbetsytan.

PHP
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
  return true;
});

WPML

blockstudio/wpml/config/label

Filtrerar etiketten för varje nyckel som wp bs wpml config skriver. Se Ändra etiketterna för kontextarrayen.

PHP
add_filter('blockstudio/wpml/config/label', function($label, $context) {
  return str_replace(' (optional)', '', $label);
}, 10, 2);

Arbetsyta

blockstudio/canvas/inventory

Det här filtret justerar den inventering som Canvas rapporterar för ett urval. Återanropet får inventeringsobjektet (DTO), det ursprungliga urvalet och alternativen som det anropades med.

PHP
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
  return $result;
}, 10, 3);

blockstudio/canvas/documents

Det här filtret justerar dokumenten som Canvas returnerar efter rendering, med samma tre argument som inventeringsfiltret.

blockstudio/canvas/item_loaded

Den här åtgärden körs en gång per inventeringspost när den läses in och tar emot inventeringstypen, det kanoniska post-ID:t och den normaliserade posten.

blockstudio/canvas/source_compiled

Den här åtgärden körs efter att en källfil har kompilerats för Canvas och tar emot den valda källsökvägen och den kanoniska källposten.

Medföljande UI

blockstudio/ui/directories

Det här filtret justerar katalogerna som genomsöks efter medföljande komponenter för UI.

blockstudio/ui/inventory

Det här filtret justerar den offentliga familjeinventeringen för UI.

blockstudio/ui/examples

Det här filtret justerar exempelposterna för UI och tar emot exemplen samt den offentliga inventeringen för UI som de hämtades från.

Topologi

blockstudio/blocks/topology_refreshed

Den här åtgärden körs efter att blocktopologin har byggts om.

blockstudio/pages/topology_refreshed

Den här åtgärden körs efter att sidtopologin har byggts om.

blockstudio/pages/layout_error

Den här åtgärden körs när en sidlayout inte kan renderas, i stället för att felet ignoreras tyst.

Körning

blockstudio/runtime/initialized

Den här åtgärden körs när körningsmiljön har löst sin konfiguration.

blockstudio/runtime/changed

Den här åtgärden körs när den lösta identiteten för körningsmiljön ändras, vilket flyttar cacheutrymmen och tillstånd för statisk förhandsrendering.

blockstudio/performance/default_config

Det här filtret justerar prestandans standardvärden innan projektets egna värden i blockstudio.json läggs ovanpå.

Innehåll

blockstudio/content/orphan_action

Det här filtret avgör vad synkronisering av innehåll gör med en post som inte längre har någon källa.

Bootstrap

blockstudio/url

Det här filtret ändrar det offentliga URL som används för Blockstudios redigerar- och adminresurser. Integreringar med Composer måste registrera det innan Blockstudios autoload-fil läses in. Det andra argumentet är den fysiska paketkatalogen.

PHP
add_filter(
  'blockstudio/url',
  function(string $url, string $directory) {
    return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
  },
  10,
  2
);

Körningscache

blockstudio/cache/dir

Det här filtret tar emot den lösta baskatalogen för cachen innan ett scope för körning, redigeringsresurser eller någon annan cache läggs till.

PHP
add_filter('blockstudio/cache/dir', function(string $directory) {
  return WP_CONTENT_DIR . '/cache/blockstudio';
});

blockstudio/cache/context

Det här filtret lägger till en serialiserbar körningsvariant i cacheidentiteter. Använd det när samma upptäcktskälla kan välja olika logiska inventeringar.

PHP
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

Det här filtret ändrar nätverks- eller bloggkatalogens identitet för värdar med en egen hyresgästsgräns. Det returnerade värdet rensas innan det används.

PHP
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

Det här filtret lägger till värdfakta som påverkar varje objekt inom ett körningsscope. Fingeravtryck för objektspecifika källor bör i stället skickas som explicita beroenden av den ansvariga API.

PHP
add_filter(
  'blockstudio/runtime/identity',
  function(array $identity, string $scope) {
    $identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
    return $identity;
  },
  10,
  2
);

blockstudio/cache/watch_debounce

Filtrerar antalet sekunder som en validerad filövervakningsögonblicksbild kan återanvändas utan en ny kontroll av filsystemets status. Standardvärdet är 0 i lokala miljöer och utvecklingsmiljöer och 20 på andra platser.

PHP
add_filter('blockstudio/cache/watch_debounce', function() {
  return 30;
});

blockstudio/cache/build_wait_budget

Filtrerar hur länge, i millisekunder, en begäran väntar på att en samtidig byggprocess ska publicera körningscachen eller uppdaterade valbara alternativ innan den degraderas. Standardvärdet är 5000 för strukturella ombyggnader och 4000 för uppdatering av valbara alternativ.

PHP
add_filter('blockstudio/cache/build_wait_budget', function() {
  return 2000;
});

blockstudio/cache/populate_debounce

Filtrerar hur många sekunder en serie skrivningar av innehåll, termer, användare eller metadata slås ihop till en enda uppdatering av valbara alternativ. Den första skrivningen efter en lugn period uppdateras omedelbart; den sista skrivningen i en serie återspeglas när tidsfönstret har passerat. Standardvärdet är 30. Returnera 0 för att uppdatera vid varje skrivning.

PHP
add_filter('blockstudio/cache/populate_debounce', function() {
  return 120;
});

blockstudio/cache/populate_ignored_meta_keys

Filtrerar metanycklar vars skrivningar aldrig uppdaterar ifyllda val. Som standard är detta nycklarna som WordPress skriver för redigerings- och inloggningshantering: _edit_lock, som uppdateras av redigeraren och Heartbeat medan ett inlägg är öppet, _edit_last, som skrivs i samband med en inläggssparning som redan uppdaterar, och session_tokens, som skrivs vid in- och utloggning. Lägg till nycklar som ändras ofta men aldrig påverkar en populate-fråga.

PHP
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
  $keys[] = '_my_view_counter';
  return $keys;
});

blockstudio/cache/max_files_per_scope

Filtrerar hur många publicerade nyttolaster varje cacheomfång för körning behåller.

PHP
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
  return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);

blockstudio/cache/compress

Filtrerar om en cachepayload använder komprimerade serialiserade data i stället för en vanlig PHP-array. Som standard används det vanliga formatet endast för payloads på upp till 1 MiB, och bara när aktivt delat OPcache-minne kan cacha målet. Andra processer, exkluderade filer och större payloads använder komprimering.

PHP
add_filter('blockstudio/cache/compress', function($compress, $scope) {
  return $scope === 'runtime' ? false : $compress;
}, 10, 2);

Om false returneras åsidosätts även storleksgränsen. Detta kan vara användbart när WP-CLI utan opcache.enable_cli förvärmer filer för webbservrar med OPcache aktiverat, men varje läsare utan OPcache kommer att tolka den genererade arrayen. Behåll komprimering för stora delade payloads om inte den extra minneskostnaden är acceptabel. Se cachepayloadformat för standardskydden.

blockstudio/cache/protected_paths

Rensning av kvarhållna cachevägar får aldrig ta bort dessa. Blockstudio fyller på dem med varje fil som den installerade kartan för tidig leverans hänvisar till.

PHP
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

Den här åtgärden rapporterar ett delat cacheomfång och ett utfall, till exempel hit, build, miss-stale, stale-last-good eller write-failure.

PHP
add_action('blockstudio/cache/outcome', function(string $scope, string $reason) {
  my_metrics()->increment("blockstudio.cache.{$scope}.{$reason}");
}, 10, 2);

blockstudio/static_prerender/request_bypass

Det här filtret tar emot det slutliga beslutet om anonym säkerhet samt indata från servern och cookies. Om true returneras kringgås alltid statisk visning och generering.

PHP
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

Det här filtret tillhandahåller eller justerar den fullständiga offentliga inventering av URL som används av den schemalagda cacheförvärmaren och explicita verktyg för grafer.

PHP
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
  $urls[] = home_url('/custom-route/');
  return array_values(array_unique($urls));
});

Det filtret returnerar är inte den slutliga inventeringen. Resultatet går igenom ett cachebarhetstest som tar bort allt som matchar en konfigurerad dynamisk sökväg och allt som kringgås som standard: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, alla sökvägar som innehåller /feed/ samt sökresultat under sökbasen vid webbplatsens startsökväg (/search/ som standard). En URL som du lägger till kan därför tas bort utan varning. Om en förväntad route saknas i den färdigbyggda inventeringen bör du kontrollera den mot reglerna innan du antar att filtret inte kördes.

blockstudio/static_prerender/render_internal

Det här filtret implementerar den valfria batchtransporten i processen. Returnera en normaliserad resultatarray eller lämna värdet oförändrat så att renderaren använder sin konfigurerade reservlösning för HTTP. Resultatet innehåller html och eventuellt status, dependencies, virtualHashes och headers; headerfälten som anges i performance.staticPrerender.replayHeaders lagras tillsammans med dokumentet.

PHP
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

Den här funktionen fattar det slutliga beslutet efter att Blockstudio har verifierat att utdata är ett komplett HTML-dokument utan no-cache-markören och att den observerade svarstatusen är godkänd. Det tredje argumentet är den observerade statusen eller null om ingen status angavs.

PHP
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

Den här åtgärden rapporterar utfall för statisk förhandsrendering, däribland träffar, missar, skrivningar, grafskrivningar, inaktuella poster och fel.

PHP
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
  my_metrics()->increment("blockstudio.prerender.{$reason}");
});

blockstudio/tailwind/cache_max_files

Filtrerar det högsta antalet kompilerade poster för Tailwind CSS. Standardvärdet är 1000.

PHP
add_filter('blockstudio/tailwind/cache_max_files', function() {
  return 1500;
});

blockstudio/tailwind/cache_max_age

Filtrerar maxåldern, i sekunder, för kompilerade poster för Tailwind CSS. Standardvärdet är 30 dagar och minsta värdet är en timme.

PHP
add_filter('blockstudio/tailwind/cache_max_age', function() {
  return 14 * DAY_IN_SECONDS;
});

Administratör

aktiverad

Med det här filtret kan du aktivera eller inaktivera administratörssidan för Blockstudio under Verktyg > Blockstudio.

PHP
add_filter('blockstudio/admin/enabled', function() {
  return false;
});

Resurser

editor/canvas/body_class

När återställning av resurser är aktiverad justerar det här filtret de rensade body-klasserna från frontend som kopieras till blockredigerarens arbetsyta.

PHP
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
  return array_values(array_diff($classes, ['logged-in']));
});

aktivera

Med det här filtret kan du inaktivera resursbearbetning och köande för en viss resurstyp.

PHP
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
  if ($type === 'css' && $block['name'] === 'my/block') {
    return false;
  }
  return $enable;
}, 10, 3);

inaktivera

Med det här filtret kan du inaktivera specifika resurser utifrån deras ID. Resurser vars ID finns i den returnerade matrisen renderas inte i frontend.

PHP
add_filter('blockstudio/assets/disable', function($disabled) {
  $disabled[] = 'my-block-style';
  return $disabled;
});

process/scss/import_paths

Med det här filtret kan du lägga till sökvägar i satsen @import i kompilatorn SCSS.

PHP
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
  $paths[] = get_stylesheet_directory() . '/scss';
  return $paths;
});

process/scss/prelude

Med det här filtret kan du lägga till gemensam kod för Sass före kompileringen av varje fil med SCSS.

PHP
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

Med det här filtret kan du justera innehållet i filen CSS innan den kompileras.

PHP
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
  return str_replace('old-class', 'new-class', $content);
}, 10, 2);

process/js/content

Med det här filtret kan du justera innehållet i filen JS innan den kompileras.

PHP
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
  return $content;
}, 10, 2);

Buffring

aktiverad

Blockstudio buffrar svaret från frontend så att blockstils- och skripttaggar som renderas i body kan flyttas till head och footer, och så att Tailwind kan genomsöka hela dokumentet. Buffring innebär att hela dokumentet lagras och genomsöks vid varje frontendbegäran. En webbplats som inte renderar några Blockstudio-blockresurser och inte använder Tailwind kan returnera false för att hoppa över båda.

PHP
add_filter('blockstudio/buffer/enabled', '__return_false');

Buffring är också avstängd i admin och i förhandsgranskningen av Customizer. Anropa bs_is_buffering() från wp_enqueue_scripts eller senare för att ta reda på om det aktuella svaret buffras. Funktionen returnerar false innan beslutet fattas vid template_redirect.

utdata

Det här filtret tar emot hela det buffrade HTML-dokumentet innan det skickas. Blockstudios egen flyttning av resurser körs med prioritet 1000000 och kompilering av Tailwind med 999999. Kör filtret tidigare för att se dokumentet före dessa steg, eller senare för att se den slutliga utdata.

PHP
add_filter('blockstudio/buffer/output', function(string $html) {
  return $html;
}, 2000000);

Rendering

beroenden

Det här filtret rapporterar den valda mallen och resursberoendena när Blockstudio renderar ett block. Det är användbart för statiska exporterare och andra insamlare av beroenden i processen.

PHP
add_filter(
  'blockstudio/render/dependencies',
  function($paths, $name, $block, $isEditor, $isPreview) {
    my_dependency_graph()->add($name, $paths);
    return $paths;
  },
  10,
  5
);

global

Med det här filtret kan du justera sidans utdata innan den renderas.

PHP
add_filter('blockstudio/render', function($content) {
  return $content;
});

Med det här filtret kan du justera utdata från taggen <head> innan den renderas. Det körs bara när Blockstudio buffrar svaret. Se bs_is_buffering().

PHP
add_filter('blockstudio/render/head', function($content) {
  return $content . '<meta name="custom" content="value">';
});

Med det här filtret kan du justera utdata från </body> innan den renderas.

PHP
add_filter('blockstudio/render/footer', function($content) {
  return $content . '<script>console.log("loaded")</script>';
});

Felhantering

error/logged

Åtgärden körs efter att ett fel har loggats. Använd den för att skicka fel till externa loggningstjänster.

PHP
add_action('blockstudio/error/logged', function($message, $level, $context) {
  if ($level === 'error') {
    my_external_logger($message, $context);
  }
}, 10, 3);

error/exception

Åtgärden körs efter att ett undantag har hanterats.

PHP
add_action('blockstudio/error/exception', function($exception, $context) {
  my_error_tracker($exception);
}, 10, 2);

Databas

Alla databashookar får en enda $params-matris.

db/before_create

Åtgärden körs innan en post skapas.

PHP
add_action('blockstudio/db/before_create', function($params) {
  // $params: block, schema, data, storage
});

db/after_create

Åtgärden körs efter att en post har skapats.

PHP
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

Åtgärden körs innan en post uppdateras.

PHP
add_action('blockstudio/db/before_update', function($params) {
  // $params: block, schema, id, data, storage
});

db/after_update

Åtgärden körs efter att en post har uppdaterats.

PHP
add_action('blockstudio/db/after_update', function($params) {
  // $params: block, schema, id, record, storage
});

db/before_delete

Åtgärden körs innan en post tas bort.

PHP
add_action('blockstudio/db/before_delete', function($params) {
  // $params: block, schema, id, storage
});

db/after_delete

Åtgärden körs efter att en post har tagits bort.

PHP
add_action('blockstudio/db/after_delete', function($params) {
  // $params: block, schema, id, storage
});

RPC

Alla RPC-hookar får en enda $params-matris.

rpc/before_call

Åtgärden körs innan funktionen RPC anropas.

PHP
add_action('blockstudio/rpc/before_call', function($params) {
  // $params: block, function, params
});

rpc/after_call

Åtgärden körs efter att funktionen RPC har anropats.

PHP
add_action('blockstudio/rpc/after_call', function($params) {
  // $params: block, function, params, result
});