#936 - comment confirmation message

[DavidCramer]

This adds a setting in the discussion page to allow for the changing of the success message when posting a comment.

Fixes #936

[DavidCramer]

initially we were going to use an alternate success message if the user has had an accepted comment before, however this is more complex to do since you need to check etc.
Also, when you post a comment that is to be moderated first, the comment still shows but has a note stating the comment is awaiting moderation.
So the function of this is more to indicate to the user that the comment will show shortly.

[DavidCramer]

@westonruter this is ready for review now. I'm unsure of the approach. I think it's ok, but a second opinion will be good.

[westonruter]

@DavidCramer I think there may be a better way. We actually can determine if the comment was approved via in the \AMP_Theme_Support::handle_xhr_request() call. We can pass back the approval status by changing it to look like this:

add_filter( 'comment_post_redirect', function( $location, $comment ) {
	wp_send_json( array(
		'approved' => '1' === (string) $comment->comment_approved,
	) );
}, PHP_INT_MAX, 2 );

Then inside of AMP_Theme_Support::add_amp_comment_form_templates it can do a conditional message based on this data returned in the XHR handler, for example:

<div submit-success>
	<template type="amp-mustache">
		{{#approved}}
			<?php esc_html_e( 'Your comment has been posted.', 'amp' ); ?>
		{{/approved}}
		{{^approved}}
			<?php esc_html_e( 'Your comment is awaiting moderation.', 'default' ); ?>
		{{/approved}}
	</template>
</div>

Note how it's re-using the default moderation string in core. I couldn't find a default message regarding a comment being accepted, however.

[westonruter]

You may want to open a new PR to implement the alternative approach.

[westonruter]

@DavidCramer on second thought, it may be better to return the message in the same way is being done for the die handler:

add_filter( 'comment_post_redirect', function( $location, $comment ) {
	if ( '1' === (string) $comment->comment_approved ) {
		$message = __( 'Your comment has been approved.', 'amp' );
	} else {
		$message = __( 'Your comment is awaiting moderation.', 'default' );
	}
	$message = apply_filters( 'amp_comment_submitted_message', $message, $comment );
	wp_send_json( array(
		'message' => $message,
		'approved' => $comment->comment_approved,
	) );
}, PHP_INT_MAX, 2 );

Then inside of AMP_Theme_Support::add_amp_comment_form_templates() it can just do:

<div submit-success>
	<template type="amp-mustache">
		{{{message}}}
	</template>
</div>

This will allow for the message to be filtered and for plugins to add support for custom comment statuses.