Skip to:
Content

bbPress.org


Ignore:
Timestamp:
06/12/2017 02:21:34 PM (7 years ago)
Author:
johnjamesjacoby
Message:

Documentation: Don't use reply's, because it looks weird and is poor English grammar.

Prefer more descriptive documentation instead.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/replies/template.php

    r6487 r6526  
    11691169     * @uses apply_filters() Calls 'bbp_get_reply_author_display_name' with
    11701170     *                        the author display name and reply id
    1171      * @return string Reply's author's display name
     1171     * @return string The display name of the author of the reply
    11721172     */
    11731173    function bbp_get_reply_author_display_name( $reply_id = 0 ) {
     
    15361536     * @uses apply_filters() Calls 'bbp_get_reply_topic_title' with the
    15371537     *                        topic title and reply id
    1538      * @return string Reply's topic's title
     1538     * @return string The topic title of the reply
    15391539     */
    15401540    function bbp_get_reply_topic_title( $reply_id = 0 ) {
     
    15681568     * @uses apply_filters() Calls 'bbp_get_reply_topic_id' with the topic
    15691569     *                        id and reply id
    1570      * @return int Reply's topic id
     1570     * @return int The topic id of the reply
    15711571     */
    15721572    function bbp_get_reply_topic_id( $reply_id = 0 ) {
     
    16091609     * @uses apply_filters() Calls 'bbp_get_reply_forum_id' with the forum
    16101610     *                        id and reply id
    1611      * @return int Reply's forum id
     1611     * @return int The forum id of the reply
    16121612     */
    16131613    function bbp_get_reply_forum_id( $reply_id = 0 ) {
     
    16301630
    16311631/**
    1632  * Output the reply's ancestor reply id
     1632 * Output the ancestor reply id of a reply
    16331633 *
    16341634 * @since 2.4.0 bbPress (r4944)
    16351635 *
    16361636 * @param int $reply_id Optional. Reply id
    1637  * @uses bbp_get_reply_ancestor_id() To get the reply's ancestor id
     1637 * @uses bbp_get_reply_ancestor_id() To get the ancestor id of the reply
    16381638 */
    16391639function bbp_reply_ancestor_id( $reply_id = 0 ) {
     
    16411641}
    16421642    /**
    1643      * Return the reply's ancestor reply id
     1643     * Return the ancestor reply id of a reply
    16441644     *
    16451645     * @since 2.4.0 bbPress (r4944)
     
    16891689     * @uses apply_filters() Calls 'bbp_get_reply_to' with the reply to id and
    16901690     *                        reply id
    1691      * @return int Reply's reply to id
     1691     * @return int The parent reply id of the reply
    16921692     */
    16931693    function bbp_get_reply_to( $reply_id = 0 ) {
     
    25032503     * @param array Extra classes you can pass when calling this function
    25042504     * @uses bbp_get_reply_id() To validate the reply id
    2505      * @uses bbp_get_reply_forum_id() To get the reply's forum id
    2506      * @uses bbp_get_reply_topic_id() To get the reply's topic id
     2505     * @uses bbp_get_reply_forum_id() To get the forum id of the reply
     2506     * @uses bbp_get_reply_topic_id() To get the topic id of the reply
    25072507     * @uses get_post_class() To get all the classes including ours
    25082508     * @uses apply_filters() Calls 'bbp_get_reply_class' with the classes
Note: See TracChangeset for help on using the changeset viewer.