Custom Fields

What is custom fields?

Use the Custom Fields plugin to take full control of your Botble edit screens & custom field data.

Add fields on demand. Our field builder allows you to quickly and easily add fields to edit screens with only the click of a few buttons!

Fields can be added all over including posts, pages, categories, tags!

Show them everywhere. Load and display your custom field values in views file post.blade.php, page.blade.php, tag.blade.php, category.blade.php of your theme (/public/themes/views) with our hassle free developer friendly functions!

How to use Custom Fields plugin

Active this plugin

Go through to Admin Dashboard --> Plugins --> Activate this plugin. Currently, this plugin support Pages and Blog.

View how to use it:

Check video tutorial: https://www.youtube.com/watch?v=aju8b1MhWbE

get_field: get a custom field from a model

get_field($data, $alias = null, $default = null)

Example:

$page = \Botble\Page\Models\Page::find(1);
$field = get_field($page, 'foo');

If you display field in platform/themes/[your-theme]/views/page.blade.php:

{{ get_field($page, 'field_name') }}

If you display field in platform/themes/[your-theme]/views/post.blade.php:

{{ get_field($post, 'field_name') }}

has_field: determine a model has custom field or not

function has_field($id, $screenName, $alias = null)

Example:

$page = \Botble\Page\Models\Page::find(1);
$hasField = has_field($page, 'foo');

get_sub_field: get a repeater field from a parent field with the specified alias

get_sub_field(array $parentField, $alias, $default = null)

Example:

$page = \Botble\Page\Models\Page::find(1);
foreach(get_field($page, 'foo_repeater') as $item) {
   $childField = get_sub_field($item, 'bar');
}

has_sub_field: determine the parent field has sub field with the specified alias

has_sub_field(array $parentField, $alias)

Example:

$page = \Botble\Page\Models\Page::find(1);
foreach(get_field($page, 'foo_repeater') as $item) {
   $hasBar = has_sub_field($item, 'bar');
}

Add support custom fields for your plugin. Add to function boot() of your plugin service provider.

$this->app->booted(function () {
    if (defined('CUSTOM_FIELD_MODULE_SCREEN_NAME')) {
        \CustomField::registerModule(Foo::class)
            ->registerRule('basic', __('Your plugin name'), Foo::class, function () {
                return $this->app->make(YourPluginInterface::class)->pluck('name', 'id');
            })
            ->expandRule('other', 'Model', 'model_name', function () {
                return [
                    Foo::class => __('Your plugin name'),
                ];
            });
    }
});

E.g: platform/plugins/block/src/Providers/BlockServiceProvider.php line 52

$this->app->booted(function () {
    if (defined('CUSTOM_FIELD_MODULE_SCREEN_NAME')) {
        \CustomField::registerModule(Block::class)
            ->registerRule('basic', trans('plugins/block::block.name'), Block::class, function () {
                return $this->app->make(BlockInterface::class)->pluck('blocks.name', 'blocks.id');
            })
            ->expandRule('other', trans('plugins/custom-field::rules.model_name'), 'model_name', function () {
                return [
                    Block::class => trans('plugins/block::block.name'),
                ];
            });
    }
});

Video tutorials

• Working with Custom Fields plugin: https://www.youtube.com/watch?v=aju8b1MhWbE
• Generate FAQ rich snippet using Custom Fields: https://www.youtube.com/watch?v=mEMOy3BMnYI