انتقل إلى المحتوى

خطافات PHP

فيما يلي قائمة بجميع خطافات PHP المتاحة، والتي يمكنك استخدامها لتوسيع وظائف الإضافة أو تعديلها.

المسار

يتيح لك هذا المرشح تعديل مسار مجلد الكتلة. يكون المسار افتراضيًا blockstudio داخل القالب النشط حاليًا. ويمكنك بدلًا من ذلك إنشاء نسخة جديدة لاستخدام أدلة مصدر متعددة.

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

التهيئة

عام

يُفعّل هذا الإجراء بعد أن تسجل الإضافة جميع الكتل.

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

النسخة

يُفعّل هذا الإجراء بعد أن تسجل الإضافة جميع كتل نسخة محددة. ويمثل الجزء $instance مسار النسخة نسبةً إلى 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

يُفعّل هذا الإجراء قبل أن تسجل الإضافة جميع الكتل.

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

global/before/$instance

يُفعّل هذا الإجراء قبل أن تسجل الإضافة جميع كتل نسخة محددة.

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

الكتل

العرض

يتيح لك هذا المرشح تعديل مخرجات الكتلة قبل عرضها.

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

البيانات الوصفية

يتيح لك هذا المرشح تعديل بيانات ملف block.json قبل تسجيله.

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

سيغيّر الكود أعلاه أيقونة جميع الكتل التي تبدأ بـ marketing.

الشروط

يتيح لك هذا المرشح إضافة شروط مخصصة يمكن استخدامها داخل الكتل. ويرتبط كل نوع من الشروط بقيمة يقارنها المحرر مع value الشرط. راجع الشروط المخصصة.

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

السمات

يعدّل هذا المرشح تعريف حقل واحد قبل تسجيل الكتلة. ويُستخدم التعريف بعد تصفيته للتحكم في المحرر والتحقق من قيمة وقت العرض. راجع التصفية لمزيد من المعلومات.

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

attributes/render

يعدّل هذا المرشح قيمة حقل واحد قبل تمريرها إلى قالب الكتلة. ويُشغّل مرة واحدة لكل حقل، ويتلقى ثلاث وسيطات: $value (القيمة المحلولة)، و$key (مفتاح الحقل كما يُستخدم في $a)، و$block (مصفوفة بيانات الكتلة التي تتلقاها القوالب كـ $block أو $b). سجّله مع تحديد ثلاث وسيطات مقبولة. راجع التصفية لمزيد من المعلومات.

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

يعيد حقل files كل صورة مع مصفوفة sizes تحتوي على URL والعرض والارتفاع لكل من full ولكل حجم صورة مسجل، مثل $image['sizes']['thumbnail'] و$image['sizes']['thumbnail-width']. يُجرى استدعاء wp_get_attachment_image_src() واحد لكل صورة ولكل حجم، لذا تظل مرشحاته سارية. ويمكن للقوالب التي لا تقرأ sizes حذف القائمة أو تقصيرها.

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 هي قائمة أسماء الأحجام، ويأتي full أولًا (وتكون فارغة إذا لم تُسجّل أحجام وسيطة). $id هو معرّف المرفق، و$size هو الحجم المطلوب لـ url القيمة. يغيّر المرشح مصفوفة sizes الخاصة بكل قيمة ملفات في الطلب. ومن دونه، تبقى المصفوفة كما هي.

أعِد أسماء الأحجام كسلاسل نصية. تُتجاهل العناصر غير الصالحة، وتُحلّ الأسماء المكررة مرة واحدة، كما يؤدي إرجاع قيمة ليست مصفوفة إلى تخطي الأحجام. تظل url المطلوبة وخصائص المرفق الأخرى دون تغيير. لا يعمل هذا الخطاف مع حقل files الذي يحتوي على returnFormat: "url"، إذ لا ينشئ خريطة للأحجام.

attributes/validate

عدّل النتائج الناتجة عن استدعاءات bs_validate_block() الصريحة، مثلًا عندما يحلّ مرشح عرض مخصص المراجع المخزنة. لا يؤدي ذلك إلى تفعيل التحقق التلقائي عند الحفظ أو العرض.

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

