Към съдържанието

Настройки

Blockstudio включва мощен API за настройки API, който позволява задаване на опции чрез файл blockstudio.json в папката на темата и/или чрез филтри. Освен това потребителите с нужните права могат да променят настройките визуално в административната област.

Чрез JSON

Ако в папката на темата ви има файл blockstudio.json, той ще се използва за задаване на опциите по подразбиране за текущия сайт. Налична е схема JSON за валидиране на файла и за помощ при автоматичното довършване в IDE.

Файлът не е задължителен. Ако липсва, Blockstudio използва настройките, запазени в административната област, заедно с вградените си настройки по подразбиране. Добавянето, промяната или премахването на файла се засича автоматично, така че не е необходимо да изчиствате кеша или да презареждате ръчно.

Налични са следните свойства:

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
  }
}

Чрез филтри

Като алтернатива можете да използвате филтъра blockstudio/settings/${setting}, за да задавате опции чрез PHP с по-голяма гъвкавост.

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');

Опциите, зададени чрез филтъра blockstudio/settings/${setting}, имат предимство пред зададените във файла blockstudio.json. Можете да използвате двата метода заедно.

Стойностите по време на изпълнение предоставят и филтри blockstudio/performance/${setting}, както и един финален филтър blockstudio/performance/config. Последният трябва да връща валиден конфигурационен обект.

Как се подреждат източниците

