Hoppa till innehåll

Inställningar

Blockstudio har en kraftfull inställnings-API som låter dig ange alternativ via en blockstudio.json-fil i temamappen och/eller med filter. Dessutom kan behöriga användare ändra inställningarna visuellt i administrationsområdet.

Via JSON

Om det finns en blockstudio.json-fil i temamappen används den för att ange standardalternativen för den aktuella webbplatsen. Ett schema för JSON finns för att validera filen och ge stöd för automatisk komplettering i en IDE.

Filen är valfri. Utan den använder Blockstudio inställningar som sparats i administrationsområdet utöver de inbyggda standardvärdena. När filen läggs till, ändras eller tas bort upptäcks det automatiskt, så du behöver inte rensa någon cache eller läsa in sidan manuellt på nytt.

Följande egenskaper är tillgängliga:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "users": {
    "ids": [],
    "roles": []
  },
  "assets": {
    "enqueue": true,
    "reset": {
      "enabled": false,
      "fullWidth": []
    },
    "minify": {
      "css": false,
      "js": false
    },
    "process": {
      "scss": false
    }
  },
  "cache": {
    "enabled": true,
    "path": "blockstudio/cache"
  },
  "themeDefaults": {
    "titleTag": false,
    "suppressDirectoryUpdates": false
  },
  "performance": {
    "profile": "compat",
    "wordpress": {
      "headNoise": false,
      "embeds": false,
      "xmlrpc": false,
      "editor": false,
      "frontendAssets": false,
      "media": false,
      "heartbeat": false
    },
    "preload": {
      "links": "off"
    },
    "media": {
      "lazy": false,
      "skeleton": false,
      "metadata": false,
      "rootMargin": "300px"
    },
    "measurement": {
      "enabled": false,
      "queryMonitor": false,
      "headers": false,
      "timings": false
    }
  },
  "content": {
    "enabled": false,
    "id": "default",
    "path": "content",
    "includePageSyncManaged": false,
    "authors": "ignore",
    "postTypes": [],
    "meta": {
      "include": [],
      "exclude": ["_edit_lock", "_edit_last", "_wp_old_slug"],
      "references": {}
    },
    "taxonomies": [],
    "media": "manifest"
  },
  "editor": {
    "formatOnSave": false,
    "assets": [],
    "markup": false
  },
  "tailwind": {
    "enabled": false,
    "config": "",
    "output": "inline"
  },
  "blockTags": {
    "enabled": false,
    "allow": [],
    "deny": [],
    "prefixes": {}
  },
  "ui": {
    "enabled": false
  },
  "blockEditor": {
    "disableLoading": false,
    "enhance": false,
    "cssClasses": [],
    "cssVariables": [],
    "blocks": {
      "allow": [],
      "deny": [],
      "directory": true,
      "categories": {
        "allow": [],
        "deny": [],
        "rename": {},
        "order": []
      },
      "styles": {
        "deny": {}
      },
      "legacyWidgets": {
        "hide": []
      }
    },
    "patterns": {
      "core": true,
      "remote": true,
      "theme": true,
      "blockstudio": true,
      "categories": {
        "allow": [],
        "deny": [],
        "rename": {},
        "order": []
      }
    },
    "media": {
      "openverse": true,
      "imageSizes": {
        "allow": [],
        "deny": []
      }
    }
  },
  "dev": {
    "grab": {
      "enabled": false
    },
    "perf": false,
    "canvas": {
      "enabled": false,
      "adminBar": true
    }
  },
  "githooks": {
    "commit": false
  },
  "phpstan": {
    "preset": "base",
    "configuration": "",
    "roots": ["."],
    "excludePaths": [],
    "maxFiles": 10000
  },
  "ai": {
    "enableContextGeneration": false
  }
}

Via filter

Du kan också använda filtret blockstudio/settings/${setting} för att ange alternativ via PHP och få större flexibilitet.

PHP
add_filter('blockstudio/settings/assets/enqueue', '__return_false');
add_filter('blockstudio/settings/editor/formatOnSave', '__return_true');
add_filter('blockstudio/settings/ui/enabled', '__return_true');
add_filter('blockstudio/settings/block_editor/patterns/remote', '__return_false');