أعِد قائمة بالنتائج. لا يُستدعى المرشح إذا لم يتضمن المكوّن حقول Blockstudio أو امتدادات مطابقة (null).

attributes/schema

عدّل مخطط JSON الذي تُعيده bs_block_schema()، مثلًا عندما يحلّ مرشح عرض مخصص المراجع المخزنة.

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

أعِد مصفوفة المخطط. لا يُستدعى المرشح عندما لا يتضمن المكوّن حقول Blockstudio أو امتدادات مطابقة (null).

attributes/populate

يتيح لك هذا المرشح إضافة بيانات مخصصة إلى خيارات حقل checkbox أو select أو radio. راجع تعبئة الخيارات لمزيد من المعلومات.

يتلقى المرشح وسيطًا واحدًا: مصفوفة بجميع مجموعات البيانات المخصصة، مفهرسة بالاسم المستخدم في "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

يتيح لك هذا المرشح تعديل مخرجات محتوى useBlockProps.

تتلقى جميع مرشحات المكوّنات (use_block_props وinner_blocks وrich_text) المكوّن بوصفه الوسيط الأخير. $block هو WP_Block_Type المسجّل للمكوّن الجاري عرضه، لذا فإن $block->name هو اسم المكوّن، مثل acme/hero.

$props سلسلة من خصائص HTML، وليست مصفوفة. في الواجهة الأمامية، تكون ناتج get_block_wrapper_attributes()، مثل class="wp-block-acme-hero my-class". وفي المحرر، تكون خاصية class للعنصر. أعِد سلسلة نصية. في المحرر، لا تُطبّق من السلسلة المُعادة إلا خاصية class.

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

يتيح لك هذا المرشح تعديل مخرجات محتوى <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

يتيح لك هذا المرشح إزالة الغلاف <InnerBlocks /> من الواجهة الأمامية.

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

components/rich_text/render

يسمح لك هذا المرشح بتعديل ناتج محتوى <RichText />. ويتلقى قيمة الخاصية والمكوّن.

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

وسوم الكتل

blockstudio/block_tags/builders

يسجل هذا المرشح منشئات مصفوفات الكتل التي تستخدمها وسوم الكتل والكتل المخصصة المحددة عبر blockstudio/parser/element_mapping. ويتلقى كل منشئ السمات المحللة والمحتوى الداخلي الخام.

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

يُشغّل المرشحان المتوافقان blockstudio/block_tags/renderers وblockstudio/parser/renderers بعد هذا الخطاف، ويمكنهما تجاوز الاسم نفسه للكتلة.

blockstudio/block_tags/tag_aliases

يتيح لك هذا المرشح تسجيل وسوم تأليف مخصصة مفصولة بشرطات، تُحل إلى أسماء كتل فعلية قبل الرجوع إلى HTML الخام. وهذا مفيد عندما يريد القالب واجهة وسوم موجزة خاصة بالمشروع مع الاستمرار في عرض Blockstudio القياسية أو كتل النواة.

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

يتيح لك هذا المرشح ربط الاختصارات البادئة بواحدة أو أكثر من مساحات أسماء الكتل. يجب أن يكون كل مفتاح بادئة بأحرف لاتينية صغيرة من دون شرطات. ويمكن أن تكون كل قيمة سلسلة لمساحة أسماء أو قائمة مرتبة بمساحات الأسماء.

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> إلى theme-components/card. وتجرّب <theme-button> theme-components/button أولًا، ثم تنتقل إلى bsui/button. وتكون إدخالات blockstudio/block_tags/tag_aliases الصريحة ذات أولوية للوسم نفسه، وتُترك الوسوم ذات البادئات التي لم تُحل دون تغيير.

تتداخل البادئات: إذا لم يُحل الوسم ذو البادئة مباشرةً وكان مقطعه هو نفسه وسم بادئة مسجلًا، يتكرر الحل. مع theme => ['theme-components'] وui => ['bsui']، ينتقل <theme-ui-input> إلى البادئة ui ويُحل إلى bsui/input. كما تُعرض وسوم البادئات والأسماء المستعارة المسجلة في مخرجات قوالب الكتل، وليس في محتوى الصفحات فقط.

