powerbuoy/sleek-modules

在/modules/目录下创建类来创建模块。


README

Packagist GitHub license GitHub issues GitHub forks GitHub stars

在/modules/目录下创建类来创建模块。

主题支持

sleek/modules/add_new_module_preview

在点击“添加模块”时启用模块的截图和描述。

sleek/modules/global_modules

启用“全局模块”(WIP)。

sleek/modules/inline_edit

启用灵活模块的行内编辑。

sleek/modules/module_preview

在管理员中启用模块预览。

过滤器

sleek/modules/global_modules(array $modules)

在此处返回一个包含模块名称的数组,以启用它们作为全局模块。

sleek/modules/dummy_field_value($value, $field, $module, $template, $level)

从这里返回一个$value,在用虚拟数据渲染字段时使用该值。

sleek/modules/fields(array $fields, $moduleName, $args)

在添加之前过滤ACF字段以供模块使用。这允许您一次向多个模块添加“全局”字段。

操作

待办事项...

函数

Sleek\Modules\render($module, $fields, $template)

使用可选的字段$fields(或ACF位置,如术语、选项页面,或设置为null以从get_the_ID()获取字段)和可选的模板$template渲染模块$module

Sleek\Modules\render_flexible($area, $id)

使用可选的$id作为ACF位置渲染包含在灵活内容区域$area中的灵活模块。

Sleek\Modules\get_module_fields(array $modules, $layout, $withTemplates)

获取所有$modules的ACF字段并使用布局$layouttabsaccordionnormalflexible)。可选地,使用$withTemplates = true为每个模块组提供一个模板下拉菜单。

Sleek\Modules\render_dummies(array $modules)

使用虚拟数据渲染所有$modules

Sleek\Modules\Module

扩展此类以创建模块。

Module::init()

此方法在每个页面加载时只调用一次。它允许您添加钩子或执行与您的模块相关的任何操作。注意,无论模块是否在当前页面上使用,它都会运行。

Module::fields()

从这里返回一个ACF字段数组,并将它们添加到模块中。

Module::data()

从这里返回一个数组,每个数组的属性都将在模块模板中可用。

Module::get_field($name)

返回从fields()返回的任何字段的值。在data()内部很有用,用于检查模块配置。