Skip to:
Content

bbPress.org

Changeset 6526


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.

Location:
trunk/src/includes/replies
Files:
2 edited

Legend:

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

    r6499 r6526  
    838838 * @uses bbp_update_reply_topic_id() To update the reply topic id
    839839 * @uses bbp_update_reply_to() To update the reply to id
    840  * @uses bbp_update_reply_walker() To update the reply's ancestors' counts
     840 * @uses bbp_update_reply_walker() To update the ancestor counts of a reply
    841841 */
    842842function bbp_update_reply( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $author_id = 0, $is_edit = false, $reply_to = 0 ) {
     
    10631063 * @uses bbp_get_reply_id() To get the reply id
    10641064 * @uses bbp_get_forum_id() To get the forum id
    1065  * @uses get_post_ancestors() To get the reply's forum
     1065 * @uses get_post_ancestors() To get the ancestors of a reply
    10661066 * @uses get_post_field() To get the post type of the post
    10671067 * @uses update_post_meta() To update the reply forum id meta
    10681068 * @uses apply_filters() Calls 'bbp_update_reply_forum_id' with the forum id
    10691069 *                        and reply id
    1070  * @return bool Reply's forum id
     1070 * @return bool The forum id of the reply
    10711071 */
    10721072function bbp_update_reply_forum_id( $reply_id = 0, $forum_id = 0 ) {
     
    11131113 * @uses bbp_get_reply_id() To get the reply id
    11141114 * @uses bbp_get_topic_id() To get the topic id
    1115  * @uses get_post_ancestors() To get the reply's topic
     1115 * @uses get_post_ancestors() To get the ancestors of a reply
    11161116 * @uses get_post_field() To get the post type of the post
    11171117 * @uses update_post_meta() To update the reply topic id meta
    11181118 * @uses apply_filters() Calls 'bbp_update_reply_topic_id' with the topic id
    11191119 *                        and reply id
    1120  * @return bool Reply's topic id
     1120 * @return bool The topic id of the reply
    11211121 */
    11221122function bbp_update_reply_topic_id( $reply_id = 0, $topic_id = 0 ) {
     
    11551155
    11561156/*
    1157  * Update the reply's meta data with its reply to id
     1157 * Update the meta data with its parent reply-to id, of a reply
    11581158 *
    11591159 * @since 2.4.0 bbPress (r4944)
     
    11651165 * @uses apply_filters() Calls 'bbp_update_reply_to' with the reply id and
    11661166 *                        and reply to id
    1167  * @return bool Reply's parent reply id
     1167 * @return bool The parent reply id of the reply
    11681168 */
    11691169function bbp_update_reply_to( $reply_id = 0, $reply_to = 0 ) {
     
    13431343    /** Topic to Move From ***************************************************/
    13441344
    1345     // Get the reply's current topic
     1345    // Get the current topic a reply is in
    13461346    $source_topic = bbp_get_topic( $move_reply->post_parent );
    13471347
  • 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.