الإعدادات

المسار

يتيح لك هذا المرشح تعديل مسار الملف blockstudio.json. ويكون افتراضيًا blockstudio.json داخل القالب النشط حاليًا.

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

users/ids

يتيح لك هذا المرشح تمكين المحرر لمعرّفات مستخدمين محددة.

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

users/roles

يتيح لك هذا المرشح تمكين المحرر لأدوار مستخدمين محددة.

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

assets/enqueue

يتيح لك هذا المرشح تمكين أو تعطيل إدراج الأصول في الواجهة الأمامية والمحرر.

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

assets/reset/enabled

يتيح لك هذا المرشح تمكين أو تعطيل إزالة أنماط الكتل الأساسية WordPress وإعادة ضبط تخطيط أدوات المحرر.

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

assets/reset/full_width

يتيح لك هذا المرشح التحكم في أنواع المقالات التي تستخدم التحرير بعرض كامل.

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

assets/minify/css

يتيح لك هذا المرشح تمكين تصغير CSS أو تعطيله.

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

assets/minify/js

يتيح لك هذا المرشح تمكين تصغير JS أو تعطيله.

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

assets/process/scss

يتيح لك هذا المرشح تمكين معالجة SCSS في ملفات .css أو تعطيلها.

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

assets/process/scss_files

يتيح لك هذا المرشح تمكين معالجة ملفات .scss إلى CSS أو تعطيلها.

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

assets/output

يتيح لك هذا المرشح التحكم في مكان كتابة أصول الكتل المجمعة.

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

assets/inline_limit

يحدد هذا المرشح عدد بايتات CSS المكوّن الخارجي التي تُضمّن في كل صفحة.

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

cache/enabled

يتيح لك هذا المرشح تمكين جميع ذاكرات التخزين المؤقت لملفات Blockstudio الخاصة بوقت التشغيل وأصول المحرر أو تعطيلها.

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

cache/path

يتيح لك هذا المرشح تغيير دليل ذاكرة التخزين المؤقت المعتمد على الملف Blockstudio.

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

cache/namespace_grace

يتيح لك هذا المرشح تغيير مدة الاحتفاظ بمساحة أسماء ذاكرة تخزين مؤقت متوقفة قبل حذفها.

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

githooks/commit

يكشف هذا المرشح ما إذا كان خطاف الإيداع PHPStan الذي تديره Blockstudio مفعّلًا.

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

content/enabled

يتيح لك هذا المرشح تمكين مزامنة المحتوى أو تعطيلها.

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

content/id

يتيح لك هذا المرشح تعيين مساحة أسماء ملكية مزامنة المحتوى.

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

content/path

يتيح لك هذا المرشح تعيين دليل ملفات مزامنة المحتوى.

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

content/include_page_sync_managed

يتيح لك هذا المرشح تضمين المقالات التي تديرها مزامنة الصفحات أو استبعادها.

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

content/authors

يتيح لك هذا المرشح ضبط التعامل مع مؤلفي مزامنة المحتوى.

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

content/post_types

يتيح لك هذا المرشح ضبط قوائم السماح لأنواع مقالات مزامنة المحتوى.

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

content/taxonomies

يتيح لك هذا المرشح ضبط قوائم السماح لتصنيفات مزامنة المحتوى.

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

content/media

يتيح لك هذا المرشح ضبط التعامل مع وسائط مزامنة المحتوى.

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

tailwind/enabled

يتيح لك هذا المرشح تمكين Tailwind أو تعطيله.

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

tailwind/config

يتيح لك هذا المرشح إضافة إعداد Tailwind CSS مخصص.

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

tailwind/output

يتيح لك هذا المرشح اختيار إخراج Tailwind CSS مضمّنًا أو مرتبطًا.

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

ui/enabled

يتيح لك هذا المرشح تمكين مكونات UI المضمّنة أو تعطيلها.

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

editor/format_on_save

يتيح لك هذا المرشح تمكين تنسيق الكود عند الحفظ أو تعطيله.

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

editor/assets

يتيح لك هذا المرشح إدراج أصول إضافية في المحرر.

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

