ACF Blocks: Initial Gutenberg Preview Empty Despite Default Field Values (Timber + render_callback)
还没有人认领这个 Issue。
评估
调研方向
从 GutenbergHelper.php 开始,重点查看 acfRenderCallback(),然后追踪从 BlockLinkTiles/functions.php 进行的注册,以及 BlockLinkTiles/index.twig 所需的数据。在 Gutenberg 编辑器中复现首次插入,并确定受支持的默认值路径;当初始渲染无需与字段交互即可接收已配置的值,且后续渲染仍保持正确时,即表示完成。
由索引模型根据 Issue 内容生成。
描述
Describe the bug
When registering a custom ACF block using acf_register_block_type() with a render_callback, the Gutenberg editor preview is blank on the very first load after inserting the block — even though default field values are defined. The data object passed to render_callback is empty on this initial render. As soon as any field value is changed in the inspector controls, the preview updates correctly and continues to work from that point on.
To Reproduce
- Register a custom ACF block using
acf_register_block_type()with arender_callback - Define default values for the block's fields in ACF
- Open a page or post in the Gutenberg editor
- Insert the custom block for the first time
- Observe that the block preview is blank — the
render_callbackreceives an empty data object
Expected behavior
On initial insertion of the block into the editor, the render_callback should receive the defined default field values and render an accurate preview immediately, without requiring any user interaction.
Screenshots or Video
https://www.youtube.com/watch?v=ldLwg3o8PPY
Code
We use a central GutenbergHelper class to register and render all ACF blocks for Gutenberg.
GutenbergHelper.php — handles block registration and the shared render_callback:
<?php
namespace Flynt\Utils;
use ACFComposer\ACFComposer;
use Flynt\ComponentManager;
use Timber\Timber;
class GutenbergHelper
{
public static function acfRenderCallback($block, $content, $is_preview = false, $post_id = 0)
{
$componentName = str_replace('acf/', '', $block['name']);
$componentManager = ComponentManager::getInstance();
$filePath = $componentManager->getComponentFilePath($block['filePath'], 'index.twig');
$relativeFilePath = ltrim(str_replace(get_template_directory(), '', $filePath), '/');
if (!is_file($filePath)) {
trigger_error("Template not found: {$filePath}", E_USER_WARNING);
return '';
}
$fields = \get_fields() ?? [];
$fields['is_preview'] = $is_preview;
$fields = apply_filters(
"Flynt/addComponentData?name={$componentName}",
$fields,
$componentName
);
$fields['block'] = $block;
Timber::render($relativeFilePath, $fields);
}
public static function registerGutenbergBlock($component)
{
ACFComposer::registerFieldGroup([
'name' => $component['name'],
'title' => $component['label'],
'fields' => $component['sub_fields'] ?? [],
'location' => array(
array(
array(
'param' => 'block',
'operator' => '==',
'value' => 'acf/' . strtolower($component['name']),
),
),
),
]);
if (function_exists('acf_register_block_type')) {
$componentName = $component['name'];
$componentLabel = $component['label'] ?? $componentName;
$gutenbergConfig = self::getComponentGutenbergConfig($componentName);
$blockConfig = array(
'name' => $componentName,
'title' => $componentLabel,
'filePath' => $component['filePath'] ?? $componentLabel,
'render_callback' => [self::class, 'acfRenderCallback'],
'category' => $gutenbergConfig['category'] ?? 'custom-blocks',
'icon' => $gutenbergConfig['icon'] ?? 'grid-view',
'keywords' => $gutenbergConfig['keywords'] ?? ['content'],
'supports' => $gutenbergConfig['supports'] ?? array(
'align' => array( 'wide', 'full' ),
'anchor' => true,
'customClassName' => true,
'color' => array('text' => true, 'background' => true),
'layout' => array('allowInheriting' => true),
'typography' => array(
'fontSize' => false,
'lineHeight' => false,
'fontWeight' => false,
),
'spacing' => array('margin' => true, 'padding' => true),
),
);
acf_register_block_type($blockConfig);
}
}
private static function getComponentGutenbergConfig($componentName): array
{
$functionName = "Flynt\\Components\\{$componentName}\\getGutenbergConfig";
if (function_exists($functionName)) {
return call_user_func($functionName);
}
return [];
}
}
BlockLinkTiles/functions.php — example block registration with field definitions including default_value:
<?php
namespace Flynt\Components\BlockLinkTiles;
use Flynt\FieldVariables;
use Flynt\Utils\GutenbergHelper;
function getACFLayout()
{
return [
'name' => 'blockLinkTiles',
'label' => __('Link Tiles', 'flynt'),
'filePath' => 'BlockLinkTiles',
'sub_fields' => [
[
'label' => __('Content', 'flynt'),
'name' => 'contentTab',
'type' => 'tab',
'placement' => 'top',
'endpoint' => 0,
],
[
'label' => __('Color', 'flynt'),
'name' => 'color',
'type' => 'select',
'choices' => FieldVariables\getThemeColorChoices(),
'default_value' => 'orange',
'wrapper' => ['width' => 100],
],
[
'label' => __('Links', 'flynt'),
'name' => 'links',
'type' => 'repeater',
'layout' => 'block',
'min' => 3,
'max' => 4,
'sub_fields' => [
[
'label' => __('Label', 'flynt'),
'name' => 'label',
'type' => 'text',
'default_value' => 'Title',
],
[
'label' => __('Link', 'flynt'),
'name' => 'link',
'type' => 'link',
'required' => 0,
],
],
],
],
];
}
function getGutenbergConfig(): array
{
return [
'icon' => 'screenoptions',
'keywords' => ['links', 'tiles', 'gradient', 'cta'],
'category' => 'custom-blocks',
];
}
add_action('acf/init', function () {
if (function_exists('acf_register_block_type')) {
$component = getACFLayout();
GutenbergHelper::registerGutenbergBlock($component);
}
});
BlockLinkTiles/index.twig — Timber template, relies on links and color being present in the context:
{% set componentOptions = {
name: 'BlockLinkTiles',
loadOn: 'visible',
class: 'has-global-padding'
} %}
{% set content %}
<div class="block-link-tiles-wrapper">
{% if links and links|length > 0 %}
{% set total = links|length %}
<div class="flex flex-col gap-sm md:flex-row">
{% for row in links %}
{% include 'Components/BlockLinkTiles/Partials/_tile.twig' with {
link: row.link,
label: row.label|default(row.link.title),
index: loop.index0,
total: total,
gradientSlugDesktop: gradientSlugDesktop|default('dark-sunset'),
gradientSlugMobile: gradientSlugMobile|default('dark-sunset-vertical')
} %}
{% endfor %}
</div>
{% endif %}
</div>
{% endset %}
{% include 'Components/_Containers/FlyntComponent.twig' with {
content: content,
componentOptions: componentOptions
} %}
Our question: what is the correct, supported way to access field default values inside render_callback on the very first render of a newly inserted block, before any data has been saved or interacted with?
Version Information:
- WordPress Version: 6.9.4
- PHP Version: 8.3
- ACF Version: ACF PRO 6.8.0.1
- Timber 2.2.0 for templating
- Browser: Brave 1.88.136
Additional context
- The block renders correctly on the website frontend
- The issue only occurs on the very first render after inserting the block in the editor — subsequent loads of an already-saved block work fine
- 主要语言
- PHP
- 星标
- 948
- 派生
- 197
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
AdvancedCustomFields/acf 的其他 Issue
-
PHP 8.5: "Using null as an array offset" deprecation in ACF_Data::is() when rendering a block with empty data (local-meta.php is_request)可能已有人在做 @faisalahammad 于 23 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
AdvancedCustomFields/acf#1044 ·
-
is_preview was called incorrectly notice on every early get_field() since 6.8.10 (acf_revisions::acf_validate_post_id)可能已有人在做 @faisalahammad 于 23 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
AdvancedCustomFields/acf#1041 · 1 条评论 ·
-
True / False ACF control bug on RTL layouts可能已有人在做 @elicohenator 于 46 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 86/100
AdvancedCustomFields/acf#1038 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
AdvancedCustomFields/acf#1034 · 3 条评论 ·
-
Bug: class-acf-field-icon_picker.php calls wp_get_attachment_image_url() with string Dashicon slug, causing fatal TypeError on PHP 8+可能已有人在做 @antwonw 于 57 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 86/100
AdvancedCustomFields/acf#1032 · 1 条评论 ·
查看 AdvancedCustomFields/acf 的全部 Issue
相似的 Issue
-
jira-created
难度 2/5 1-3 小时 新手友好度 77/100
-
No Code Attached Yet
难度 1/5 1 小时以内 新手友好度 90/100
joomla/joomla-cms#48786 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
Icinga/icingaweb2-module-director#3188 ·
维护者通常 4 天内回复
-
难度 1/5 1 小时以内 新手友好度 88/100
mollie/WooCommerce#1327 ·
-
bug ui
难度 2/5 1-3 小时 新手友好度 62/100
hashtopolis/server#2614 ·
维护者通常 1 天内回复