Gå til indhold

PHP-hooks

Nedenfor finder du en liste over alle tilgængelige PHP-hooks, som kan bruges til at udvide eller tilpasse pluginets funktionalitet.

Sti

Dette filter lader dig justere stien til blokmappen. Som standard er den blockstudio i det aktuelt aktive tema. Alternativt kan du oprette en ny instans til flere kildemapper.

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

Init

global

Denne handling udløses, når pluginet har registreret alle blokke.

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

instans

Denne handling udløses, når pluginet har registreret alle blokke i en bestemt instans. Segmentet $instance er instansens sti relativt til 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

Denne handling udløses, før pluginet har registreret alle blokke.

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

global/before/$instance

Denne handling udløses, før pluginet har registreret alle blokke i en bestemt instans.

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

Blokke

gengivelse

Dette filter lader dig justere en bloks output, før den gengives.

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

metadata

Dette filter lader dig justere dataene i filen block.json, før den registreres.

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

Koden ovenfor ændrer ikonet for alle blokke, hvis navn begynder med marketing.

betingelser

Dette filter lader dig tilføje brugerdefinerede betingelser, der kan bruges i blokke. Hver betingelsestype knyttes til en værdi, som editoren sammenligner med value for betingelsen. Se Brugerdefinerede betingelser.

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

attributter

Dette filter justerer én feltdefinition, før blokken registreres. Den filtrerede definition styrer editorens kontrol og valideringen af værdier ved gengivelse. Se Filtrering for flere oplysninger.

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

attributes/render

Dette filter justerer værdien af et felt, før den gives videre til blokskabelonen. Det køres én gang pr. felt og modtager tre argumenter: $value (den opløste værdi), $key (feltnøglen, som brugt i $a) og $block (blokkens data-array, som skabeloner modtager som $block eller $b). Registrer det med tre accepterede argumenter. Se Filtrering for flere oplysninger.

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

Et files-felt returnerer hvert billede med et sizes-array, der indeholder URL, bredde og højde for full og alle registrerede billedstørrelser, f.eks. $image['sizes']['thumbnail'] og $image['sizes']['thumbnail-width']. Hver størrelse udløser ét wp_get_attachment_image_src()-kald pr. billede, så dets filtre gælder stadig. Skabeloner, der aldrig læser sizes, kan fjerne eller forkorte listen.

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 er listen over størrelsesnavne, med full først (tom, hvis der ikke er registreret mellemliggende størrelser). $id er vedhæftningens ID, og $size den størrelse, der er anmodet om for værdien af url. Filteret ændrer sizes-arrayet for alle filværdier i anmodningen. Uden filteret forbliver arrayet uændret.

Returnér størrelsesnavne som strenge. Ugyldige poster ignoreres, og dublerede navne håndteres én gang. En returværdi, der ikke er et array, springer størrelserne over. Den anmodede url og andre vedhæftningsegenskaber forbliver uændrede. Dette hook kører ikke for et files-felt med returnFormat: "url", som ikke opbygger et størrelseskort.

attributes/validate

Justér resultater fra eksplicitte bs_validate_block()-kald, for eksempel når et brugerdefineret renderfilter slår gemte referencer op. Dette aktiverer ikke automatisk validering ved gemning eller rendering.

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

Returnér en liste over resultater. Filteret kaldes ikke, når blokken ikke har Blockstudio-felter eller matchende udvidelser (null).

attributes/schema

Tilpas det JSON-skema, der returneres af bs_block_schema(), for eksempel når et brugerdefineret render-filter opløser gemte referencer.

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

Returnér skema-arrayet. Filteret kaldes ikke, når blokken ikke har nogen felter af typen Blockstudio eller matchende udvidelser (null).

attributes/populate

Dette filter lader dig føje brugerdefinerede data til indstillingerne for et checkbox-, select– eller radio-felt. Se Udfyldning af indstillinger for flere oplysninger.

Filteret modtager ét argument: et array med alle brugerdefinerede datasæt, indekseret efter det navn, der bruges 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

Dette filter lader dig justere outputtet af indholdet useBlockProps.

Alle komponentfiltre (use_block_props, inner_blocks og rich_text) modtager blokken som deres sidste argument. $block er den WP_Block_Type, der er registreret for blokken, som renderes, så $block->name er bloknavnet, for eksempel acme/hero.