editor/markup

يتيح لك هذا المرشح إضافة ترميز إضافي في نهاية المحرر.

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

block_editor/disable_loading

يتيح لك هذا المرشح تعطيل تحميل الكتل داخل محرر الكتل.

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

block_editor/enhance

يتيح لك هذا المرشح تفعيل إمكانات محرر Blockstudio، مثل أنماط التركيز الأكثر وضوحًا وحدود التمرير أو التحديد.

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

block_editor/css_classes

يتيح لك هذا المرشح إضافة أوراق أنماط لتكون فئاتها متاحة للاختيار في حقل الفئات.

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

block_editor/css_variables

يتيح لك هذا المرشح إضافة أوراق أنماط لتكون متغيرات CSS فيها متاحة للإكمال التلقائي في حقل الكود.

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

block_editor/blocks/allow

يتيح لك هذا المرشح التحكم في أسماء الكتل المسموح بها في أداة الإدراج.

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

block_editor/blocks/deny

يتيح لك هذا المرشح إزالة أسماء الكتل من أداة الإدراج.

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

block_editor/blocks/directory

يتيح لك هذا المرشح تمكين أصول دليل الكتل WordPress في المحرر أو تعطيلها.

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

block_editor/blocks/categories/allow

يتيح لك هذا المرشح التحكم في معرّفات فئات الكتل التي تظل متاحة.

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

block_editor/blocks/categories/deny

يتيح لك هذا المرشح إزالة معرّفات فئات الكتل من أداة الإدراج.

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

block_editor/blocks/categories/rename

يتيح لك هذا المرشح إعادة تسمية تسميات فئات الكتل حسب المعرّف.

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

block_editor/blocks/categories/order

يتيح لك هذا المرشح ترتيب معرّفات فئات الكتل في أداة الإدراج.

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

block_editor/blocks/styles/deny

يتيح لك هذا المرشح إلغاء تسجيل أنماط الكتل المسجلة بواسطة 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

يتيح لك هذا المرشح إخفاء عناصر واجهة المستخدم القديمة الإضافية من كتلة عناصر واجهة المستخدم القديمة.

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

block_editor/patterns/core

يتيح لك هذا المرشح تمكين أنماط الكتل الأساسية في WordPress أو تعطيلها.

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

block_editor/patterns/remote

يتيح لك هذا المرشح تمكين الأنماط البعيدة من دليل الأنماط WordPress أو تعطيلها.

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

block_editor/patterns/theme

يتيح لك هذا المرشح تمكين أنماط الكتل التي يوفرها القالب أو تعطيلها.

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

block_editor/patterns/blockstudio

يتيح لك هذا المرشح تمكين الأنماط المعتمدة على الملفات في Blockstudio أو تعطيلها.

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

block_editor/patterns/categories/allow

يتيح لك هذا المرشح التحكم في معرّفات فئات الأنماط التي تظل متاحة.

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

block_editor/patterns/categories/deny

يتيح لك هذا المرشح إزالة معرّفات فئات الأنماط من أداة إدراج الأنماط.

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

block_editor/patterns/categories/rename

يتيح لك هذا المرشح إعادة تسمية تسميات فئات الأنماط حسب المعرّف.

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

block_editor/patterns/categories/order

يتيح لك هذا المرشح ترتيب معرّفات فئات الأنماط في أداة الإدراج.

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

block_editor/media/openverse

يتيح لك هذا المرشح تمكين فئة وسائط Openverse في أداة إدراج الوسائط بمحرر الكتل أو تعطيلها.

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

block_editor/media/image_sizes/allow

يتيح لك هذا المرشح التحكم في أسماء أحجام الصور التي تظل متاحة في عناصر التحكم بوسائط المحرر.

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

block_editor/media/image_sizes/deny

يتيح لك هذا المرشح إزالة أسماء أحجام الصور من عناصر التحكم بوسائط المحرر.

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

ai/enable_context_generation

يتيح لك هذا المرشح تمكين إنشاء ملف سياق لتكامل أدوات LLM أو تعطيله. عند تفعيله، يجمع ملف السياق بيانات الكتل الحالية وإعدادات Blockstudio للتثبيت الحالي وجميع المخططات ذات الصلة ووثائق Blockstudio في مصدر واحد لاستخدامه مع أدوات التطوير بالذكاء الاصطناعي.

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

