[wp-trac] [WordPress Trac] #761: Add hook to conditionally disable comment notifications
WordPress Trac
noreply at wordpress.org
Fri Sep 4 13:46:31 UTC 2015
#761: Add hook to conditionally disable comment notifications
-------------------------------------------------+-------------------------
Reporter: coffee2code | Owner: matt
Type: enhancement | Status: reopened
Priority: normal | Milestone: Future
Component: Comments | Release
Severity: normal | Version: 1.2.2
Keywords: has-patch needs-testing dev- | Resolution:
feedback | Focuses:
-------------------------------------------------+-------------------------
Comment (by DrewAPicture):
On [attachment:761.4.diff], let's not use `@uses` in the context of hooks.
I would prefer for those notes to be in the DocBlock descriptions, and for
hooks particularly, you can simply use the inline `@see` tag with single
quotes syntax.
Example:
{{{
#!php
<?php
/**
* Fires immediately after a comment is inserted into the database.
*
* Calls {@see 'wp_notify_post_author'} to determine if the post author
should be
* notified. Calls {@see 'wp_notify_moderator'} to determin if the site
moderator
* should be notificed.
*
* @since 1.2.0
*
* @param int $comment_ID The comment ID.
* @param int $comment_approved 1 (true) if the comment is approved, 0
(false) if not.
*/
}}}
--
Ticket URL: <https://core.trac.wordpress.org/ticket/761#comment:20>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list