$props er en streng med HTML-attributter, ikke et array. På frontend er den resultatet af get_block_wrapper_attributes(), for eksempel class="wp-block-acme-hero my-class". I editoren er den elementets class-attribut. Returnér en streng. I editoren anvendes kun class-attributten fra den returnerede streng.

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

Dette filter lader dig justere outputtet af indholdet <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

Dette filter lader dig fjerne <InnerBlocks />-wrapperen fra frontend.

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

components/rich_text/render

Dette filter giver dig mulighed for at justere outputtet af indholdet <RichText />. Det modtager attributtens værdi og blokken.

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

Bloktags

blockstudio/block_tags/builders

Dette filter registrerer builders til blokarrays, som bruges af bloktags og brugerdefinerede blokke valgt via blockstudio/parser/element_mapping. Hver builder modtager fortolkede attributter og råt indhold indeni.

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 kompatible filtre blockstudio/block_tags/renderers og blockstudio/parser/renderers kører efter dette hook og kan tilsidesætte det samme bloknavn.

blockstudio/block_tags/tag_aliases

Dette filter lader dig registrere brugerdefinerede tags med bindestreger, som omsættes til rigtige bloknavne før fallback til rå HTML. Det er nyttigt, når et tema ønsker en kortfattet, projektspecifik tagflade, samtidig med at det stadig gengiver standard-Blockstudio- eller kerneblokke.

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

Dette filter lader dig knytte præfikssuffikser til et eller flere bloknavnerum. Hver nøgle er et præfiks med små bogstaver uden bindestreger. Hver værdi kan være en navnerumsstreng eller en ordnet liste over navnerum.

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> omsættes til theme-components/card. <theme-button> prøver først theme-components/button og falder derefter tilbage til bsui/button. Eksplicitte blockstudio/block_tags/tag_aliases-poster har forrang for det samme tag, og uløste tags med præfiks forbliver uændrede.

Præfikser kan kædes sammen: Hvis et tag med præfiks ikke omsættes direkte, og dets slug selv er et registreret præfikstag, fortsætter omsætningen rekursivt. Med theme => ['theme-components'] og ui => ['bsui'] falder <theme-ui-input> videre til præfikset ui og omsættes til bsui/input. Registrerede præfiks- og alias-tags gengives også i blokskabelonoutput, ikke kun i sideindhold.

Indstillinger

sti

Dette filter lader dig justere stien til filen blockstudio.json. Som standard er den blockstudio.json i det aktuelt aktive tema.

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

users/ids

Dette filter lader dig aktivere editoren for bestemte bruger-id’er.

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

users/roles

Dette filter lader dig aktivere editoren for bestemte brugerroller.

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

assets/enqueue

Dette filter lader dig aktivere eller deaktivere indlæsning af ressourcer i frontend og editor.

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

assets/reset/enabled

Dette filter lader dig aktivere eller deaktivere fjernelse af kernens bloktypografier WordPress og nulstilling af editorens hjælpe-layout.

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

assets/reset/full_width

Dette filter lader dig styre, hvilke indlægstyper der bruger redigering i fuld bredde.

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

assets/minify/css

Dette filter lader dig aktivere eller deaktivere minificering af CSS.

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

assets/minify/js

Dette filter lader dig aktivere eller deaktivere minificering af JS.

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

assets/process/scss

Dette filter lader dig aktivere eller deaktivere behandling af SCSS i .css-filer.

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

assets/process/scss_files

Dette filter lader dig aktivere eller deaktivere behandling af .scss-filer til CSS.

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

assets/output

Dette filter lader dig styre, hvor kompilerede blokressourcer skrives.

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

assets/inline_limit

Filtrerer, hvor mange bytes af ekstern blok-CSS der indlejres pr. side.

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

cache/enabled

Dette filter lader dig aktivere eller deaktivere alle filbaserede runtime- og editorressourcecaches for Blockstudio.

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

cache/path

Dette filter lader dig ændre mappen for den filbaserede cache Blockstudio.

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

cache/namespace_grace

Dette filter lader dig ændre, hvor længe et udfaset cachenavnerum opbevares, før det ryddes op.

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

githooks/commit

Dette filter viser, om commit-hooket PHPStan, som ejes af Blockstudio, er aktiveret.

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

content/enabled

Dette filter lader dig aktivere eller deaktivere Content Sync.

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

content/id