block_tags/enabled

يتيح لك هذا المرشح تمكين عرض وسوم الكتل على مستوى الصفحة أو تعطيله.

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

block_tags/prefixes

يتيح لك هذا المرشح تسجيل اختصارات البادئات لمساحات الأسماء لوسوم الكتل.

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

dev/grab/enabled

يتيح لك هذا المرشح تمكين أداة التقاط العناصر أو تعطيلها.

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

dev/perf

يتيح لك هذا المرشح تمكين محلل أداء النظام أو تعطيله.

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

dev/canvas/enabled

يتيح لك هذا المرشح تمكين لوحة الرسم أو تعطيلها.

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

dev/canvas/admin_bar

يتيح لك هذا المرشح إظهار شريط الإدارة WordPress على لوحة الرسم أو إخفاءه.

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

WPML

blockstudio/wpml/config/label

يرشّح تسمية كل مفتاح يكتبه wp bs wpml config. راجع تغيير التسميات لمعرفة مصفوفة السياق.

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

لوحة الرسم

blockstudio/canvas/inventory

يعدّل هذا المرشح قائمة الجرد التي تعرضها لوحة الرسم لاختيار ما. ويتلقى رد الاتصال كائن نقل بيانات الجرد والاختيار الأصلي والخيارات التي استُدعي بها.

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

blockstudio/canvas/documents

يعدّل هذا المرشح المستندات المعروضة التي تعيدها لوحة الرسم، باستخدام الوسيطات الثلاثة نفسها لمرشح الجرد.

blockstudio/canvas/item_loaded

يُطلَق هذا الإجراء مرة واحدة لكل سجل جرد عند تحميله، ويتلقى نوع الجرد ومعرّف السجل المعتمد والسجل بعد توحيد صيغته.

blockstudio/canvas/source_compiled

يُطلَق هذا الإجراء بعد تجميع ملف مصدر للوحة الرسم، ويتلقى مسار المصدر المحدد وسجل المصدر المعتمد.

UI المضمّنة

blockstudio/ui/directories

يعدّل هذا المرشح الأدلة التي يجري فحصها بحثًا عن مكونات UI المضمّنة.

blockstudio/ui/inventory

يضبط هذا المرشح مخزون عائلات UI العامة.

blockstudio/ui/examples

يضبط هذا المرشح سجلات أمثلة UI، ويتلقى الأمثلة ومخزون UI العام الذي اشتُقت منه.

البنية

blockstudio/blocks/topology_refreshed

يُفعّل هذا الإجراء بعد إعادة بناء بنية الكتل.

blockstudio/pages/topology_refreshed

يُفعّل هذا الإجراء بعد إعادة بناء بنية الصفحة.

blockstudio/pages/layout_error

يُفعّل هذا الإجراء عند تعذّر عرض تخطيط الصفحة، بدلًا من الفشل بصمت.

وقت التشغيل

blockstudio/runtime/initialized

يُفعّل هذا الإجراء بعد أن يحلّ وقت التشغيل إعداداته.

blockstudio/runtime/changed

يُفعّل هذا الإجراء عند تغيّر هوية وقت التشغيل المحلولة، ما يؤدي إلى نقل مساحات أسماء ذاكرة التخزين المؤقت وحالة العرض المسبق الثابت.

blockstudio/performance/default_config

يضبط هذا المرشح الإعدادات الافتراضية للأداء قبل إضافة قيم blockstudio.json الخاصة بالمشروع إليها.

المحتوى

blockstudio/content/orphan_action

يحدد هذا المرشح ما يفعله مزامنة المحتوى بسجل لم يعد له مصدر.

Bootstrap

blockstudio/url

يغيّر هذا المرشح URL العام المستخدم لأصول المحرر ولوحة الإدارة في Blockstudio. يجب أن تسجّل تكاملات Composer هذا المرشح قبل تحميل ملف التحميل التلقائي لـ Blockstudio. الوسيطة الثانية هي دليل الحزمة الفعلي.

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