Всеки източник се зарежда и обединява, като се започва от този с най-нисък приоритет:

  1. Вградени настройки по подразбиране
  2. Настройки, запазени чрез административния UI (опцията blockstudio_settings)
  3. blockstudio.json в темата
  4. Филтри blockstudio/settings/*

blockstudio.json заменя само ключовете, които декларира. Преди той заменяше изцяло запазените настройки, така че несвързана стойност, запазена от администратора, преставаше да се прилага веднага щом файлът се появеше; сега файлът се наслагва върху тях. Обратната страна е, че остаряла стойност, запазена чрез административния UI, продължава да се прилага, докато файлът не декларира този ключ или запазената стойност не бъде премахната. Ако дадена настройка се държи различно от описаното във файла, проверете запазения слой с wp bs settings или Settings::get_raw(), които връщат само това, което активният източник JSON или източникът на опции изрично е декларирал.

Четене на настройки от PHP

Blockstudio\Settings зарежда активния източник, съобщава за невалиден JSON и автоматично презарежда при промяна на blockstudio.json:

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);
}

Използвайте Settings::get_raw(), когато интеграцията се нуждае само от стойности, изрично декларирани от активния източник JSON или от източника с опции. Settings::fingerprint() връща детерминистична идентичност на ефективните настройки. Дълго работещите процеси могат изрично да извикат Settings::reload(), за да отчетат незабавно промяна във файл. При нормален достъп файлът се проверява най-много веднъж в секунда в рамките на заявка или дълго работещ PHP процес, включително при редакции, които не променят размера му. Промяната на конфигурирания път влиза в сила при следващото прочитане. Когато няма активен файл JSON, запазените настройки в базата данни не се забавят от този интервал.

Разрешеният профил на производителност е достъпен чрез Blockstudio\Runtime_Settings::current(). Поддържат се пътища с наклонена черта или точка:

PHP
use Blockstudio\Runtime_Settings;

$runtime = Runtime_Settings::current();

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

Налични настройки

users

Опция Тип По подразбиране Описание
ids array [] Потребителски ID с достъп до редактора
roles array [] Потребителски роли с достъп до редактора

assets

Опция Тип По подразбиране Описание
enqueue булева стойност true Автоматично поставяне на ресурсите на блоковете в опашка
reset.enabled булева стойност false Премахване на стиловете на основните блокове и прилагане на помощното нулиране за редактора
reset.fullWidth масив [] Типове публикации, които използват редактор с оформление на цялата ширина
minify.css булева стойност false Минифициране на изхода CSS
minify.js булева стойност false Минифициране на изхода JS
process.scss булева стойност false Обработка на файловете SCSS
output низ source Къде се записват компилираните ресурси: source или cache
inlineLimit цяло число 0 Брой байтове външен блоков CSS, изведени вградени за всяка страница

output по подразбиране е source, което създава директория _dist до всеки блок. Задайте cache, за да записвате компилираните ресурси в директорията за кеш Blockstudio, така че дървото с изходния код на блоковете да остане чисто и готово за внедряване от неизменяемо копие. Изходните файлове Blockstudio не могат да се записват, вече се пренасочват към кеша независимо от тази настройка.

inlineLimit е изключено при 0, затова всеки външен файл със стилове запазва своя елемент <link>. Задайте го на брой байтове, за да изведете вградени най-малките външни файлове със стилове на страницата, стига общият им размер да не надвишава този брой. 40000 е ограничението, което WordPress използва за същото правило. Вижте Вграждане на малки таблици със стилове.

Когато е активен reset.enabled, Blockstudio копира и пречистените стойности body_class на фронтенда в платното на редактора. Използвайте blockstudio/editor/canvas/body_class, за да настроите списъка с класове само за редактора.

cache

Опция Тип По подразбиране Описание
enabled boolean true Активиране на кешове, базирани на файлове Blockstudio
path string "blockstudio/cache" Път до кеша, относителен към WP_CONTENT_DIR или абсолютен
namespaceGrace integer 86400 Секунди, през които остарялото пространство от имена на кеша се запазва преди изчистване

По подразбиране файловете на кеша се записват в wp-content/blockstudio/cache, извън директорията за качени файлове. Относителният path се разрешава спрямо WP_CONTENT_DIR; абсолютният път се използва директно. Това поддържа хостове със специален том за кеш с възможност за запис.

Когато е активен, Blockstudio използва тази единствена коренова директория за полезни данни от компилации, предварително генерирани данни за регистрация на блокове, разрешени ресурси на редактора, Tailwind CSS, документи за визуализиране, фрагменти на острови, статични предварително визуализирани страници, графови индекси, опашки и диагностика. Всеки обект е изолиран по мрежа, сайт, пълна идентичност по време на изпълнение и обхват. Идентичностите по време на изпълнение обхващат Blockstudio, настройки, WordPress, PHP, активната тема, активните разширения, логическите източници за откриване, контекста на хоста и хешове на изрични зависимости, предоставени от операцията, която ги притежава.

Промените в съдържанието, термините, потребителите и метаданните обезсилват попълнените избори на полета, но не и структурното откриване на блокове или компилираните ресурси. Изборите се обновяват отделно при фиксирано заключване на пътя за компилация. Поредица от записи, например синхронизиране на превод или импортиране, се обединява: първият запис след период на затишие предизвиква незабавно обновяване, а последният запис от поредицата се отразява веднъж, след като изминат тридесет секунди — интервал, който може да се променя с blockstudio/cache/populate_debounce. Метаданните, които WordPress записва за административни цели, например заключването след редакция на публикация, не се считат за промяна; blockstudio/cache/populate_ignored_meta_keys допълва този списък. Редакторът винаги използва актуалните опции, така че този период засяга само кешираните избори, прочитани при визуализиране. Файловете с изходен код и настройките за компилация продължават да обезсилват структурния кеш по обичайния начин. При презаписване на изборите кеш директорията не се сканира отново при всяка промяна в съдържанието; периодичното почистване продължава да премахва осиротелите временни файлове. Идентичностите по време на изпълнение, специфични за езика, остават изолирани; наличието на няколко директории с пространства от имена на кеша в многоезичен сайт само по себе си не е доказателство за пропуск в кеша.

SQLite активността в журнала в директорията с данни на блока db не премахва кешираните метаданни на блока. Промените в db.php, наблюдаваните файлове с изходен код или структурата на файловете с изходен код и поддиректориите в директорията с данни продължават да обезсилват кеша.

При паралелни повторни компилации на средата един компилатор се избира да изпълни задачата. Другите заявки чакат до пет секунди, след което използват последните валидни метаданни за блоковете, ако изходните им файлове и необходимите компилирани ресурси все още съществуват. Заявка без предварително генерирани данни и без безопасен полезен товар връща HTTP 503 с Retry-After, вместо да започне нова компилация. Филтърът blockstudio/cache/build_wait_budget настройва времето за изчакване в милисекунди както за структурните повторни компилации, така и за обновяването на изборите. Хост без консултативни заключвания на файлове обновява изборите без защита и въпреки това ги публикува, така че следващата заявка да ги намери в кеша.

Неактивните файлове .build.lock със специфични за ключа имена, оставени от по-стари версии, се събират във всички пространства от имена на кеша на този сайт чрез WP-Cron, като процесът започва пет минути след надстройката и премахва до 10,000 заключвания на минута в рамките на десет секунди. wp bs cache status съобщава оставащия брой, а wp bs cache cleanup незабавно изпразва опашката; wp bs cache clear изчиства кеша на средата по време на изпълнение. Ако планирана партида закъснее с повече от десет минути, защото cron не се изпълнява, заявките преглеждат ограничен брой заключвания веднъж на час, за да не блокира изпразването. Скорошните или задържаните заключвания се оставят непокътнати, а новите заключвания с фиксиран път никога не се събират. След изпразване на опашката същата партида събира изоставените пространства от имена на кеша, след като изтече namespaceGrace, най-много веднъж на час за всеки сайт, и продължава да изпълнява дневен цикъл за това. Гратисният период се отчита от първото сканиране, което установи, че дадено пространство от имена е изоставено, а не от най-новия му файл; пространство от имена, което все още е текущо за някой от обхватите си, никога не се събира. Вътрешното почистване на кеша не задейства филтрите WordPress за изтриване на прикачени файлове. Хостовете с изключен WP-Cron трябва да продължат да изпълняват обичайния си планиран работник cron; не изтривайте безразборно активни файлове за заключване, за да изпразните опашката.

Филтърът за настройката blockstudio/settings/cache/path променя конфигурираната стойност. За разрешаване на пътища според средата на внедряване филтърът blockstudio/cache/dir променя разрешената основна директория:

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

Хостовете с идентичност на клиент, различна от идентификаторите на мрежа/блог WordPress, могат да филтрират blockstudio/cache/site_key. Резултатът се пречиства и се използва само като сегмент от директория. blockstudio/cache/context остава правилното място за сериализуем вариант на средата по време на изпълнение, който трябва да променя идентичностите на обектите.

themeDefaults

Опция Тип По подразбиране Описание
titleTag boolean false Активиране на поддръжката на тага title за темата WordPress
suppressDirectoryUpdates boolean false Премахване на активните дъщерни и родителски теми от резултатите при актуализиране на директорията

Шаблоните продължават да използват съществуващите Blockstudio\Patterns API; тези настройки по подразбиране не въвеждат алтернативни фасади за страници или шаблони.

performance

Профилът compat оставя общото поведение на WordPress непроменено. speed и strict активират същите настройки по подразбиране за фронтенда; всяка дъщерна настройка може да замени стойността на профила.

Настройките за включване са условия за регистрация. Когато незадължителна функция е false, Blockstudio не прикачва свързаните с нея колбекове за фронтенда, администрацията, редактора, REST или графика. След използване на Early Serve или планирано подгряване изключването им извършва веднъж почистването, за което отговарят; следващите заявки не предприемат действия.

Опция Тип Стандартна стойност за съвместимост Стандартна стойност за скорост/строгост Описание
profile string "compat" Неприложимо compat, speed или strict
wordpress.headNoise boolean false true Премахва общото откриване в head и извеждането на емоджита
wordpress.embeds boolean false true Премахва откриването чрез oEmbed и скриптовете за хостове
wordpress.xmlrpc boolean false true Деактивира XML-RPC и pingbacks
wordpress.editor boolean false true Деактивира отдалечените интерфейси за откриване на редактора
wordpress.frontendAssets boolean false true Премахва общите основни ресурси за фронтенда
wordpress.media boolean false true Прилага стандартни настройки за извеждане на изображения
wordpress.heartbeat boolean false true Ограничaва Heartbeat извън редакторите
preload.links string "off" "intent" Предварително зарежда документи от същия източник след действие на потребителя
media.lazy boolean false true Използва зареждащия механизъм за изображения на Blockstudio
media.skeleton boolean false true Показва вградения скелет за зареждане
media.metadata boolean false true Декларира използването на assets/media.json
media.rootMargin string "300px" "300px" Отместване на пресичане за мързеливото зареждане
measurement.enabled boolean false false Активира API за измерване по време на изпълнение
measurement.queryMonitor boolean false false Включва заявки с продължителност поне 50ms
measurement.headers boolean false false Изпраща заглавки с хешове на профила и конфигурацията
measurement.timings boolean false false Изпраща заглавка с изминалото време на изпълнение
staticPrerender.enabled boolean false false Активира кеширане на HTML, безопасно за анонимни потребители
staticPrerender.ttl integer 86400 86400 Максимална възраст на кеширан документ в секунди
staticPrerender.invalidate string "signature" "signature" Използва идентичност signature или инкрементална идентичност graph
staticPrerender.earlyServe boolean false false Предоставя безопасните попадения преди стартирането на WordPress
staticPrerender.serveLoggedIn boolean false false Позволява на потребителите да използват, но не и да създават попадения в кеша
staticPrerender.dynamicPaths array [] [] Префикси на пътища, които трябва да останат динамични
staticPrerender.replayHeaders array ["Link"] ["Link"] Заглавки на отговорите, съхранявани и изпращани при попадения в кеша
staticPrerender.warm.enabled boolean false false Активира постоянната опашка за планирано затопляне
staticPrerender.warm.interval integer 3600 3600 Интервал за затопляне в секунди
staticPrerender.warm.concurrency integer 2 2 Максимален брой задачи, обработени при едно затопляне
staticPrerender.warm.transport string "http" "http" Използва http или предоставен от хоста визуализатор internal

Статичното предварително визуализиране остава деактивирано, освен ако не бъде изрично активирано. Деактивиран главен превключвател не регистрира куки за заявки за предварително визуализиране, а деактивираните превключватели earlyServe и warm.enabled не регистрират куки за администриране или cron. Режимът на подпис използва евтина активирана идентичност при обикновени заявки. Режимът на граф е предназначен за изрични компилации: той записва зависимостите от източника за всяка страница, така че промяна в една страница да не обезсилва несвързани документи. Вижте Статично предварително визуализиране за подробности относно затоплянето, внедряването, ранното предоставяне и безопасността.

Измерванията са достъпни програмно:

PHP
use Blockstudio\Performance_Measurement;

$snapshot = Performance_Measurement::snapshot();

Когато заглавките са активирани, Blockstudio изпраща X-Blockstudio-Performance-Profile, X-Blockstudio-Performance-Config и по избор X-Blockstudio-Performance-Time. Действието blockstudio/performance/measurement_enabled получава разрешените настройки за изпълнение.

Опциите media управляват bs_media_image(), манифеста на assets/media.json и lazy loader-а на frontend-а. Вижте Медия за помощната функция, генератора на манифеста и поведението на loader-а.

content

Опция Тип Стойност по подразбиране Описание
enabled boolean false Активира конфигурацията на Content Sync
id string "default" Пространство от имена на набора от съдържание, съхранявано в синхронизираните обекти
path string "content" Директория с файлове със съдържание, относителна към темата
includePageSyncManaged boolean false Включва публикации, управлявани от Page Sync, без да притежава съдържанието им
authors string "ignore" Обработка на авторите (ignore или login за съществуващ потребител)
postTypes array [] Разрешени типове публикации
meta.include array [] Glob шаблони за мета ключове за синхронизиране
meta.exclude array ["_edit_lock", "_edit_last", "_wp_old_slug"] Glob шаблони за мета ключове за изключване
meta.references object {} Декларирани мета препратки, пренаписвани между ID и UID
taxonomies array [] Разрешени регистрирани таксономии за термини и връзки
media string "manifest" Поведение при препратки към прикачени файлове (manifest или none)

Content Sync се управлява чрез wp bs content и проектира разрешените публикации, postmeta и декларираните препратки в преносими файлове. Вижте Content Sync за работния процес и файловия формат.

editor

Опция Тип Стойност по подразбиране Описание
formatOnSave boolean false Форматира block.json при запис
assets array [] Допълнителни ресурси за зареждане в редактора
markup boolean false Активира редактиране на маркировката

tailwind

Опция Тип Стойност по подразбиране Описание
enabled boolean false Активира компилацията на Tailwind CSS
config string "" Конфигурация Tailwind v4 с приоритет CSS

Вижте Tailwind CSS за поведението при компилация и формата на конфигурацията с приоритет CSS.

blockTags

Опция Тип Стойност по подразбиране Описание
enabled boolean false Активира визуализирането на етикети bs: на ниво страница в съдържанието на публикации и областите на уиджети
allow array [] Списък с разрешени шаблони за имена на блокове; поддържа заместващи символи fnmatch()
deny array [] Списък с отхвърлени шаблони за имена на блокове; има предимство пред allow
prefixes object {} Префикс за групиране на кратките имена; всяка стойност е пространство от имена или подреден масив

Визуализирането на етикети на ниво шаблон е винаги активно; тези опции управляват заместването на ниво страница. Вижте Визуализиране за синтаксиса на етикетите и правилата за разрешаване.

ui

Опция Тип Стойност по подразбиране Описание
enabled boolean false Регистрира включените компоненти bsui/* UI и демонстрационните приложения на app/*

blockEditor

Опция Тип Стойност по подразбиране Описание
disableLoading boolean false Деактивира зареждането на блокове в редактора
enhance boolean false Активира възможностите на редактора Blockstudio за посочване и избиране
cssClasses array [] URL адреси на стилови таблици, от които да се извлекат класове CSS за автодовършване в полето за класове
cssVariables array [] URL адреси на стилови таблици, от които да се извлекат променливи CSS за автодовършване в полето за код

blockEditor.blocks

Използвайте blockEditor.blocks за обща за проекта политика на вмъквача на блокове. allow и deny приемат имена на блокове и шаблони със заместващи символи, като 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 премахва регистрацията на стилове, регистрирани чрез системния регистър на стилове на блокове на WordPress PHP:

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

blockEditor.patterns

Използвайте blockEditor.patterns, за да деактивирате глобалните източници на шаблони и да филтрирате категориите шаблони.

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

blockEditor.media

Използвайте blockEditor.media за обща политика на вмъквача на медии.

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

dev

Опция Тип Стойност по подразбиране Описание
grab.enabled boolean false Активира инструмента за извличане на елементи от frontend-а
perf boolean false Активира профайлера на производителността при всяко зареждане на страница
canvas.enabled boolean false Активира платното
canvas.adminBar boolean true Показва администраторската лента на WordPress при преглед на платното

githooks

Опция Тип Стойност по подразбиране Описание
commit boolean false Генерира управлявана кука за предварително потвърждение само за анализ, когато се изпълнява blockstudio-githooks sync

Вижте управляваната кука за потвърждение за информация какво изпълнява генерираната кука и как остава синхронизирана.

phpstan

Опция Тип Стойност по подразбиране Описание
preset string "base" Предварителна настройка за анализ, когато командният ред не избира такава: base, theme, extreme-theme или wordpress-render
configuration string "" Конфигурация PHPStan на проекта, включена заедно с предварителната настройка и зареждана от blockstudio.json
roots array ["."] Основни директории на теми, анализирани от каноничната команда
excludePaths array [] Допълнителни изключения за скенера спрямо всяка конфигурирана основна директория
maxFiles integer 10000 Максимален брой файлове, проверявани от скенера на теми
blockTags object {} Съответствия между елементи, псевдоними на етикети и scanPhp за правилото за етикети на блокове

Тези настройки управляват каноничната команда blockstudio-phpstan. Вижте PHPStan за предварителни настройки, слоеве и внедряване.

ai

Опция Тип Стойност по подразбиране Описание
enableContextGeneration boolean false Генерира комбиниран контекстен файл с блокове, настройки, схеми и документация за инструменти LLM

Вижте AI интеграция за индекса на документацията и пълния генериран текст.

UI Компоненти

Активирайте и комбинирайте включените безглави компоненти UI, въведени в Blockstudio 7.3.