Dette filter lader dig angive ejernavnerummet for Content Sync.

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

content/path

Dette filter lader dig angive filmappe for Content Sync.

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

content/include_page_sync_managed

Dette filter lader dig inkludere eller udelukke indlæg, der administreres af Page Sync.

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

content/authors

Dette filter lader dig konfigurere håndtering af forfattere i Content Sync.

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

content/post_types

Dette filter lader dig konfigurere tilladelseslister for indlægstyper i Content Sync.

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

content/taxonomies

Dette filter lader dig konfigurere tilladelseslister for taksonomier i Content Sync.

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

content/media

Dette filter lader dig konfigurere håndtering af medier i Content Sync.

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

tailwind/enabled

Dette filter lader dig aktivere eller deaktivere Tailwind.

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

tailwind/config

Dette filter lader dig tilføje en brugerdefineret Tailwind CSS-konfiguration.

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

tailwind/output

Dette filter lader dig vælge indlejret eller linket Tailwind CSS-output.

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

ui/enabled

Dette filter lader dig aktivere eller deaktivere medfølgende UI-komponenter.

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

editor/format_on_save

Dette filter lader dig aktivere eller deaktivere formatering af kode ved lagring.

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

editor/assets

Dette filter lader dig indlæse flere ressourcer i editoren.

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

editor/markup

Dette filter lader dig tilføje ekstra markup i slutningen af editoren.

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

block_editor/disable_loading

Dette filter lader dig deaktivere indlæsning af blokke i Block Editor.

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

block_editor/enhance

Dette filter lader dig aktivere editorfunktioner for Blockstudio, såsom renere fokustypografier og konturer ved markørføring og valg.

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

block_editor/css_classes

Dette filter lader dig tilføje typografiark, hvis klasser skal kunne vælges i klassefeltet.

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

block_editor/css_variables

Dette filter lader dig tilføje typografiark, hvis CSS-variabler skal kunne autofuldføres i kodefeltet.

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

block_editor/blocks/allow

Dette filter lader dig styre, hvilke bloknavne der er tilladt i indsætteren.

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

block_editor/blocks/deny

Dette filter lader dig fjerne bloknavne fra indsætteren.

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

block_editor/blocks/directory

Dette filter lader dig aktivere eller deaktivere ressourcer til WordPress-blokkataloget i editoren.

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

block_editor/blocks/categories/allow

Dette filter lader dig styre, hvilke slug-værdier for blokategorier der stadig er tilgængelige.

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

block_editor/blocks/categories/deny

Dette filter lader dig fjerne slug-værdier for blokategorier fra indsætteren.

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

block_editor/blocks/categories/rename

Dette filter lader dig omdøbe etiketter for blokategorier efter slug.

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

block_editor/blocks/categories/order

Dette filter lader dig sortere slug-værdier for blokategorier i indsætteren.

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

block_editor/blocks/styles/deny

Dette filter lader dig afregistrere bloktypografier efter bloknavn, der er registreret af PHP.

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

Dette filter lader dig skjule flere ældre widgets fra den ældre widgetblok.

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

block_editor/patterns/core

Dette filter lader dig aktivere eller deaktivere kernens blokmønstre for WordPress.

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

block_editor/patterns/remote

Dette filter lader dig aktivere eller deaktivere fjernmønstre fra mønsterkataloget WordPress.

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

block_editor/patterns/theme

Dette filter lader dig aktivere eller deaktivere blokmønstre, der leveres af temaet.

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

block_editor/patterns/blockstudio

Dette filter lader dig aktivere eller deaktivere filbaserede mønstre for Blockstudio.

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

block_editor/patterns/categories/allow

Dette filter lader dig styre, hvilke slug-værdier for mønsterkategorier der stadig er tilgængelige.

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

block_editor/patterns/categories/deny

Dette filter lader dig fjerne slug-værdier for mønsterkategorier fra mønsterindsætteren.

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

block_editor/patterns/categories/rename

Dette filter lader dig omdøbe etiketter for mønsterkategorier efter slug.

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

block_editor/patterns/categories/order

Dette filter lader dig sortere slug-værdier for mønsterkategorier i indsætteren.

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

block_editor/media/openverse

Dette filter lader dig aktivere eller deaktivere mediekategorien Openverse i medieindsætteren i blokeditoren.

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

block_editor/media/image_sizes/allow