ذاكرة التخزين المؤقت لوقت التشغيل

blockstudio/cache/dir

يتلقى هذا المرشح الدليل الأساسي المحلول لذاكرة التخزين المؤقت قبل إضافة نطاق وقت التشغيل أو أصول المحرر أو أي نطاق آخر إليه.

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

blockstudio/cache/context

يضيف هذا المرشح متغيرًا قابلًا للتسلسل لوقت التشغيل إلى هويات ذاكرة التخزين المؤقت. استخدمه عندما يستطيع مصدر الاكتشاف نفسه اختيار مخزونات منطقية مختلفة.

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

يغيّر هذا المرشح هوية دليل الشبكة/المدونة للمضيفين الذين لديهم حدود مستأجر خاصة بهم. تُنقّى القيمة المعادة قبل استخدامها.

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

يضيف هذا المرشح حقائق المضيف التي تؤثر في كل كائن ضمن نطاق وقت التشغيل. يجب تمرير بصمات المصدر الخاصة بكل عنصر كتبعيات صريحة من 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

يحدد هذا المرشح عدد الثواني التي يمكن خلالها إعادة استخدام لقطة مراقبة ملفات تم التحقق منها دون إجراء فحص آخر لنظام الملفات. القيمة الافتراضية هي 0 في البيئات المحلية وبيئات التطوير، و20 في غيرها.

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

blockstudio/cache/build_wait_budget

يحدد هذا المرشح مدة انتظار الطلب، بالمللي ثانية، لناشر متزامن كي ينشر ذاكرة التخزين المؤقت لوقت التشغيل أو يحدّث الخيارات المُعبأة قبل الانتقال إلى وضع أقل جودة. القيمة الافتراضية هي 5000 لعمليات إعادة البناء البنيوية و4000 لتحديث الخيارات.

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

blockstudio/cache/populate_debounce

يحدد هذا المرشح عدد الثواني التي تُجمع خلالها عمليات الكتابة المتتابعة للمحتوى أو المصطلحات أو المستخدمين أو البيانات الوصفية في تحديث واحد للخيارات المُعبأة. تُحدّث أول كتابة بعد فترة هدوء النتائج فورًا؛ وتظهر نتائج آخر كتابة في سلسلة متتابعة بعد انقضاء المهلة. القيمة الافتراضية هي 30. أعد 0 للتحديث عند كل كتابة.

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

blockstudio/cache/populate_ignored_meta_keys

يرشّح مفاتيح البيانات الوصفية التي لا تؤدي كتاباتها مطلقًا إلى تحديث الخيارات المعبأة. افتراضيًا، تشمل هذه المفاتيح ما يكتبه WordPress لأغراض تتبع التحرير وتسجيل الدخول: _edit_lock، التي يحدّثها المحرر وHeartbeat أثناء فتح المقالة، و_edit_last، التي تُكتب عند حفظ المقالة الذي يجري التحديث أصلًا، وsession_tokens، التي تُكتب عند تسجيل الدخول والخروج. أضف المفاتيح التي تتغير كثيرًا لكنها لا تؤثر مطلقًا في استعلام التعبئة.

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

blockstudio/cache/max_files_per_scope

يحدد هذا المرشح عدد الحمولات المنشورة التي يحتفظ بها كل نطاق من ذاكرة التخزين المؤقت لوقت التشغيل.

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

blockstudio/cache/compress

يرشّح ما إذا كانت حمولة ذاكرة التخزين المؤقت تستخدم بيانات متسلسلة مضغوطة بدلًا من مصفوفة PHP عادية. افتراضيًا، تُستخدم الصيغة العادية للحمولات التي لا يتجاوز حجمها 1 MiB، وفقط عندما تكون الذاكرة المشتركة لـ OPcache نشطة وقادرة على تخزين الملف الهدف. أما العمليات الأخرى والملفات المستثناة والحمولات الأكبر فتستخدم الضغط.

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

