Listing comments

Dokumentation
Reference
Guides

There are several ways to list comments on your pages. The easiest one is using the plugin snippets. There are snippets for each type of response (comments and the Webmention types). There is a listing and a single response snippet for each type.

Listing snippets

To render a nested list of comments, you can use the comments list snippet like this:

<?php snippet('komments/list/comments'); ?>

You can list any type of response this way, simple swap out the type of response you want to show. A list of likes will look like this:

<?php snippet('komments/list/likes'); ?>

Single responses

Each response type comes with a snippet, too. To show a single comment, you can use the snippet like this:

<?php snippet('komments/response/comment', ['comments' => $comments, 'comment' => $comment]); ?>

Note that the response snippet for a comment needs two options. It does not only need the single comment, but the full list to build the nested tree.

All the other snippets only need the single comment as an option:

<?php snippet('komments/response/like', ['comment' => $comment]); ?>

Customization

Of course, you can customize each snippet to your needs be overwriting it:

  1. Create a new snippet under site/snippets/list/TYPE.php or site/snippets/response/TYPE.php
  2. Copy the code from the existing snippet to the new one
  3. Add changes to your liking

See the full list of snippets and where you find them.

Custom listing

Instead of using the snippets, you can build everything from scratch.

Get all the published comments of a page:

$commentList = $page->comments();

You now have a structure object, you can iterate through or filter it as you would do with pages. You could list all the comments:

<?php if ($comments = $commentList->filterBy('type', 'comment')) : ?>
    <ul class="list-comments">
        <?php foreach ($comments as $comment) ?> 
            // DISPLAY RESPONSE
        <?php endforeach; ?>
    </ul>
<?php endif; ?>

As you can see, there is a filter looking for comments only. You can filter by any field. See data structures

In your foreach loops, you can use the response snippets or use your code. There is a response base snippet you might want to use. It comes with slots so you can easily hook in.

Next steps