Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-23 05:15:00 +02:00
Code Issues Projects Releases Wiki Activity

Inline documentation for the following filter hooks in wp-includes/pluggable.php:

Browse Source 
* `comment_notification_recipients`
* `comment_notification_notify_author`

Also removes some generic `@uses` tags from various related doc blocks.

Props markjaquith.
Fixes #25699.

Built from https://develop.svn.wordpress.org/trunk@26388


git-svn-id: http://core.svn.wordpress.org/trunk@26288 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-11-26 04:10:09 +00:00
parent 0e99fe6bb5
commit 223a2c7138
2 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
wp-includes/comment.php
View File

@ -1378,15 +1378,6 @@ function wp_throttle_comment_flood($block, $time_lastcomment, $time_newcomment)
*
* @since 1.5.0
* @param array $commentdata Contains information on the comment.
* @uses apply_filters()
* @uses wp_get_comment_status()
* @uses wp_filter_comment()
* @uses wp_allow_comment()
* @uses wp_insert_comment()
* @uses do_action()
* @uses wp_notify_moderator()
* @uses get_option()
* @uses wp_notify_postauthor()
* @return int The ID of the comment after adding.
*/
function wp_new_comment( $commentdata ) {

34
wp-includes/pluggable.php
View File

@ -1006,16 +1006,6 @@ if ( ! function_exists('wp_notify_postauthor') ) :
*
* @param int $comment_id Comment ID
* @param string $deprecated Not used
* @uses get_comment()
* @uses get_post()
* @uses get_userdata()
* @uses apply_filters()
* @uses wp_specialchars_decode()
* @uses get_option()
* @uses __()
* @uses get_permalink()
* @uses admin_url()
* @uses wp_mail()
* @return bool True on completion. False if no email addresses were specified.
*/
function wp_notify_postauthor( $comment_id, $deprecated = null ) {
@ -1032,6 +1022,18 @@ function wp_notify_postauthor( $comment_id, $deprecated = null ) {
// Who to notify? By default, just the post author, but others can be added.
$emails = array( $author->user_email );
/**
* Filter the list of emails to receive a comment notification.
*
* Normally just post authors are notified of emails.
* This filter lets you add others.
*
* @since 3.7.0
*
* @param array $emails Array of email addresses to receive a comment notification.
* @param int $comment_id The comment ID.
*/
$emails = apply_filters( 'comment_notification_recipients', $emails, $comment_id );
$emails = array_filter( $emails );
@ -1043,7 +1045,17 @@ function wp_notify_postauthor( $comment_id, $deprecated = null ) {
// Facilitate unsetting below without knowing the keys.
$emails = array_flip( $emails );
// Post author may want to receive notifications for their own comments
/**
* Filter whether to notify comment authors of their comments on their own posts.
*
* By default, comment authors don't get notified of their comments
* on their own post. This lets you override that.
*
* @since 3.8.0
*
* @param bool $notify Whether to notify the post author of their own comment. Default false.
* @param int $comment_id The comment ID.
*/
$notify_author = apply_filters( 'comment_notification_notify_author', false, $comment_id );
// The comment was left by the author