​

GraphQL#

Comments supports accessing Comment objects via GraphQL. Be sure to read about Craft's GraphQL support (opens new window).

​

Comments#

​

Example#

{
    comments (ownerId: 2460, limit: 2, orderBy: "commentDate DESC") {
        commentDate @formatDateTime (format: "Y-m-d")
        name
        email
        comment
    }
}

{
    "data": {
        "comments": [
            {
                "commentDate": "2019-01-23",
                "name": "Test User",
                "email": "[email protected]",
                "comment": "Hey there, this is a great article, love your work!"
            },
            {
                "commentDate": "2019-01-23",
                "name": "John Smith",
                "email": "[email protected]",
                "comment": "Thanks, appreciate your comments! 😀"
            },
        ]
    }
}

​

The comments query#

This query is used to query for Comment objects. You can also use the singular comment to fetch a single node.

​

The CommentInterface interface#

This is the interface implemented by all comments.

​

The FlagInterface interface#

This is the interface implemented by all flags.

​

The VoteInterface interface#

This is the interface implemented by all votes.

​

Custom Fields#

If you’ve added custom fields to your Comments Form (Comments → Settings → Comments Form → Form Layout), you can query them by handle within a GraphQL fragment. If you added a summary Plain Text field, for example, your query might look like this:

{
    comments (ownerId: 2460, limit: 2, orderBy: "commentDate DESC") {
        commentDate @formatDateTime (format: "Y-m-d")
        name
        email
        comment
        ... on Comment {
            summary
        }
    }
}

​

Mutations#

​

createComment#

Saves a new nested visitor comment.

mutation NewComment($newParentId: ID, $ownerId: ID, $name: String, $email: String, $comment: String) {
    saveComment(newParentId: $newParentId, ownerId: $ownerId, name: $name, email: $email, comment: $comment) {
        id
        ownerId
        name
        email
        comment
    }
}

Query variables:

{
    "ownerId": 7,
    "newParentId": 30,
    "name": "Matt",
    "email": "[email protected]",
    "comment": "Here’s a nested comment."
}

​

saveComment#

Edit an existing comment.

mutation UpdateComment($id: ID, $comment: String) {
    saveComment(id: $id, comment: $comment) {
        id
        ownerId
        name
        email
        comment
    }
}

Query variables:

{
    "id": 34,
    "comment": "I’m totally changing what I said."
}

​

voteComment#

Upvote a comment:

mutation UpvoteComment($id: ID!, $upvote: Boolean) {
    voteComment(id: $id, upvote: $upvote) {
        id
        
        comment {
            flags
            upvotes
            downvotes
        }
    }
}

Query variables:

{
    "id": 34,
    "upvote": true
}

Downvote a comment:

mutation DownvoteComment($id: ID!, $downvote: Boolean) {
    voteComment(id: $id, downvote: $downvote) {
        id
        
        comment {
            flags
            upvotes
            downvotes
        }
    }
}

Query variables:

{
    "id": 34,
    "downvote": true
}

​

flagComment#

Flag a comment for moderation:

mutation FlagComment($id: ID!) {
    flagComment(id: $id) {
        id

        comment {
            flags
            upvotes
            downvotes
        }
    }
}

Query variables:

{
    "id": 34
}

​

subscribeComment#

Subscribe to an element’s comment notifications:

mutation SubscribeComment($ownerId: ID!) {
    subscribeComment(ownerId: $ownerId)
}

Repeat to toggle on/off.

Query variables:

{
    "ownerId": 34
}

Subscribe to a specific comment thread, where commentId is the beginning of that thread:

mutation SubscribeThread($ownerId: ID!, $commentId: ID) {
    subscribeComment(ownerId: $ownerId, commentId: $commentId)
}

Repeat to toggle on/off.

Query variables:

{
    "ownerId": 34,
    "commentId": 95
}

​

deleteComment#

Delete a comment:

mutation DeleteComment($id: ID!) {
    deleteComment(id: $id)
}

Query variables:

{
    "id": 34
}