Notice: You are browsing the documentation for PrestaShop 8, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 1.7.

CategoryChoiceTreeType

CategoryChoiceTreeType is a child of MaterialChoiceTreeType, it extends parent options with options listed bellow. It is used to display category tree selection box and requires Javascript components.

Type options

Option Type Default value Description
choices_tree array Array of all available categories Values to choose from in choices tree
choice_label string name An array key which should be targeted in provided choices list to get the label for input
choice_value string id_category An array key which should be targeted in provided choices list to get the value for input

Required Javascript components

Component Description
../admin-dev/themes/new-theme/js/components/form/choice-tree.js Responsible for choice tree expanding and collapsing interactivity

Code example

<?php
// path/to/your/CustomType.php

use PrestaShopBundle\Form\Admin\Type\CategoryChoiceTreeType;
use Symfony\Component\Form\AbstractType;

class CustomType extends AbstractType
{
   public function buildForm(FormBuilderInterface $builder, array $options)
   {
        // you can disable some categories selection in choice tree
        $disabledCategories = [
            2, // category id
        ];
        $builder
            ->add('category_id', CategoryChoiceTreeType::class, [
                'disabled_values' => $disabledCategories,
            ])
        ;
    }    
}

Preview example

CategoryChoiceTree rendered in form example