يتجاوز إرجاع false حدّ الحجم أيضًا. قد يفيد ذلك عندما يقوم WP-CLI بتهيئة الملفات للعاملين على الويب المفعّل لديهم OPcache دون opcache.enable_cli، لكن كل قارئ لا يستخدم OPcache سيحلل المصفوفة المُنشأة. أبقِ الضغط للحمولات الكبيرة المشتركة، إلا إذا كانت كلفة الذاكرة الإضافية مقبولة. راجع تنسيقات حمولة ذاكرة التخزين المؤقت لمعرفة وسائل الحماية الافتراضية.

blockstudio/cache/protected_paths

يحدد هذا المرشح مسارات ذاكرة التخزين المؤقت التي يجب ألا تحذفها عملية التنقيح. يضيف Blockstudio كل ملف تشير إليه خريطة التقديم المبكر المثبتة.

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

يبلّغ هذا الإجراء عن نطاق مشترك لذاكرة التخزين المؤقت ونتيجة مثل hit أو build أو miss-stale أو stale-last-good أو 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

يتلقى هذا المرشح القرار النهائي بشأن أمان الطلب المجهول، إلى جانب مدخلات الخادم وملفات تعريف الارتباط. تؤدي إعادة true إلى تجاوز التقديم الثابت وإنشائه دائمًا.

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

يوفر هذا المرشح مخزون URL العام الكامل المستخدم بواسطة أداة الإحماء المجدولة وأدوات الرسم البياني الصريحة، أو يضبطه.

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

ما يعيده المرشح ليس المخزون النهائي. تُمرر النتيجة عبر فحص قابلية التخزين المؤقت الذي يستبعد كل ما يطابق مسارًا ديناميكيًا مُعدًا، وكل ما يُتجاوز افتراضيًا: /wp-admin و/wp-json و/wp-login.php و/xmlrpc.php وأي مسار يحتوي على /feed/ ونتائج البحث أسفل المسار الأساسي للبحث في المسار الرئيسي للموقع (/search/ افتراضيًا). لذلك قد يُستبعد URL الذي تضيفه دون تنبيه. إذا كان مسار تتوقعه غير موجود في المخزون المُنشأ، فتحقق من مطابقته لهذه القواعد قبل افتراض أن المرشح لم يعمل.

blockstudio/static_prerender/render_internal

ينفّذ هذا المرشح وسيلة النقل المجمّع الاختيارية داخل العملية. أعِد مصفوفة نتائج مُوحّدة، أو اترك القيمة كما هي ليستخدم العارض القيمة الاحتياطية المضبوطة HTTP. تتضمن النتيجة html، ويمكن أن تتضمن أيضًا status وdependencies وvirtualHashes وheaders؛ وتُخزّن الترويسات المسماة في performance.staticPrerender.replayHeaders مع المستند.

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

يتخذ هذا المرشح القرار النهائي بعد أن يتحقق Blockstudio من أن الناتج مستند HTML كامل بلا علامة عدم التخزين المؤقت، وأن حالة الاستجابة المرصودة ناجحة. الوسيطة الثالثة هي الحالة المرصودة، أو null إذا لم تُحدّد حالة.

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

يبلّغ هذا الإجراء عن نتائج العرض المسبق الثابت، ومنها مرات العثور وعدم العثور والكتابة وكتابة الرسم البياني والإدخالات القديمة والإخفاقات.

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

blockstudio/tailwind/cache_max_files

يحدد هذا المرشح الحد الأقصى لعدد إدخالات Tailwind CSS المترجمة. القيمة الافتراضية هي 1000.

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

blockstudio/tailwind/cache_max_age

يحدد هذا المرشح الحد الأقصى لعمر إدخالات Tailwind CSS المترجمة بالثواني. القيمة الافتراضية 30 يومًا، والحد الأدنى ساعة واحدة.

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

الإدارة

مفعّل

يتيح لك هذا المرشح تفعيل صفحة الإدارة Blockstudio أو تعطيلها ضمن أدوات > Blockstudio.

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

الأصول

editor/canvas/body_class

عند تفعيل إعادة ضبط الأصول، يضبط هذا المرشح أصناف متن الصفحة الأمامية المنقّاة والمنسوخة إلى لوحة محرر الكتل.

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

تفعيل

