1. 8.2.x core/modules/taxonomy/src/VocabularyListBuilder.php VocabularyListBuilder
  2. 8.0.x core/modules/taxonomy/src/VocabularyListBuilder.php VocabularyListBuilder
  3. 8.1.x core/modules/taxonomy/src/VocabularyListBuilder.php VocabularyListBuilder
  4. 8.3.x core/modules/taxonomy/src/VocabularyListBuilder.php VocabularyListBuilder

Defines a class to build a listing of taxonomy vocabulary entities.


Expanded class hierarchy of VocabularyListBuilder

See also



core/modules/taxonomy/src/VocabularyListBuilder.php, line 15


View source
class VocabularyListBuilder extends DraggableListBuilder {

   * {@inheritdoc}
  protected $entitiesKey = 'vocabularies';

   * {@inheritdoc}
  public function getFormId() {
    return 'taxonomy_overview_vocabularies';

   * {@inheritdoc}
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);

    if (isset($operations['edit'])) {
      $operations['edit']['title'] = t('Edit vocabulary');

    $operations['list'] = array(
      'title' => t('List terms'),
      'weight' => 0,
      'url' => $entity->urlInfo('overview-form'),
    $operations['add'] = array(
      'title' => t('Add terms'),
      'weight' => 10,
      'url' => Url::fromRoute('entity.taxonomy_term.add_form', ['taxonomy_vocabulary' => $entity->id()]),

    return $operations;

   * {@inheritdoc}
  public function buildHeader() {
    $header['label'] = t('Vocabulary name');
    return $header + parent::buildHeader();

   * {@inheritdoc}
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity->label();
    return $row + parent::buildRow($entity);

   * {@inheritdoc}
  public function render() {
    $entities = $this->load();
    // If there are not multiple vocabularies, disable dragging by unsetting the
    // weight key.
    if (count($entities) <= 1) {
    $build = parent::render();
    $build['table']['#empty'] = t('No vocabularies available. <a href=":link">Add vocabulary</a>.', array(':link' => \Drupal::url('entity.taxonomy_vocabulary.add_form')));
    return $build;

   * {@inheritdoc}
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['vocabularies']['#attributes'] = array('id' => 'taxonomy');
    $form['actions']['submit']['#value'] = t('Save');

    return $form;

   * {@inheritdoc}
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    drupal_set_message(t('The configuration options have been saved.'));



Contains filters are case sensitive
Namesort descending Modifiers Type Description
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
DraggableListBuilder::$entities protected property The entities being listed.
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on.
EntityHandlerBase::moduleHandler protected function Gets the module handler.
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$storage protected property The entity storage class.
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity.
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id.
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
VocabularyListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. Overrides DraggableListBuilder::$entitiesKey
VocabularyListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
VocabularyListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
VocabularyListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
VocabularyListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
VocabularyListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
VocabularyListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides DraggableListBuilder::render
VocabularyListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm