Add comment type support to comments connector

[lukecarbis]

This allows other comment types like:

• pingbacks
• trackbacks
• any new comment types added by a theme or plugin

... to be accurately logged by Stream.

[frankiejarrett]

@lukecarbis I'm not sure we should be using get_comment_type() alone, because that just gets the comment type slug (much like a post type slug) and not the comment type label which is a translatable string.

cf. https://github.com/WordPress/WordPress/blob/master/wp-includes/comment-template.php#L875-L877

Perhaps adding some new methods here is the answer, similar to what we do for attachment types in Media.

/**
 * Return translated comment type labels
 *
 * @return array Comment type label translations
 */
public static function get_comment_type_labels() {
    return array(
        'comment'   => __( 'Comment', 'default' ),
        'trackback' => __( 'Trackback', 'default' ),
        'pingback'  => __( 'Pingback', 'default' ),
    );
}

/**
 * Return the comment type label for a given comment ID
 *
 * @param  int    $comment_id  ID of the comment
 * @return string              The comment type label
 */
public static function get_comment_type_label( $comment_id ) {
    $comment_type = get_comment_type( $comment_id );

    if ( empty( $comment_type ) ) {
        $comment_type = 'comment';
    }

    $comment_type_labels = self::get_comment_type_labels();

    $label = isset( $comment_type_labels[ $comment_type ] ) ? $comment_type_labels[ $comment_type ] : $comment_type;

    return $label;
}

Then in the callbacks do:

$comment_type = mb_strtolower( self::get_comment_type_label( $comment_id ) );

[lukecarbis]

/five thanks @fjarrett, great suggestion. WordPress core should have a better way of handling this.

See Trac #4916 and Trac #12668.

[frankiejarrett]

@lukecarbis Nice idea.

[frankiejarrett]

This is working great. Nicely done, @lukecarbis! /five