يتيح لك هذا المرشح تعطيل معالجة نوع معين من الأصول وإضافته إلى قائمة التحميل.

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

تعطيل

يتيح لك هذا المرشح تعطيل أصول محددة حسب معرّفها. لن تُعرض في الواجهة الأمامية الأصول التي تطابق معرّفًا في المصفوفة المعادة.

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

process/scss/import_paths

يتيح لك هذا المرشح إضافة مسارات أخرى إلى عبارة @import في مترجم SCSS.

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

process/scss/prelude

يتيح لك هذا المرشح إضافة شيفرة Sass مشتركة قبل ترجمة كل ملف SCSS.

PHP
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
  return '@import "functions";' . "\n"
    . '@import "variables";' . "\n"
    . '@import "mixins";';
}, 10, 3);

process/css/content

يتيح لك هذا المرشح ضبط محتوى ملف CSS قبل ترجمته.

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

process/js/content

يتيح لك هذا المرشح ضبط محتوى ملف JS قبل ترجمته.

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

المخزن المؤقت

مفعّل

يخزن Blockstudio استجابة الواجهة الأمامية مؤقتًا كي ينقل وسوم الأنماط والنصوص البرمجية للكتل المعروضة داخل المتن إلى الترويسة والتذييل، ولكي يتمكن Tailwind من فحص المستند كاملًا. يعني التخزين المؤقت الاحتفاظ بالمستند بأكمله وفحصه عند كل طلب للواجهة الأمامية؛ ويمكن لموقع لا يعرض أصول كتل Blockstudio ولا يستخدم Tailwind إعادة false لتجاوز الأمرين.

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

يكون التخزين المؤقت معطّلًا أيضًا في لوحة الإدارة ومعاينة أداة التخصيص. استدعِ bs_is_buffering() من wp_enqueue_scripts أو إصدار أحدث لمعرفة ما إذا كانت الاستجابة الحالية مخزنة مؤقتًا. تُعيد الدالة false قبل اتخاذ القرار عند template_redirect.

الناتج

يتلقى هذا المرشح مستند HTML الكامل المخزن مؤقتًا قبل إرساله. يجري نقل الأصول الخاص بـ Blockstudio عند الأولوية 1000000، وترجمة Tailwind عند 999999؛ لذا شغّله قبلهما لرؤية المستند قبل معالجتهما أو بعدهما لرؤية الناتج النهائي.

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

العرض

التبعيات

يبلّغ هذا المرشح عن القالب المحدد وتبعيات الأصول كلما عرض Blockstudio كتلة. وهو مفيد للمصدّرات الثابتة وأدوات جمع التبعيات الأخرى ضمن العملية.

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

عام

يتيح لك هذا المرشح ضبط ناتج الصفحة قبل عرضها.

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

يسمح لك هذا المرشح بتعديل ناتج وسم <head> قبل عرضه. ولا يعمل إلا عندما تخزّن Blockstudio الاستجابة مؤقتًا؛ راجع bs_is_buffering().

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

يتيح لك هذا المرشح ضبط ناتج </body> قبل عرضه.

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

معالجة الأخطاء

error/logged

يُفعّل هذا الإجراء بعد تسجيل خطأ. استخدمه لإرسال الأخطاء إلى خدمات تسجيل خارجية.

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

error/exception

يُفعّل هذا الإجراء بعد معالجة استثناء.

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

قاعدة البيانات

تتلقى جميع خطافات قاعدة البيانات مصفوفة $params واحدة.

db/before_create

يُفعّل الإجراء قبل إنشاء سجل.

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

db/after_create

يُفعّل الإجراء بعد إنشاء سجل.

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

يُفعّل الإجراء قبل تحديث سجل.

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

db/after_update

يُفعّل الإجراء بعد تحديث سجل.

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

db/before_delete

يُفعّل الإجراء قبل حذف سجل.

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

db/after_delete

يُفعّل الإجراء بعد حذف سجل.

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

RPC

تتلقى جميع خطافات RPC مصفوفة $params واحدة.

rpc/before_call

يُفعّل الإجراء قبل استدعاء دالة RPC.

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

rpc/after_call

يُفعّل الإجراء بعد استدعاء دالة RPC.

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