Comments: Modernise JavaScript for comment reply links.
Update the comment reply JavaScript to be unobtrusive and use events rather than inline `onclick` attributes. Along with bringing the code into the 2010s this prevents an edge-case in which `addComment.moveForm()` could be called before the JavaScript has loaded. Props peterwilsoncc, bradparbs. Fixes #31590. git-svn-id: https://develop.svn.wordpress.org/trunk@42360 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Wilson
parent
d989b8e402
commit
14dd35e62e
|
|
@ -1667,15 +1667,25 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
|
||||||
$args['login_text']
|
$args['login_text']
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
$onclick = sprintf(
|
$data_attributes = array(
|
||||||
'return addComment.moveForm( "%1$s-%2$s", "%2$s", "%3$s", "%4$s" )',
|
'commentid' => $comment->comment_ID,
|
||||||
$args['add_below'], $comment->comment_ID, $args['respond_id'], $post->ID
|
'postid' => $post->ID,
|
||||||
|
'belowelement' => $args['add_below'] . '-' . $comment->comment_ID,
|
||||||
|
'respondelement' => $args['respond_id'],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
$data_attribute_string = '';
|
||||||
|
|
||||||
|
foreach ( $data_attributes as $name => $value ) {
|
||||||
|
$data_attribute_string .= " data-${name}=\"" . esc_attr( $value ) . "\"";
|
||||||
|
}
|
||||||
|
|
||||||
|
$data_attribute_string = trim( $data_attribute_string );
|
||||||
|
|
||||||
$link = sprintf(
|
$link = sprintf(
|
||||||
"<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s' aria-label='%s'>%s</a>",
|
"<a rel='nofollow' class='comment-reply-link' href='%s' %s aria-label='%s'>%s</a>",
|
||||||
esc_url( add_query_arg( 'replytocom', $comment->comment_ID, get_permalink( $post->ID ) ) ) . '#' . $args['respond_id'],
|
esc_url( add_query_arg( 'replytocom', $comment->comment_ID ) ) . "#" . $args['respond_id'],
|
||||||
$onclick,
|
$data_attribute_string,
|
||||||
esc_attr( sprintf( $args['reply_to_text'], $comment->comment_author ) ),
|
esc_attr( sprintf( $args['reply_to_text'], $comment->comment_author ) ),
|
||||||
$args['reply_text']
|
$args['reply_text']
|
||||||
);
|
);
|
||||||
|
|
|
||||||
|
|
@ -5,86 +5,252 @@
|
||||||
*
|
*
|
||||||
* @type {Object}
|
* @type {Object}
|
||||||
*/
|
*/
|
||||||
var addComment = {
|
var addComment;
|
||||||
|
addComment = ( function( window ) {
|
||||||
|
// Avoid scope lookups on commonly used variables.
|
||||||
|
var document = window.document;
|
||||||
|
|
||||||
|
// Settings.
|
||||||
|
var config = {
|
||||||
|
commentReplyClass : 'comment-reply-link',
|
||||||
|
cancelReplyId : 'cancel-comment-reply-link',
|
||||||
|
commentFormId : 'commentform',
|
||||||
|
temporaryFormId : 'wp-temp-form-div',
|
||||||
|
parentIdFieldId : 'comment_parent',
|
||||||
|
postIdFieldId : 'comment_post_ID'
|
||||||
|
};
|
||||||
|
|
||||||
|
// Check browser cuts the mustard.
|
||||||
|
var cutsTheMustard = 'querySelector' in document && 'addEventListener' in window;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Check browser supports dataset.
|
||||||
|
* !! sets the variable to true if the property exists.
|
||||||
|
*/
|
||||||
|
var supportsDataset = !! document.body.dataset;
|
||||||
|
|
||||||
|
// For holding the cancel element.
|
||||||
|
var cancelElement;
|
||||||
|
|
||||||
|
// For holding the comment form element.
|
||||||
|
var commentFormElement;
|
||||||
|
|
||||||
|
// The respond element.
|
||||||
|
var respondElement;
|
||||||
|
|
||||||
|
// Initialise the events.
|
||||||
|
init();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @summary Retrieves the elements corresponding to the given IDs.
|
* Add events to links classed .comment-reply-link.
|
||||||
|
*
|
||||||
|
* Searches the context for reply links and adds the JavaScript events
|
||||||
|
* required to move the comment form. To allow for lazy loading of
|
||||||
|
* comments this method is exposed as window.commentReply.init().
|
||||||
|
*
|
||||||
|
* @since 5.0.0
|
||||||
|
*
|
||||||
|
* @param {HTMLElement} context The parent DOM element to search for links.
|
||||||
|
*/
|
||||||
|
function init( context ) {
|
||||||
|
if ( true !== cutsTheMustard ) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get required elements.
|
||||||
|
cancelElement = getElementById( config.cancelReplyId );
|
||||||
|
commentFormElement = getElementById( config.commentFormId );
|
||||||
|
|
||||||
|
// No cancel element, no replies.
|
||||||
|
if ( ! cancelElement ) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
cancelElement.addEventListener( 'touchstart', cancelEvent );
|
||||||
|
cancelElement.addEventListener( 'click', cancelEvent );
|
||||||
|
|
||||||
|
var links = replyLinks( context );
|
||||||
|
var element;
|
||||||
|
|
||||||
|
for ( var i = 0, l = links.length; i < l; i++ ) {
|
||||||
|
element = links[i];
|
||||||
|
|
||||||
|
element.addEventListener( 'touchstart', clickEvent );
|
||||||
|
element.addEventListener( 'click', clickEvent );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all links classed .comment-reply-link.
|
||||||
|
*
|
||||||
|
* @since 5.0.0
|
||||||
|
*
|
||||||
|
* @param {HTMLElement} context The parent DOM element to search for links.
|
||||||
|
*
|
||||||
|
* @return {HTMLCollection|NodeList|Array}
|
||||||
|
*/
|
||||||
|
function replyLinks( context ) {
|
||||||
|
var selectorClass = config.commentReplyClass;
|
||||||
|
var allReplyLinks;
|
||||||
|
|
||||||
|
// childNodes is a handy check to ensure the context is a HTMLElement.
|
||||||
|
if ( ! context || ! context.childNodes ) {
|
||||||
|
context = document;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( document.getElementsByClassName ) {
|
||||||
|
// Fastest.
|
||||||
|
allReplyLinks = context.getElementsByClassName( selectorClass );
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// Fast.
|
||||||
|
allReplyLinks = context.querySelectorAll( '.' + selectorClass );
|
||||||
|
}
|
||||||
|
|
||||||
|
return allReplyLinks;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cancel event handler.
|
||||||
|
*
|
||||||
|
* @since 5.0.0
|
||||||
|
*
|
||||||
|
* @param {Event} event The calling event.
|
||||||
|
*/
|
||||||
|
function cancelEvent( event ) {
|
||||||
|
var cancelLink = this;
|
||||||
|
var temporaryFormId = config.temporaryFormId;
|
||||||
|
var temporaryElement = getElementById( temporaryFormId );
|
||||||
|
|
||||||
|
if ( ! temporaryElement || ! respondElement ) {
|
||||||
|
// Conditions for cancel link fail.
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
getElementById( config.parentIdFieldId ).value = '0';
|
||||||
|
|
||||||
|
// Move the respond form back in place of the temporary element.
|
||||||
|
temporaryElement.parentNode.replaceChild( respondElement ,temporaryElement );
|
||||||
|
cancelLink.style.display = 'none';
|
||||||
|
event.preventDefault();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Click event handler.
|
||||||
|
*
|
||||||
|
* @since 5.0.0
|
||||||
|
*
|
||||||
|
* @param {Event} event The calling event.
|
||||||
|
*/
|
||||||
|
function clickEvent( event ) {
|
||||||
|
var replyLink = this,
|
||||||
|
commId = getDataAttribute( replyLink, 'belowelement'),
|
||||||
|
parentId = getDataAttribute( replyLink, 'commentid' ),
|
||||||
|
respondId = getDataAttribute( replyLink, 'respondelement'),
|
||||||
|
postId = getDataAttribute( replyLink, 'postid'),
|
||||||
|
follow;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Third party comments systems can hook into this function via the global scope,
|
||||||
|
* therefore the click event needs to reference the global scope.
|
||||||
|
*/
|
||||||
|
follow = window.addComment.moveForm(commId, parentId, respondId, postId);
|
||||||
|
if ( false === follow ) {
|
||||||
|
event.preventDefault();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Backward compatible getter of data-* attribute.
|
||||||
|
*
|
||||||
|
* Uses element.dataset if it exists, otherwise uses getAttribute.
|
||||||
|
*
|
||||||
|
* @since 5.0.0
|
||||||
|
*
|
||||||
|
* @param {HTMLElement} Element DOM element with the attribute.
|
||||||
|
* @param {String} Attribute the attribute to get.
|
||||||
|
*
|
||||||
|
* @return {String}
|
||||||
|
*/
|
||||||
|
function getDataAttribute( element, attribute ) {
|
||||||
|
if ( supportsDataset ) {
|
||||||
|
return element.dataset[attribute];
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return element.getAttribute( 'data-' + attribute );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get element by ID.
|
||||||
|
*
|
||||||
|
* Local alias for document.getElementById.
|
||||||
|
*
|
||||||
|
* @since 5.0.0
|
||||||
|
*
|
||||||
|
* @param {HTMLElement} The requested element.
|
||||||
|
*/
|
||||||
|
function getElementById( elementId ) {
|
||||||
|
return document.getElementById( elementId );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Moves the reply form from its current position to the reply location.
|
||||||
*
|
*
|
||||||
* @since 2.7.0
|
* @since 2.7.0
|
||||||
*
|
*
|
||||||
* @param {string} commId The comment ID.
|
* @param {String} addBelowId HTML ID of element the form follows.
|
||||||
* @param {string} parentId The parent ID.
|
* @param {String} commentId Database ID of comment being replied to.
|
||||||
* @param {string} respondId The respond ID.
|
* @param {String} respondId HTML ID of 'respond' element.
|
||||||
* @param {string} postId The post ID.
|
* @param {String} postId Database ID of the post.
|
||||||
* @returns {boolean} Always returns false.
|
|
||||||
*/
|
*/
|
||||||
moveForm: function( commId, parentId, respondId, postId ) {
|
function moveForm( addBelowId, commentId, respondId, postId ) {
|
||||||
var div, element, style, cssHidden,
|
// Get elements based on their IDs.
|
||||||
t = this,
|
var addBelowElement = getElementById( addBelowId );
|
||||||
comm = t.I( commId ),
|
respondElement = getElementById( respondId );
|
||||||
respond = t.I( respondId ),
|
|
||||||
cancel = t.I( 'cancel-comment-reply-link' ),
|
|
||||||
parent = t.I( 'comment_parent' ),
|
|
||||||
post = t.I( 'comment_post_ID' ),
|
|
||||||
commentForm = respond.getElementsByTagName( 'form' )[0];
|
|
||||||
|
|
||||||
if ( ! comm || ! respond || ! cancel || ! parent || ! commentForm ) {
|
// Get the hidden fields.
|
||||||
|
var parentIdField = getElementById( config.parentIdFieldId );
|
||||||
|
var postIdField = getElementById( config.postIdFieldId );
|
||||||
|
var element, cssHidden, style;
|
||||||
|
|
||||||
|
if ( ! addBelowElement || ! respondElement || ! parentIdField ) {
|
||||||
|
// Missing key elements, fail.
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
t.respondId = respondId;
|
addPlaceHolder( respondElement );
|
||||||
postId = postId || false;
|
|
||||||
|
|
||||||
if ( ! t.I( 'wp-temp-form-div' ) ) {
|
// Set the value of the post.
|
||||||
div = document.createElement( 'div' );
|
if ( postId && postIdField ) {
|
||||||
div.id = 'wp-temp-form-div';
|
postIdField.value = postId;
|
||||||
div.style.display = 'none';
|
|
||||||
respond.parentNode.insertBefore( div, respond );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
comm.parentNode.insertBefore( respond, comm.nextSibling );
|
parentIdField.value = commentId;
|
||||||
if ( post && postId ) {
|
|
||||||
post.value = postId;
|
|
||||||
}
|
|
||||||
parent.value = parentId;
|
|
||||||
cancel.style.display = '';
|
|
||||||
|
|
||||||
/**
|
cancelElement.style.display = '';
|
||||||
* @summary Puts back the comment, hides the cancel button and removes the onclick event.
|
addBelowElement.parentNode.insertBefore( respondElement, addBelowElement.nextSibling );
|
||||||
*
|
|
||||||
* @returns {boolean} Always returns false.
|
/*
|
||||||
|
* This is for backward compatibility with third party commenting systems
|
||||||
|
* hooking into the event using older techniques.
|
||||||
*/
|
*/
|
||||||
cancel.onclick = function() {
|
cancelElement.onclick = function(){
|
||||||
var t = addComment,
|
|
||||||
temp = t.I( 'wp-temp-form-div' ),
|
|
||||||
respond = t.I( t.respondId );
|
|
||||||
|
|
||||||
if ( ! temp || ! respond ) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
t.I( 'comment_parent' ).value = '0';
|
|
||||||
temp.parentNode.insertBefore( respond, temp );
|
|
||||||
temp.parentNode.removeChild( temp );
|
|
||||||
this.style.display = 'none';
|
|
||||||
this.onclick = null;
|
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
/*
|
// Focus on the first field in the comment form.
|
||||||
* Sets initial focus to the first form focusable element.
|
|
||||||
* Uses try/catch just to avoid errors in IE 7- which return visibility
|
|
||||||
* 'inherit' when the visibility value is inherited from an ancestor.
|
|
||||||
*/
|
|
||||||
try {
|
try {
|
||||||
for ( var i = 0; i < commentForm.elements.length; i++ ) {
|
for ( var i = 0; i < commentFormElement.elements.length; i++ ) {
|
||||||
element = commentForm.elements[i];
|
element = commentFormElement.elements[i];
|
||||||
cssHidden = false;
|
cssHidden = false;
|
||||||
|
|
||||||
// Modern browsers.
|
// Get elements computed style.
|
||||||
if ( 'getComputedStyle' in window ) {
|
if ( 'getComputedStyle' in window ) {
|
||||||
|
// Modern browsers.
|
||||||
style = window.getComputedStyle( element );
|
style = window.getComputedStyle( element );
|
||||||
// IE 8.
|
|
||||||
} else if ( document.documentElement.currentStyle ) {
|
} else if ( document.documentElement.currentStyle ) {
|
||||||
|
// IE 8.
|
||||||
style = element.currentStyle;
|
style = element.currentStyle;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -107,21 +273,45 @@ var addComment = {
|
||||||
// Stop after the first focusable element.
|
// Stop after the first focusable element.
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
catch(e) {
|
||||||
|
|
||||||
} catch( er ) {}
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* false is returned for backward compatibility with third party commenting systems
|
||||||
|
* hooking into this function.
|
||||||
|
*/
|
||||||
return false;
|
return false;
|
||||||
},
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @summary Returns the object corresponding to the given ID.
|
* Add placeholder element.
|
||||||
|
*
|
||||||
|
* Places a place holder element above the #respond element for
|
||||||
|
* the form to be returned to if needs be.
|
||||||
*
|
*
|
||||||
* @since 2.7.0
|
* @since 2.7.0
|
||||||
*
|
*
|
||||||
* @param {string} id The ID.
|
* @param {HTMLelement} respondElement the #respond element holding comment form.
|
||||||
* @returns {Element} The element belonging to the ID.
|
|
||||||
*/
|
*/
|
||||||
I: function( id ) {
|
function addPlaceHolder( respondElement ) {
|
||||||
return document.getElementById( id );
|
var temporaryFormId = config.temporaryFormId;
|
||||||
|
var temporaryElement = getElementById( temporaryFormId );
|
||||||
|
|
||||||
|
if ( temporaryElement ) {
|
||||||
|
// The element already exists, no need to recreate.
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
temporaryElement = document.createElement( 'div' );
|
||||||
|
temporaryElement.id = temporaryFormId;
|
||||||
|
temporaryElement.style.display = 'none';
|
||||||
|
respondElement.parentNode.insertBefore( temporaryElement, respondElement );
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
init: init,
|
||||||
|
moveForm: moveForm
|
||||||
};
|
};
|
||||||
|
})( window );
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue