5 * Enables the organization of content into categories.
8 use Drupal\Component\Utility\Tags;
9 use Drupal\Component\Utility\Unicode;
10 use Drupal\Core\Entity\EntityInterface;
11 use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
12 use Drupal\Core\Render\Element;
13 use Drupal\Core\Routing\RouteMatchInterface;
15 use Drupal\taxonomy\Entity\Term;
16 use Drupal\taxonomy\Entity\Vocabulary;
17 use Drupal\taxonomy\TermInterface;
18 use Drupal\taxonomy\VocabularyInterface;
21 * Denotes that no term in the vocabulary has a parent.
23 * @deprecated in Drupal 8.2.x and will be removed before 9.0.0. Use
24 * \Drupal\taxonomy\VocabularyInterface::HIERARCHY_DISABLED instead.
26 * @see https://www.drupal.org/node/2807795
28 const TAXONOMY_HIERARCHY_DISABLED = 0;
31 * Denotes that one or more terms in the vocabulary has a single parent.
33 * @deprecated in Drupal 8.2.x and will be removed before 9.0.0. Use
34 * \Drupal\taxonomy\VocabularyInterface::HIERARCHY_SINGLE instead.
36 * @see https://www.drupal.org/node/2807795
38 const TAXONOMY_HIERARCHY_SINGLE = 1;
41 * Denotes that one or more terms in the vocabulary have multiple parents.
43 * @deprecated in Drupal 8.2.x and will be removed before 9.0.0. Use
44 * \Drupal\taxonomy\VocabularyInterface::HIERARCHY_MULTIPLE instead.
46 * @see https://www.drupal.org/node/2807795
48 const TAXONOMY_HIERARCHY_MULTIPLE = 2;
51 * Implements hook_help().
53 function taxonomy_help($route_name, RouteMatchInterface $route_match) {
54 switch ($route_name) {
55 case 'help.page.taxonomy':
56 $field_ui_url = \Drupal::moduleHandler()->moduleExists('field_ui') ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#';
58 $output .= '<h3>' . t('About') . '</h3>';
59 $output .= '<p>' . t('The Taxonomy module allows users who have permission to create and edit content to categorize (tag) content of that type. Users who have the <em>Administer vocabularies and terms</em> <a href=":permissions" title="Taxonomy module permissions">permission</a> can add <em>vocabularies</em> that contain a set of related <em>terms</em>. The terms in a vocabulary can either be pre-set by an administrator or built gradually as content is added and edited. Terms may be organized hierarchically if desired.', [':permissions' => \Drupal::url('user.admin_permissions', [], ['fragment' => 'module-taxonomy'])]) . '</p>';
60 $output .= '<p>' . t('For more information, see the <a href=":taxonomy">online documentation for the Taxonomy module</a>.', [':taxonomy' => 'https://www.drupal.org/documentation/modules/taxonomy/']) . '</p>';
61 $output .= '<h3>' . t('Uses') . '</h3>';
63 $output .= '<dt>' . t('Managing vocabularies') . '</dt>';
64 $output .= '<dd>' . t('Users who have the <em>Administer vocabularies and terms</em> permission can add and edit vocabularies from the <a href=":taxonomy_admin">Taxonomy administration page</a>. Vocabularies can be deleted from their <em>Edit vocabulary</em> page. Users with the <em>Taxonomy term: Administer fields</em> permission may add additional fields for terms in that vocabulary using the <a href=":field_ui">Field UI module</a>.', [':taxonomy_admin' => \Drupal::url('entity.taxonomy_vocabulary.collection'), ':field_ui' => $field_ui_url]) . '</dd>';
65 $output .= '<dt>' . t('Managing terms') . '</dt>';
66 $output .= '<dd>' . t('Users who have the <em>Administer vocabularies and terms</em> permission or the <em>Edit terms</em> permission for a particular vocabulary can add, edit, and organize the terms in a vocabulary from a vocabulary\'s term listing page, which can be accessed by going to the <a href=":taxonomy_admin">Taxonomy administration page</a> and clicking <em>List terms</em> in the <em>Operations</em> column. Users must have the <em>Administer vocabularies and terms</em> permission or the <em>Delete terms</em> permission for a particular vocabulary to delete terms.', [':taxonomy_admin' => \Drupal::url('entity.taxonomy_vocabulary.collection')]) . ' </dd>';
67 $output .= '<dt>' . t('Classifying entity content') . '</dt>';
68 $output .= '<dd>' . t('A user with the <em>Administer fields</em> permission for a certain entity type may add <em>Taxonomy term</em> reference fields to the entity type, which will allow entities to be classified using taxonomy terms. See the <a href=":entity_reference">Entity Reference help</a> for more information about reference fields. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI help</a> pages for general information on fields and how to create and manage them.', [':field_ui' => $field_ui_url, ':field' => \Drupal::url('help.page', ['name' => 'field']), ':entity_reference' => \Drupal::url('help.page', ['name' => 'entity_reference'])]) . '</dd>';
69 $output .= '<dt>' . t('Adding new terms during content creation') . '</dt>';
70 $output .= '<dd>' . t("Allowing users to add new terms gradually builds a vocabulary as content is added and edited. Users can add new terms if either of the two <em>Autocomplete</em> widgets is chosen for the Taxonomy term reference field in the <em>Manage form display</em> page for the field. You will also need to enable the <em>Create referenced entities if they don't already exist</em> option, and restrict the field to one vocabulary.") . '</dd>';
71 $output .= '<dt>' . t('Configuring displays and form displays') . '</dt>';
72 $output .= '<dd>' . t('See the <a href=":entity_reference">Entity Reference help</a> page for the field widgets and formatters that can be configured for any reference field on the <em>Manage display</em> and <em>Manage form display</em> pages. Taxonomy additionally provides an <em>RSS category</em> formatter that displays nothing when the entity item is displayed as HTML, but displays an RSS category instead of a list when the entity item is displayed in an RSS feed.', [':entity_reference' => \Drupal::url('help.page', ['name' => 'entity_reference'])]) . '</li>';
78 case 'entity.taxonomy_vocabulary.collection':
79 $output = '<p>' . t('Taxonomy is for categorizing content. Terms are grouped into vocabularies. For example, a vocabulary called "Fruit" would contain the terms "Apple" and "Banana".') . '</p>';
82 case 'entity.taxonomy_vocabulary.overview_form':
83 $vocabulary = $route_match->getParameter('taxonomy_vocabulary');
84 if (\Drupal::currentUser()->hasPermission('administer taxonomy') || \Drupal::currentUser()->hasPermission('edit terms in ' . $vocabulary->id())) {
85 switch ($vocabulary->getHierarchy()) {
86 case VocabularyInterface::HIERARCHY_DISABLED:
87 return '<p>' . t('You can reorganize the terms in %capital_name using their drag-and-drop handles, and group terms under a parent term by sliding them under and to the right of the parent.', ['%capital_name' => Unicode::ucfirst($vocabulary->label()), '%name' => $vocabulary->label()]) . '</p>';
88 case VocabularyInterface::HIERARCHY_SINGLE:
89 return '<p>' . t('%capital_name contains terms grouped under parent terms. You can reorganize the terms in %capital_name using their drag-and-drop handles.', ['%capital_name' => Unicode::ucfirst($vocabulary->label()), '%name' => $vocabulary->label()]) . '</p>';
90 case VocabularyInterface::HIERARCHY_MULTIPLE:
91 return '<p>' . t('%capital_name contains terms with multiple parents. Drag and drop of terms with multiple parents is not supported, but you can re-enable drag-and-drop support by editing each term to include only a single parent.', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
95 switch ($vocabulary->getHierarchy()) {
96 case VocabularyInterface::HIERARCHY_DISABLED:
97 return '<p>' . t('%capital_name contains the following terms.', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
98 case VocabularyInterface::HIERARCHY_SINGLE:
99 return '<p>' . t('%capital_name contains terms grouped under parent terms', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
100 case VocabularyInterface::HIERARCHY_MULTIPLE:
101 return '<p>' . t('%capital_name contains terms with multiple parents.', ['%capital_name' => Unicode::ucfirst($vocabulary->label())]) . '</p>';
108 * Entity URI callback.
110 function taxonomy_term_uri($term) {
111 return new Url('entity.taxonomy_term.canonical', [
112 'taxonomy_term' => $term->id(),
117 * Implements hook_page_attachments_alter().
119 function taxonomy_page_attachments_alter(array &$page) {
120 $route_match = \Drupal::routeMatch();
121 if ($route_match->getRouteName() == 'entity.taxonomy_term.canonical' && ($term = $route_match->getParameter('taxonomy_term')) && $term instanceof TermInterface) {
122 foreach ($term->uriRelationships() as $rel) {
123 // Set the URI relationships, like canonical.
124 $page['#attached']['html_head_link'][] = [
127 'href' => $term->url($rel),
132 // Set the term path as the canonical URL to prevent duplicate content.
133 if ($rel == 'canonical') {
134 // Set the non-aliased canonical path as a default shortlink.
135 $page['#attached']['html_head_link'][] = [
137 'rel' => 'shortlink',
138 'href' => $term->url($rel, ['alias' => TRUE]),
148 * Implements hook_theme().
150 function taxonomy_theme() {
153 'render element' => 'elements',
159 * Checks and updates the hierarchy flag of a vocabulary.
161 * Checks the current parents of all terms in a vocabulary and updates the
162 * vocabulary's hierarchy setting to the lowest possible level. If no term
163 * has parent terms then the vocabulary will be given a hierarchy of
164 * VocabularyInterface::HIERARCHY_DISABLED. If any term has a single parent then
165 * the vocabulary will be given a hierarchy of
166 * VocabularyInterface::HIERARCHY_SINGLE. If any term has multiple parents then
167 * the vocabulary will be given a hierarchy of
168 * VocabularyInterface::HIERARCHY_MULTIPLE.
170 * @param \Drupal\taxonomy\VocabularyInterface $vocabulary
171 * A taxonomy vocabulary entity.
172 * @param $changed_term
173 * An array of the term structure that was updated.
176 * An integer that represents the level of the vocabulary's hierarchy.
178 function taxonomy_check_vocabulary_hierarchy(VocabularyInterface $vocabulary, $changed_term) {
179 $tree = \Drupal::entityManager()->getStorage('taxonomy_term')->loadTree($vocabulary->id());
180 $hierarchy = VocabularyInterface::HIERARCHY_DISABLED;
181 foreach ($tree as $term) {
182 // Update the changed term with the new parent value before comparison.
183 if ($term->tid == $changed_term['tid']) {
184 $term = (object) $changed_term;
185 $term->parents = $term->parent;
187 // Check this term's parent count.
188 if (count($term->parents) > 1) {
189 $hierarchy = VocabularyInterface::HIERARCHY_MULTIPLE;
192 elseif (count($term->parents) == 1 && !isset($term->parents[0])) {
193 $hierarchy = VocabularyInterface::HIERARCHY_SINGLE;
196 if ($hierarchy != $vocabulary->getHierarchy()) {
197 $vocabulary->setHierarchy($hierarchy);
205 * Generates an array which displays a term detail page.
207 * @param \Drupal\taxonomy\Entity\Term $term
208 * A taxonomy term object.
209 * @param string $view_mode
210 * View mode; e.g., 'full', 'teaser', etc.
211 * @param string $langcode
212 * (optional) A language code to use for rendering. Defaults to the global
213 * content language of the current request.
216 * A $page element suitable for use by drupal_render().
218 function taxonomy_term_view(Term $term, $view_mode = 'full', $langcode = NULL) {
219 return entity_view($term, $view_mode, $langcode);
223 * Constructs a drupal_render() style array from an array of loaded terms.
225 * @param array $terms
226 * An array of taxonomy terms as returned by Term::loadMultiple().
227 * @param string $view_mode
228 * View mode; e.g., 'full', 'teaser', etc.
229 * @param string $langcode
230 * (optional) A language code to use for rendering. Defaults to the global
231 * content language of the current request.
234 * An array in the format expected by drupal_render().
236 function taxonomy_term_view_multiple(array $terms, $view_mode = 'full', $langcode = NULL) {
237 return entity_view_multiple($terms, $view_mode, $langcode);
241 * Implements hook_theme_suggestions_HOOK().
243 function taxonomy_theme_suggestions_taxonomy_term(array $variables) {
246 /** @var \Drupal\taxonomy\TermInterface $term */
247 $term = $variables['elements']['#taxonomy_term'];
249 $suggestions[] = 'taxonomy_term__' . $term->bundle();
250 $suggestions[] = 'taxonomy_term__' . $term->id();
256 * Prepares variables for taxonomy term templates.
258 * Default template: taxonomy-term.html.twig.
260 * @param array $variables
261 * An associative array containing:
262 * - elements: An associative array containing the taxonomy term and any
263 * fields attached to the term. Properties used:
264 * - #taxonomy_term: A \Drupal\taxonomy\TermInterface object.
265 * - #view_mode: The current view mode for this taxonomy term, e.g.
266 * 'full' or 'teaser'.
267 * - attributes: HTML attributes for the containing element.
269 function template_preprocess_taxonomy_term(&$variables) {
270 $variables['view_mode'] = $variables['elements']['#view_mode'];
271 $variables['term'] = $variables['elements']['#taxonomy_term'];
272 /** @var \Drupal\taxonomy\TermInterface $term */
273 $term = $variables['term'];
275 $variables['url'] = $term->url();
276 // We use name here because that is what appears in the UI.
277 $variables['name'] = $variables['elements']['name'];
278 unset($variables['elements']['name']);
279 $variables['page'] = $variables['view_mode'] == 'full' && taxonomy_term_is_page($term);
281 // Helpful $content variable for templates.
282 $variables['content'] = [];
283 foreach (Element::children($variables['elements']) as $key) {
284 $variables['content'][$key] = $variables['elements'][$key];
289 * Returns whether the current page is the page of the passed-in term.
291 * @param \Drupal\taxonomy\Entity\Term $term
292 * A taxonomy term entity.
294 function taxonomy_term_is_page(Term $term) {
295 if (\Drupal::routeMatch()->getRouteName() == 'entity.taxonomy_term.canonical' && $page_term_id = \Drupal::routeMatch()->getRawParameter('taxonomy_term')) {
296 return $page_term_id == $term->id();
302 * Clear all static cache variables for terms.
304 function taxonomy_terms_static_reset() {
305 \Drupal::entityManager()->getStorage('taxonomy_term')->resetCache();
309 * Clear all static cache variables for vocabularies.
312 * An array of ids to reset in the entity cache.
314 function taxonomy_vocabulary_static_reset(array $ids = NULL) {
315 \Drupal::entityManager()->getStorage('taxonomy_vocabulary')->resetCache($ids);
319 * Get names for all taxonomy vocabularies.
322 * A list of existing vocabulary IDs.
324 function taxonomy_vocabulary_get_names() {
325 $names = &drupal_static(__FUNCTION__);
327 if (!isset($names)) {
329 $config_names = \Drupal::configFactory()->listAll('taxonomy.vocabulary.');
330 foreach ($config_names as $config_name) {
331 $id = substr($config_name, strlen('taxonomy.vocabulary.'));
340 * Try to map a string to an existing term, as for glossary use.
342 * Provides a case-insensitive and trimmed mapping, to maximize the
343 * likelihood of a successful match.
346 * Name of the term to search for.
348 * (optional) Vocabulary machine name to limit the search. Defaults to NULL.
351 * An array of matching term objects.
353 function taxonomy_term_load_multiple_by_name($name, $vocabulary = NULL) {
354 $values = ['name' => trim($name)];
355 if (isset($vocabulary)) {
356 $vocabularies = taxonomy_vocabulary_get_names();
357 if (isset($vocabularies[$vocabulary])) {
358 $values['vid'] = $vocabulary;
361 // Return an empty array when filtering by a non-existing vocabulary.
365 return entity_load_multiple_by_properties('taxonomy_term', $values);
369 * Load multiple taxonomy terms based on certain conditions.
371 * This function should be used whenever you need to load more than one term
372 * from the database. Terms are loaded into memory and will not require
373 * database access if loaded again during the same page request.
375 * @see entity_load_multiple()
376 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
378 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
379 * Use \Drupal\taxonomy\Entity\Term::loadMultiple().
382 * (optional) An array of entity IDs. If omitted, all entities are loaded.
385 * An array of taxonomy term entities, indexed by tid. When no results are
386 * found, an empty array is returned.
388 function taxonomy_term_load_multiple(array $tids = NULL) {
389 return Term::loadMultiple($tids);
393 * Loads multiple taxonomy vocabularies based on certain conditions.
395 * This function should be used whenever you need to load more than one
396 * vocabulary from the database. Terms are loaded into memory and will not
397 * require database access if loaded again during the same page request.
399 * @see entity_load_multiple()
401 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
402 * Use \Drupal\taxonomy\Entity\Vocabulary::loadMultiple().
405 * (optional) An array of entity IDs. If omitted, all entities are loaded.
408 * An array of vocabulary objects, indexed by vid.
410 function taxonomy_vocabulary_load_multiple(array $vids = NULL) {
411 return Vocabulary::loadMultiple($vids);
415 * Return the taxonomy vocabulary entity matching a vocabulary ID.
417 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
418 * Use \Drupal\taxonomy\Entity\Vocabulary::load().
421 * The vocabulary's ID.
423 * @return \Drupal\taxonomy\Entity\Vocabulary|null
424 * The taxonomy vocabulary entity, if exists, NULL otherwise. Results are
427 function taxonomy_vocabulary_load($vid) {
428 return Vocabulary::load($vid);
432 * Return the taxonomy term entity matching a term ID.
434 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
435 * Use \Drupal\taxonomy\Entity\Term::load().
440 * @return \Drupal\taxonomy\Entity\Term|null
441 * A taxonomy term entity, or NULL if the term was not found. Results are
444 function taxonomy_term_load($tid) {
445 if (!is_numeric($tid)) {
448 return Term::load($tid);
452 * Implodes a list of tags of a certain vocabulary into a string.
454 * @see \Drupal\Component\Utility\Tags::explode()
456 function taxonomy_implode_tags($tags, $vid = NULL) {
458 foreach ($tags as $tag) {
459 // Extract terms belonging to the vocabulary in question.
460 if (!isset($vid) || $tag->bundle() == $vid) {
461 // Make sure we have a completed loaded taxonomy term.
462 if ($tag instanceof EntityInterface && $label = $tag->label()) {
463 // Commas and quotes in tag names are special cases, so encode 'em.
464 $typed_tags[] = Tags::encode($label);
468 return implode(', ', $typed_tags);
472 * Title callback for term pages.
474 * @param \Drupal\taxonomy\Entity\Term $term
475 * A taxonomy term entity.
478 * The term name to be used as the page title.
480 function taxonomy_term_title(Term $term) {
481 return $term->getName();
485 * @defgroup taxonomy_index Taxonomy indexing
487 * Functions to maintain taxonomy indexing.
489 * Taxonomy uses default field storage to store canonical relationships
490 * between terms and fieldable entities. However its most common use case
491 * requires listing all content associated with a term or group of terms
492 * sorted by creation date. To avoid slow queries due to joining across
493 * multiple node and field tables with various conditions and order by criteria,
494 * we maintain a denormalized table with all relationships between terms,
495 * published nodes and common sort criteria such as status, sticky and created.
496 * When using other field storage engines or alternative methods of
497 * denormalizing this data you should set the
498 * taxonomy.settings:maintain_index_table to '0' to avoid unnecessary writes in
503 * Implements hook_ENTITY_TYPE_insert() for node entities.
505 function taxonomy_node_insert(EntityInterface $node) {
506 // Add taxonomy index entries for the node.
507 taxonomy_build_node_index($node);
511 * Builds and inserts taxonomy index entries for a given node.
513 * The index lists all terms that are related to a given node entity, and is
514 * therefore maintained at the entity level.
516 * @param \Drupal\node\Entity\Node $node
519 function taxonomy_build_node_index($node) {
520 // We maintain a denormalized table of term/node relationships, containing
521 // only data for current, published nodes.
522 if (!\Drupal::config('taxonomy.settings')->get('maintain_index_table') || !(\Drupal::entityManager()->getStorage('node') instanceof SqlContentEntityStorage)) {
526 $status = $node->isPublished();
527 $sticky = (int) $node->isSticky();
528 // We only maintain the taxonomy index for published nodes.
529 if ($status && $node->isDefaultRevision()) {
530 // Collect a unique list of all the term IDs from all node fields.
532 $entity_reference_class = 'Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem';
533 foreach ($node->getFieldDefinitions() as $field) {
534 $field_name = $field->getName();
535 $class = $field->getItemDefinition()->getClass();
536 $is_entity_reference_class = ($class === $entity_reference_class) || is_subclass_of($class, $entity_reference_class);
537 if ($is_entity_reference_class && $field->getSetting('target_type') == 'taxonomy_term') {
538 foreach ($node->getTranslationLanguages() as $language) {
539 foreach ($node->getTranslation($language->getId())->$field_name as $item) {
540 if (!$item->isEmpty()) {
541 $tid_all[$item->target_id] = $item->target_id;
547 // Insert index entries for all the node's terms.
548 if (!empty($tid_all)) {
549 foreach ($tid_all as $tid) {
550 db_merge('taxonomy_index')
551 ->key(['nid' => $node->id(), 'tid' => $tid, 'status' => $node->isPublished()])
552 ->fields(['sticky' => $sticky, 'created' => $node->getCreatedTime()])
560 * Implements hook_ENTITY_TYPE_update() for node entities.
562 function taxonomy_node_update(EntityInterface $node) {
563 // If we're not dealing with the default revision of the node, do not make any
564 // change to the taxonomy index.
565 if (!$node->isDefaultRevision()) {
568 taxonomy_delete_node_index($node);
569 taxonomy_build_node_index($node);
573 * Implements hook_ENTITY_TYPE_predelete() for node entities.
575 function taxonomy_node_predelete(EntityInterface $node) {
576 // Clean up the {taxonomy_index} table when nodes are deleted.
577 taxonomy_delete_node_index($node);
581 * Deletes taxonomy index entries for a given node.
583 * @param \Drupal\Core\Entity\EntityInterface $node
586 function taxonomy_delete_node_index(EntityInterface $node) {
587 if (\Drupal::config('taxonomy.settings')->get('maintain_index_table')) {
588 db_delete('taxonomy_index')->condition('nid', $node->id())->execute();
593 * Implements hook_ENTITY_TYPE_delete() for taxonomy_term entities.
595 function taxonomy_taxonomy_term_delete(Term $term) {
596 if (\Drupal::config('taxonomy.settings')->get('maintain_index_table')) {
597 // Clean up the {taxonomy_index} table when terms are deleted.
598 db_delete('taxonomy_index')->condition('tid', $term->id())->execute();
603 * @} End of "defgroup taxonomy_index".