Dette filter lader dig styre, hvilke navne på billedstørrelser der stadig er tilgængelige i editorens mediekontroller.

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

block_editor/media/image_sizes/deny

Dette filter lader dig fjerne navne på billedstørrelser fra editorens mediekontroller.

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

ai/enable_context_generation

Dette filter lader dig aktivere eller deaktivere generering af en kontekstfil til integration med LLM-værktøjer. Når funktionen er aktiveret, samler kontekstfilen opdaterede blokdata, indstillinger for Blockstudio i den aktuelle installation, alle relevante skemaer og dokumentation for Blockstudio i én kilde til brug med AI-udviklingsværktøjer.

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

block_tags/enabled

Dette filter lader dig aktivere eller deaktivere gengivelse af bloktags på sideniveau.

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

block_tags/prefixes

Dette filter lader dig registrere præfiksforkortelser til navnerum for bloktags.

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

dev/grab/enabled

Dette filter lader dig aktivere eller deaktivere elementgriberen.

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

dev/perf

Dette filter lader dig aktivere eller deaktivere ydelsesprofileringen.

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

dev/canvas/enabled

Dette filter lader dig aktivere eller deaktivere lærredet.

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

dev/canvas/admin_bar

Dette filter lader dig vise eller skjule adminlinjen for WordPress på lærredet.

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

WPML

blockstudio/wpml/config/label

Filtrerer etiketten for hver nøgle, som wp bs wpml config skriver. Se Skift etiketterne for kontekst-arrayet.

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

Lærred

blockstudio/canvas/inventory

Dette filter justerer den beholdning, som Canvas rapporterer for et valg. Callbacken modtager beholdningens DTO, det oprindelige valg og de indstillinger, den blev kaldt med.

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

blockstudio/canvas/documents

Dette filter justerer de gengivne dokumenter, som Canvas returnerer, med de samme tre argumenter som beholdningsfilteret.

blockstudio/canvas/item_loaded

Denne handling udløses én gang pr. beholdningspost, når den indlæses, og modtager beholdningstypen, det kanoniske post-id og den normaliserede post.

blockstudio/canvas/source_compiled

Denne handling udløses, når en kildefil er kompileret til Canvas, og modtager den valgte kildesti og den kanoniske kildepost.

Medfølgende UI

blockstudio/ui/directories

Dette filter justerer de mapper, der scannes for medfølgende UI-komponenter.

blockstudio/ui/inventory

Dette filter justerer den offentlige familiebeholdning for UI.

blockstudio/ui/examples

Dette filter justerer eksempeldataposterne for UI og modtager eksemplerne samt den offentlige beholdning for UI, som de blev afledt af.

Topologi

blockstudio/blocks/topology_refreshed

Denne handling udløses, når bloktopologien er blevet genopbygget.

blockstudio/pages/topology_refreshed

Denne handling udløses, når sidetopologien er blevet genopbygget.

blockstudio/pages/layout_error

Denne handling udløses, når et sidelayout ikke kan gengives, i stedet for at fejlen forbliver skjult.

Runtime

blockstudio/runtime/initialized

Denne handling udløses, når runtime har fastlagt sin konfiguration.

blockstudio/runtime/changed

Denne handling udløses, når den fastlagte runtime-identitet ændres, hvilket flytter cachenavnerum og statisk prerenderingstilstand.

blockstudio/performance/default_config

Dette filter justerer standardværdierne for ydeevne, før projektets egne værdier for blockstudio.json lægges oveni.

Indhold

blockstudio/content/orphan_action

Dette filter afgør, hvad synkronisering af indhold gør med en post, der ikke længere har en kilde.

Bootstrap

blockstudio/url

Dette filter ændrer den offentlige URL, der bruges til editor- og adminressourcer for Blockstudio. Integrationer med Composer skal registrere den, før autoload-filen for Blockstudio indlæses. Det andet argument er den fysiske pakkemappe.

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

Runtime-cache

blockstudio/cache/dir

Dette filter modtager den fastlagte grundmappe for cachen, før der tilføjes et runtime-, editorressource- eller andet cacheområde.

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

blockstudio/cache/context

Dette filter føjer en serialiserbar runtimevariant til cacheidentiteter. Brug det, når den samme opdagelseskilde kan vælge forskellige logiske beholdninger.

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

Dette filter ændrer identiteten for netværks-/blogmappen på værter med deres egen lejergrænse. Den returnerede værdi renses før brug.

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

Dette filter tilføjer værtsoplysninger, der påvirker alle objekter i et runtimeområde. Kildens fingeraftryk for det enkelte element skal i stedet angives som eksplicitte afhængigheder af den ansvarlige 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

Filtrerer, hvor mange sekunder et valideret øjebliksbillede af filovervågningen kan genbruges uden endnu en gennemgang af filsystemets status. Standardværdien er 0 i lokale miljøer og udviklingsmiljøer og 20 andre steder.

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

blockstudio/cache/build_wait_budget

Filtrerer, hvor længe i millisekunder en anmodning venter på, at en samtidig builder publicerer runtime-cachen eller opdateringen af udfyldte valg, før den nedgraderer. Standardværdien er 5000 for strukturelle genopbygninger og 4000 for opdateringer af valg.

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

blockstudio/cache/populate_debounce

Filtrerer, hvor mange sekunder en række indhold-, term-, bruger- eller metaskrivninger samles i én opdatering af udfyldte valg. Den første skrivning efter en pause udløser straks en opdatering; den sidste skrivning i en række afspejles, når tidsvinduet er gået. Standardværdien er 30. Returnér 0 for at opdatere ved hver skrivning.

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

blockstudio/cache/populate_ignored_meta_keys

Filtrerer meta-nøgler, hvis skrivninger aldrig opdaterer udfyldte valgmuligheder. Som standard er det de nøgler, WordPress skriver som redigerings- og loginregistrering: _edit_lock, der opdateres af editoren og Heartbeat, mens et indlæg er åbent, _edit_last, der skrives sammen med en indlægsgemning, som allerede udløser en opdatering, og session_tokens, der skrives ved login og logout. Tilføj nøgler, der ændres ofte, men aldrig påvirker en udfyldningsforespørgsel.

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

blockstudio/cache/max_files_per_scope

Filtrerer, hvor mange publicerede payloads hvert runtime-cacheområde beholder.

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

blockstudio/cache/compress

Filtrerer, om en cache-payload bruger komprimerede serialiserede data i stedet for et almindeligt PHP-array. Som standard bruger kun payloads på op til 1 MiB det almindelige format, og kun når aktivt delt OPcache-hukommelse kan cache destinationen. Andre processer, udelukkede filer og større payloads bruger komprimering.

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

Hvis du returnerer false, tilsidesættes størrelsesgrænsen også. Det kan være nyttigt, når WP-CLI uden opcache.enable_cli forvarmer filer til webworkers med OPcache aktiveret, men alle læsere uden OPcache vil fortolke det genererede array. Behold komprimering for store delte payloads, medmindre den ekstra hukommelsesomkostning er acceptabel. Se cache-payloadformater for standardbeskyttelsen.

blockstudio/cache/protected_paths

Oprydning af cacheforløb må aldrig fjerne filer. Blockstudio udfylder listen med alle filer, der refereres til i det installerede early-serve-kort.

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

Denne handling rapporterer et delt cacheområde og et resultat, såsom 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

Dette filter modtager den endelige afgørelse om anonym sikkerhed samt server- og cookieinput. Hvis true returneres, springes statisk visning og generering altid over.

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

Dette filter leverer eller justerer den komplette offentlige beholdning for URL, som bruges af den planlagte opvarmning og eksplicitte grafværktøjer.

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

Det, filteret returnerer, er ikke den endelige beholdning. Resultatet går gennem et cachebarhedstjek, som fjerner alt, der matcher en konfigureret dynamisk sti, samt alt, der som standard omgås: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, enhver sti, der indeholder /feed/, og søgeresultater under søgegrundstien på webstedets startsti (/search/ som standard). En URL, du tilføjer, kan derfor blive kasseret uden en advarsel. Hvis en rute, du forventer, mangler i den byggede beholdning, skal du kontrollere den efter disse regler, før du antager, at filteret ikke blev kørt.

blockstudio/static_prerender/render_internal

Dette filter implementerer den valgfrie batchtransport i processen. Returnér et normaliseret resultatarray, eller lad værdien være uændret, så rendereren bruger sin konfigurerede HTTP-reserve. Resultatet indeholder html og eventuelt status, dependencies, virtualHashes og headers; de headere, der er navngivet i performance.staticPrerender.replayHeaders, gemmes sammen 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

