Skip to:
Content

bbPress.org

Changeset 6747


Ignore:
Timestamp:
11/29/2017 01:25:35 AM (3 years ago)
Author:
johnjamesjacoby
Message:

Update more engagements documentation.

Fixes #3177. Props espellcaste.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/users/engagements.php

    r6746 r6747  
    655655 * @since 2.6.0 bbPress (r5156)
    656656 *
    657  * @param int $object_id Optional. ID of forum, topic, or something else
     657 * @param int $object_id Optional. ID of object (forum, topic, or something else)
    658658 */
    659659function bbp_get_subscribers( $object_id = 0, $type = 'post' ) {
     
    670670 * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
    671671 *
    672  * @param array $args Optional. Arguments to pass into bbp_has_replies()
    673  *
    674  * @return bool True if user has forum subscriptions, otherwise false
     672 * @param array $args Optional. Arguments to pass into bbp_has_topics()
     673 *
     674 * @return bool True if user has topic subscriptions, otherwise false
    675675 */
    676676function bbp_get_user_topic_subscriptions( $args = array() ) {
     
    688688 * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
    689689 *
    690  * @param array $args Optional. Arguments to pass into bbp_has_replies()
     690 * @param array $args Optional. Arguments to pass into bbp_has_forums()
    691691 *
    692692 * @return bool True if user has forum subscriptions, otherwise false
     
    701701
    702702/**
    703  * Check if a topic or forum is in user's subscription list or not
     703 * Check if an object (forum or topic) is in user's subscription list or not
    704704 *
    705705 * @since 2.5.0 bbPress (r5156)
    706706 *
    707707 * @param int $user_id Optional. User id
    708  * @param int $object_id Optional. Topic id
    709  *
    710  * @return bool True if the forum or topic is in user's subscriptions, otherwise false
     708 * @param int $object_id Optional. Object id
     709 *
     710 * @return bool True if the object (forum or topic) is in user's subscriptions, otherwise false
    711711 */
    712712function bbp_is_user_subscribed( $user_id = 0, $object_id = 0, $type = 'post' ) {
     
    724724 *
    725725 * @param int    $user_id   Optional. User id
    726  * @param int    $object_id Optional. Topic id
     726 * @param int    $object_id Optional. Object id
    727727 * @param string $type      Optional. Type of object being subscribed to
    728728 *
    729  * @return bool Always true
     729 * @return bool True if the object was added to user subscriptions, otherwise false
    730730 */
    731731function bbp_add_user_subscription( $user_id = 0, $object_id = 0, $type = 'post' ) {
     
    758758 *
    759759 * @param int    $user_id   Optional. User id
    760  * @param int    $object_id Optional. Topic id
     760 * @param int    $object_id Optional. Object id
    761761 * @param string $type      Optional. Type of object being subscribed to
    762762 *
    763  * @return bool True if the topic was removed from user's subscriptions,
    764  *               otherwise false
     763 * @return bool True if the object was removed from user subscriptions, otherwise false
    765764 */
    766765function bbp_remove_user_subscription( $user_id = 0, $object_id = 0, $type = 'post' ) {
Note: See TracChangeset for help on using the changeset viewer.