Alternativ som anges via filtret blockstudio/settings/${setting} åsidosätter dem som anges i filen blockstudio.json. Du kan använda båda metoderna tillsammans.

Värden vid körning exponerar också filter för blockstudio/performance/${setting} och ett sista filter blockstudio/performance/config. Det senare måste returnera ett giltigt konfigurationsobjekt.

Så samverkar källorna

Varje källa läses in och slås samman, med lägsta prioritet först:

  1. Inbyggda standardvärden
  2. Inställningar som sparats via administrationens UI (alternativet blockstudio_settings)
  3. blockstudio.json i temat
  4. blockstudio/settings/*-filter

blockstudio.json åsidosätter endast de nycklar som den anger. Tidigare ersatte den alla sparade inställningar, så ett orelaterat värde som sparats i administrationen slutade gälla så snart filen dök upp; nu läggs den ovanpå dem. Nackdelen är att ett gammalt värde som sparats via administrationens UI fortsätter att gälla tills filen anger den nyckeln eller det sparade värdet tas bort. Om en inställning fungerar annorlunda än vad filen anger kan du kontrollera det sparade lagret med wp bs settings eller Settings::get_raw(), som endast returnerar det som den aktiva källan för JSON eller alternativ uttryckligen angav.

Läsa inställningar från PHP

Blockstudio\Settings läser in den aktiva källan, rapporterar felaktigt formaterade JSON och läses automatiskt in på nytt när blockstudio.json ändras:

PHP
use Blockstudio\Settings;

$enabled = Settings::get_bool('performance/media/lazy');
$margin = Settings::get_string('performance/media/rootMargin', '300px');
$roles = Settings::get_array('users/roles');
$ttl = Settings::get_int('performance/staticPrerender/ttl', 86400);

foreach (Settings::errors() as $error) {
    error_log($error);
}

Använd Settings::get_raw() när en integration bara behöver värden som uttryckligen deklarerats av den aktiva källan JSON eller av alternativkällan. Settings::fingerprint() returnerar en deterministisk identitet för de effektiva inställningarna. Långlivade processer kan anropa Settings::reload() uttryckligen för att läsa in en filändring omedelbart. Normal åtkomst kontrollerar filen högst en gång per sekund i en begäran eller långlivad PHP- process, även vid ändringar som behåller samma filstorlek. Om den konfigurerade sökvägen ändras gäller det vid nästa läsning. När ingen JSON-fil är aktiv fördröjs inte sparade databasinställningar av det här tidsfönstret.

Den lösta prestandaprofilen är tillgänglig via Blockstudio\Runtime_Settings::current(). Den stöder sökvägar med snedstreck eller punkter:

PHP
use Blockstudio\Runtime_Settings;

$runtime = Runtime_Settings::current();

if ($runtime->enabled('measurement/queryMonitor')) {
    $hash = $runtime->hash();
}

Tillgängliga inställningar

users

Alternativ Typ Standard Beskrivning
ids array [] Användar-ID:n med redigeringsåtkomst
roles array [] Användarroller med redigeringsåtkomst

assets

Alternativ Typ Standard Beskrivning
enqueue boolean true Lägg automatiskt till blockresurser i kön
reset.enabled boolean false Ta bort kärnans blockstilar och tillämpa redigerarens verktygsåterställning
reset.fullWidth array [] Inläggstyper som använder redigerarlayout med full bredd
minify.css boolean false Minifiera CSS-utdata
minify.js boolean false Minifiera JS-utdata
process.scss boolean false Bearbeta SCSS-filer
output string source Sökväg där kompilerade resurser skrivs: source eller cache
inlineLimit integer 0 Byte för externa block-CSS som skrivs ut inline per sida

output använder som standard source, vilket skapar en katalog _dist bredvid varje block. Ställ in den på cache för att i stället skriva kompilerade resurser i cachekatalogen Blockstudio, så att blockets källträd förblir rent och kan driftsättas från en oföränderlig utcheckning. Källor Blockstudio kan inte skriva till cacheminnet redan omdirigeras dit oavsett den här inställningen.

inlineLimit är inaktiverat vid 0, så varje extern formatmall behåller sin <link>-tagg. Ange ett antal byte för att i stället skriva ut sidans minsta externa blockformatmallar inline, så länge deras sammanlagda storlek håller sig inom det antalet. 40000 är gränsen som WordPress använder för samma regel. Se Inline-formatmallar.

När reset.enabled är aktivt kopierar Blockstudio även sanerade frontendvärden för body_class till redigeringsytan. Använd blockstudio/editor/canvas/body_class för att justera listan med klasser som endast gäller redigeraren.

cache

Alternativ Typ Standard Beskrivning
enabled boolean true Aktivera filbaserade cacheminnen för Blockstudio
path string "blockstudio/cache" Cacheminnets sökväg, relativ till WP_CONTENT_DIR eller absolut
namespaceGrace integer 86400 Antal sekunder en utfasad cacheidentitet behålls före rensning

Som standard skrivs cachefiler till wp-content/blockstudio/cache, utanför uppladdningskatalogen. En relativ sökväg path löses utifrån WP_CONTENT_DIR; en absolut sökväg används direkt. Detta stöder värdar som tillhandahåller en särskild skrivbar cachevolym.

När funktionen är aktiverad använder Blockstudio den här enda roten för byggnyttolaster, förregistreringsdata för block, lösta redigeringsresurser, Tailwind CSS, renderingsdokument, öfragment, statiska förhandsrenderingar, grafindex, köer och diagnostik. Varje objekt isoleras efter nätverk, webbplats, fullständig körningsidentitet och omfattning. Körningsidentiteter omfattar Blockstudio, inställningar, WordPress, PHP, det aktiva temat, aktiva tillägg, logiska identifieringskällor, värdkontext och uttryckliga beroendehashar som tillhandahålls av den ansvariga operationen.

Ändringar av innehåll, termer, användare och metadata gör att ifyllda fältval blir ogiltiga, men påverkar inte strukturell blockupptäckt eller kompilerade tillgångar. Valen uppdateras separat under ett lås för den fasta byggsökvägen. En serie skrivningar, till exempel en synkronisering av översättningar eller en import, slås ihop: den första skrivningen efter en lugn period utlöser en omedelbar uppdatering, och den sista skrivningen i serien återspeglas en gång när trettio sekunder har gått, vilket kan justeras med blockstudio/cache/populate_debounce. Metadata som WordPress skriver som bokföring, till exempel låset för inläggsredigering, räknas inte som en ändring; blockstudio/cache/populate_ignored_meta_keys utökar den listan. Redigeraren hämtar alltid aktuella alternativ, så tidsfönstret påverkar bara cachade val som läses vid rendering. Källfiler och bygginställningar gör fortfarande den strukturella cachen ogiltig på vanligt sätt. När val skrivs över skannas inte cachekatalogen på nytt vid varje innehållsändring; regelbunden rensning samlar fortfarande in föräldralösa temporära filer. Språkspecifika identiteter vid körning förblir isolerade; flera kataloger för cache-namnrymder på en flerspråkig webbplats är inte i sig ett tecken på en cachemiss.

SQLite journalaktivitet i en blocks db-datakatalog kastar inte bort cachad blockmetadata. Ändringar i db.php, bevakade källfiler eller datakatalogens struktur av källfiler och underkataloger ogiltigförklarar fortfarande cachen.

Vid samtidiga återskapanden av körningsmiljön väljs en enda byggare. Andra förfrågningar väntar i upp till fem sekunder och återanvänder sedan senast fungerande blockmetadata om dess källfiler och nödvändiga kompilerade resurser fortfarande finns. En kall förfrågan utan en säker nyttolast returnerar HTTP 503 med Retry-After i stället för att starta ett nytt bygge. Filtret blockstudio/cache/build_wait_budget justerar väntetiden i millisekunder för både strukturella återskapanden och uppdateringar av val. En värd utan rådgivande fillås uppdaterar val utan skydd och publicerar dem ändå, så nästa förfrågan får en cacheträff.

Inaktiva nyckelspecifika .build.lock-filer som lämnats kvar av tidigare versioner rensas från den här webbplatsens cacheidentiteter av WP-Cron, med start fem minuter efter uppgraderingen. Upp till 10,000 lås tas bort per minut inom en tidsbudget på tio sekunder. wp bs cache status rapporterar antalet kvarvarande och wp bs cache cleanup tömmer kön omedelbart; wp bs cache clear rensar körningscachen. Om en schemalagd körning är mer än tio minuter försenad för att cron inte körs går förfrågningar igenom ett begränsat antal lås en gång i timmen, så att tömningen inte stannar av. Nyliga eller låsta filer lämnas orörda, och de nya låsen med fasta sökvägar rensas aldrig. När kön har tömts rensar samma körning bort övergivna cacheidentiteter när deras namespaceGrace har passerat, högst en gång i timmen per webbplats, och behåller en daglig körning för detta. Fristen räknas från den första genomgång som hittar en inaktuell cacheidentitet, inte från den senaste filen i den, och en identitet som fortfarande är aktuell för något av sina användningsområden rensas aldrig. Intern rensning av cache anropar inte WordPress-filter för borttagning av bilagor. Värdar med WP-Cron inaktiverat bör fortsätta köra sin vanliga schemalagda cron-arbetare; ta inte bort aktiva låsfiler urskillningslöst för att tömma en kö.

Inställningsfiltret blockstudio/settings/cache/path ändrar det konfigurerade värdet. För att lösa sökvägar specifikt för driftsättningen filtrerar blockstudio/cache/dir den lösta baskatalogen:

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

Värdar med en klientidentitet som skiljer sig från nätverks- eller blogg-ID:t för WordPress kan filtrera blockstudio/cache/site_key. Resultatet saneras och används endast som ett katalogsegment. blockstudio/cache/context är fortfarande rätt plats för en serialiserbar körningsvariant som måste ändra objektidentiteter.

themeDefaults

Alternativ Typ Standard Beskrivning
titleTag boolean false Aktivera temastöd för WordPress-titeltagg
suppressDirectoryUpdates boolean false Ta bort aktiva barn- och föräldrateman från katalogens uppdateringsresultat

Mönster fortsätter att använda den befintliga Blockstudio\Patterns API; dessa standardvärden introducerar inga alternativa sid- eller mönstergränssnitt.

performance

Profilen compat lämnar det generiska beteendet för WordPress oförändrat. speed och strict aktiverar samma valfria frontendstandardvärden; varje underordnad inställning kan åsidosätta profilens värde.

Valfria inställningar fungerar som registreringsgrindar. När en valfri funktion är false kopplar Blockstudio inte in funktionens frontend-, administrations-, redigerar-, REST- eller schemalagda återanrop. Om Early Serve eller schemalagd uppvärmning inaktiveras efter att ha använts utförs funktionens egen rensning en gång; efterföljande förfrågningar förblir inaktiva.

Alternativ Typ Kompatibilitetsstandard Hastighets-/strikthetsstandard Beskrivning
profile string "compat" Ej tillämpligt compat, speed, eller strict
wordpress.headNoise boolean false true Ta bort generisk head-discovery och emoji-utdata
wordpress.embeds boolean false true Ta bort oEmbed-discovery och värdskript
wordpress.xmlrpc boolean false true Inaktivera XML-RPC och pingbacks
wordpress.editor boolean false true Inaktivera fjärrytor för editor-discovery
wordpress.frontendAssets boolean false true Ta bort generiska frontend-resurser från kärnan
wordpress.media boolean false true Tillämpa standardvärden för bildutdata
wordpress.heartbeat boolean false true Begränsa Heartbeat utanför editorer
preload.links string "off" "intent" Förhandsladda dokument från samma ursprung efter användaravsikt
media.lazy boolean false true Använd Blockstudios bildladdare
media.skeleton boolean false true Visa den inbyggda laddningsskelettvyn
media.metadata boolean false true Ange användning av assets/media.json
media.rootMargin string "300px" "300px" Skärningsmarginal för lazy-loader
measurement.enabled boolean false false Aktivera API:er för mätning vid körning
measurement.queryMonitor boolean false false Inkludera frågor som tar minst 50ms
measurement.headers boolean false false Skicka profil- och konfigurationshash-rubriker
measurement.timings boolean false false Skicka rubriken för förfluten körtid
staticPrerender.enabled boolean false false Aktivera cachelagring med anonymitetssäker HTML
staticPrerender.ttl integer 86400 86400 Högsta ålder för cachade dokument i sekunder
staticPrerender.invalidate string "signature" "signature" Använd signature eller inkrementell identitet för graph
staticPrerender.earlyServe boolean false false Visa säkra träffar innan WordPress startar
staticPrerender.serveLoggedIn boolean false false Tillåt användare att använda, men aldrig skapa, cacheträffar
staticPrerender.dynamicPaths array [] [] Sökvägsprefix som måste förbli dynamiska
staticPrerender.replayHeaders array ["Link"] ["Link"] Svarsrubriker som lagras med och skickas vid cacheträffar
staticPrerender.warm.enabled boolean false false Aktivera den beständiga schemalagda uppvärmningskön
staticPrerender.warm.interval integer 3600 3600 Uppvärmningsintervall i sekunder
staticPrerender.warm.concurrency integer 2 2 Högsta antal jobb som behandlas under en uppvärmningsomgång
staticPrerender.warm.transport string "http" "http" Använd http eller en renderare från värden internal

Statisk förhandsrendering förblir inaktiverad om den inte uttryckligen aktiveras. En inaktiverad huvudbrytare registrerar inga hooks för förhandsrenderingsbegäranden, och inaktiverade earlyServe– och warm.enabled-brytare registrerar inga admin- eller cron-hooks. Signaturläget använder en billig aktiverad identitet vid vanliga förfrågningar. Graf-läget är avsett för uttryckliga byggen: det registrerar källberoenden per sida så att en ändring av en sida inte ogiltigförklarar orelaterade dokument. Se Statisk förhandsrendering för uppvärmning, driftsättning, tidig leverans och säkerhetsdetaljer.

Mätvärden är tillgängliga programmatiskt:

PHP
use Blockstudio\Performance_Measurement;

$snapshot = Performance_Measurement::snapshot();

När headers är aktiverade skickar Blockstudio X-Blockstudio-Performance-Profile, X-Blockstudio-Performance-Config och, valfritt, X-Blockstudio-Performance-Time. Åtgärden blockstudio/performance/measurement_enabled tar emot de lösta körningsinställningarna.

Alternativen för media styr bs_media_image(), manifestet assets/media.json och frontendens lazy loader. Se Media för hjälpfunktionen, manifestbyggaren och laddarens beteende.

content

Alternativ Typ Standard Beskrivning
enabled boolean false Aktivera Content Sync-konfiguration
id string "default" Namnrymd för innehållsuppsättning som lagras på synkroniserade entiteter
path string "content" Katalog för innehållsfiler relativ till temat
includePageSyncManaged boolean false Inkludera inlägg som hanteras av Page Sync utan att äga deras innehåll
authors string "ignore" Författarhantering (ignore eller befintlig användares login)
postTypes array [] Tillåtna inläggstyper
meta.include array [] Glob-mönster för metanycklar att synkronisera
meta.exclude array ["_edit_lock", "_edit_last", "_wp_old_slug"] Glob-mönster för metanycklar att utesluta
meta.references object {} Deklarerade metareferenser som skrivs om mellan ID:n och UID:er
taxonomies array [] Tillåtna registrerade taxonomier för termer och relationer
media string "manifest" Beteende för bilagereferenser (manifest eller none)

Content Sync hanteras via wp bs content och exporterar tillåtna inlägg, inläggsmetadata och deklarerade referenser till portabla filer. Se Content Sync för arbetsflödet och filformatet.

editor

Alternativ Typ Standard Beskrivning
formatOnSave boolean false Formatera block.json vid sparande
assets array [] Ytterligare resurser att läsa in i redigeraren
markup boolean false Aktivera markup-redigering

tailwind

Alternativ Typ Standard Beskrivning
enabled boolean false Aktivera kompilering av Tailwind CSS
config string "" Tailwind v4-först-konfiguration CSS

Se Tailwind CSS för kompileringens beteende och formatet för konfiguration med CSS först.

blockTags

Alternativ Typ Standard Beskrivning
enabled boolean false Aktivera återgivning av sidnivåns bs:-tagg i inläggsinnehåll och widgetområden
allow array [] Tillåtelselista med blocknamnsmönster; stöder jokertecken med fnmatch()
deny array [] Blockeringslista med blocknamnsmönster; har företräde framför allow
prefixes object {} Prefix för att namnområde ska kunna användas med kortformer, varje värde är ett namnområde eller en ordnad array

Återgivning av taggar på mallellnivå är alltid aktiv; dessa alternativ styr ersättning på sidnivå. Se Återgivning för taggsyntax och upplösningsregler.

ui

Alternativ Typ Standard Beskrivning
enabled boolean false Registrera de medföljande komponenterna för bsui/* UI och exempelapparna för app/*

blockEditor

Alternativ Typ Standard Beskrivning
disableLoading boolean false Inaktivera blockinläsning i redigeraren
enhance boolean false Aktivera Blockstudio redigerarens funktioner för hovring och markering
cssClasses array [] URL:er till formatmallar som klasser från CSS hämtas från för automatisk komplettering i klassfältet
cssVariables array [] URL:er till formatmallar som variabler från CSS hämtas från för automatisk komplettering i kodfältet

blockEditor.blocks

Använd blockEditor.blocks för en projektsövergripande policy för blockinfogaren. allow och deny accepterar blocknamn och jokerteckenmönster som core/*.

JSON
{
  "blockEditor": {
    "blocks": {
      "allow": ["core/*", "my-theme/*"],
      "deny": ["core/embed", "core/freeform"],
      "directory": false,
      "categories": {
        "rename": {
          "text": "Writing",
          "design": "Layout"
        },
        "order": ["my-theme", "text", "media"]
      },
      "legacyWidgets": {
        "hide": ["archives", "calendar"]
      }
    }
  }
}

blocks.styles.deny avregistrerar format som registrerats via WordPress’ PHP blockformatregistret:

JSON
{
  "blockEditor": {
    "blocks": {
      "styles": {
        "deny": {
          "my-theme/card": ["outline"],
          "my-theme/media": ["framed"]
        }
      }
    }
  }
}

blockEditor.patterns

Använd blockEditor.patterns för att inaktivera globala mönsterkällor och filtrera mönsterkategorier.

JSON
{
  "blockEditor": {
    "patterns": {
      "core": false,
      "remote": false,
      "theme": true,
      "blockstudio": true,
      "categories": {
        "deny": ["gallery"],
        "rename": {
          "featured": "Featured Layouts"
        },
        "order": ["featured", "buttons"]
      }
    }
  }
}

blockEditor.media

Använd blockEditor.media för global policy för mediainfogarens.

JSON
{
  "blockEditor": {
    "media": {
      "openverse": false,
      "imageSizes": {
        "allow": ["thumbnail", "large"],
        "deny": ["medium_large"]
      }
    }
  }
}

dev

Alternativ Typ Standard Beskrivning
grab.enabled boolean false Aktivera elementplockaren på frontend
perf boolean false Aktivera prestandaprofileraren vid varje sidladdning
canvas.enabled boolean false Aktivera arbetsytan
canvas.adminBar boolean true Visa adminfältet för WordPress när arbetsytan visas

githooks

Alternativ Typ Standard Beskrivning
commit boolean false Generera en analysbaserad pre-commit-hook när blockstudio-githooks sync körs

Se den hanterade commit-hooken för information om vad den genererade hooken kör och hur den hålls synkroniserad.

phpstan

Alternativ Typ Standard Beskrivning
preset string "base" Analysförval när kommandoraden inte väljer något: base, theme, extreme-theme eller wordpress-render
configuration string "" Projektets PHPStan-konfiguration som inkluderas tillsammans med förvalet, löst från blockstudio.json
roots array ["."] Temarötter som analyseras av det kanoniska kommandot
excludePaths array [] Ytterligare undantag för skannern i förhållande till varje konfigurerad rot
maxFiles integer 10000 Högsta antal filer som granskas av temaskannern
blockTags object {} Elementmappningar, taggalias och scanPhp för blocktaggregeln

Dessa inställningar styr det kanoniska kommandot blockstudio-phpstan. Se PHPStan för förinställningar, lager och användning.

ai

Alternativ Typ Standard Beskrivning
enableContextGeneration boolean false Generera en kombinerad kontextfil med block, inställningar, scheman och dokumentation för LLM-verktyg

Se AI-integration för dokumentationsindexet och den fullständiga genererade texten.

UI komponenter

Aktivera och kombinera de medföljande headless-komponenterna UI som introducerades i Blockstudio 7.3.