Denne filterfunktion træffer den endelige afgørelse, efter at Blockstudio har bekræftet, at outputtet er et komplet HTML-dokument uden no-cache-markøren, og at den observerede svarstatus er vellykket. Det tredje argument er den observerede status eller null, hvis ingen status blev angivet.

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

Denne handling rapporterer resultater for statisk prerendering, herunder cachehits, cachefejl, skrivninger, grafskrivninger, forældede poster og fejl.

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

blockstudio/tailwind/cache_max_files

Filtrerer det maksimale antal kompilerede poster for Tailwind CSS. Standardværdien er 1000.

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

blockstudio/tailwind/cache_max_age

Filtrerer maksimalalderen i sekunder for kompilerede poster for Tailwind CSS. Standardværdien er 30 dage, og minimum er én time.

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

Administration

aktiveret

Dette filter lader dig aktivere eller deaktivere administrationssiden Blockstudio under Værktøjer > Blockstudio.

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

Ressourcer

editor/canvas/body_class

Når nulstilling af ressourcer er aktiveret, justerer dette filter de rensede body-klasser fra frontend, som kopieres til blokeditorens lærred.

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

aktivér

Dette filter lader dig deaktivere ressourcebehandling og indlæsning for en bestemt ressourcetype.

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

deaktivér

Dette filter lader dig deaktivere bestemte ressourcer efter deres id. Ressourcer, hvis id findes i det returnerede array, gengives ikke på frontend.

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

process/scss/import_paths

Dette filter lader dig tilføje flere stier til statementen @import i compileren SCSS.

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

process/scss/prelude

Dette filter lader dig tilføje fælles Sass-kode før hver fil af typen SCSS kompileres.

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

Dette filter lader dig justere indholdet af filen CSS, før den kompileres.

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

process/js/content

Dette filter lader dig justere indholdet af filen JS, før den kompileres.

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

Buffer

aktiveret

Blockstudio buffer frontend-svaret, så bloktypografi- og script-tags gengivet i body kan flyttes til head og footer, og så Tailwind kan scanne hele dokumentet. Buffering betyder, at hele dokumentet holdes og scannes ved hver frontend-anmodning; et websted, der ikke gengiver blokressourcer for Blockstudio og ikke bruger Tailwind, kan returnere false for at springe begge dele over.

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

Buffering er også slået fra i adminområdet og i forhåndsvisningen af Customizer. Kald bs_is_buffering() fra wp_enqueue_scripts eller senere for at finde ud af, om det aktuelle svar er buffret. Den returnerer false, før beslutningen træffes ved template_redirect.

output

Dette filter modtager det komplette, bufferlagrede HTML-dokument, før det sendes. Ressourceflytning for Blockstudio kører med prioritet 1000000, og kompilering af Tailwind med 999999. Kør tidligere for at se dokumentet før disse processer eller senere for at se det endelige output.

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

Gengivelse

afhængigheder

Dette filter rapporterer de valgte skabelon- og ressourceafhængigheder, hver gang Blockstudio gengiver en blok. Det er nyttigt for statiske eksportværktøjer og andre afhængighedsindsamlere 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

Dette filter lader dig justere sidens output, før det gengives.

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

Dette filter giver dig mulighed for at justere outputtet af tagget <head>, før det renderes. Det kører kun, når Blockstudio buffer svaret. Se bs_is_buffering().

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

Dette filter lader dig justere outputtet fra </body>, før det gengives.

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

Fejlhåndtering

error/logged

Handlingen udløses, efter at en fejl er logget. Brug den til at sende fejl til eksterne logningstjenester.

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

error/exception

Handlingen udløses, efter at en undtagelse er håndteret.

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

Database

Alle databasehooks modtager ét $params-array.

db/before_create

Handlingen udløses, før en post oprettes.

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

db/after_create

Handlingen udløses, efter at en post er oprettet.

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

Handlingen udløses, før en post opdateres.

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

db/after_update

Handlingen udløses, efter at en post er opdateret.

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

db/before_delete

Handlingen udløses, før en post slettes.

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

db/after_delete

Handlingen udløses, efter at en post er slettet.

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

RPC

Alle hooks for RPC modtager ét $params-array.

rpc/before_call

Handlingen udløses, før en funktion af typen RPC kaldes.

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

rpc/after_call

Handlingen udløses, efter at en funktion af typen RPC er kaldt.

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