CommentLinkBuilderInterface.php

Same filename in other branches
  1. 9 core/modules/comment/src/CommentLinkBuilderInterface.php
  2. 8.9.x core/modules/comment/src/CommentLinkBuilderInterface.php
  3. 10 core/modules/comment/src/CommentLinkBuilderInterface.php

Namespace

Drupal\comment

File

core/modules/comment/src/CommentLinkBuilderInterface.php

View source
<?php

namespace Drupal\comment;

use Drupal\Core\Entity\FieldableEntityInterface;

/**
 * Defines an interface for building comment links on a commented entity.
 *
 * Comment links include 'log in to post new comment', 'add new comment' etc.
 */
interface CommentLinkBuilderInterface {
    
    /**
     * Builds links for the given entity.
     *
     * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
     *   Entity for which the links are being built.
     * @param array $context
     *   Array of context passed from the entity view builder.
     *
     * @return array
     *   Array of entity links.
     */
    public function buildCommentedEntityLinks(FieldableEntityInterface $entity, array &$context);

}

Interfaces

Title Deprecated Summary
CommentLinkBuilderInterface Defines an interface for building comment links on a commented entity.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.