Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/03/2015 06:51:25 PM (10 years ago)
Author:
tw2113
Message:

First pass at cleanup of Activity component documetnation.

See #6396.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-activity/bp-activity-filters.php

    r9819 r9833  
    180180 *
    181181 * @param string $content The activity content.
     182 *
    182183 * @return string $content Filtered activity content.
    183184 */
    … …  
    221222 * @since BuddyPress (1.2.0)
    222223 *
    223  * @param string $content The contents of a given item.
    224  * @param int $activity_id The activity id. Deprecated.
     224 * @param string $content     The contents of a given item.
     225 * @param int    $activity_id The activity id. Deprecated.
     226 *
    225227 * @return string $content Content filtered for mentions.
    226228 */
    … …  
    339341    // Send @mentions and setup BP notifications
    340342    foreach( (array) $usernames as $user_id => $username ) {
     343
    341344        /**
    342345         * Filters BuddyPress' ability to send email notifications for @mentions.
    … …  
    344347         * @since BuddyPress (1.6.0)
    345348         *
    346          * @param bool  Whether or not BuddyPress should send a notification to the mentioned users.
     349         * @param bool  $value     Whether or not BuddyPress should send a notification to the mentioned users.
    347350         * @param array $usernames Array of users potentially notified.
    348351         */
    … …  
    362365 *
    363366 * @param string $text Activity text.
     367 *
    364368 * @return string $text Text with rel=nofollow added to any links.
    365369 */
    … …  
    373377     * @since BuddyPress (1.2.0)
    374378     *
    375      * @param array $matches
    376      *
    377379     * @param array $matches Items matched by preg_replace_callback() in bp_activity_make_nofollow_filter().
     380     *
    378381     * @return string $text Link with rel=nofollow added
    379382     */
    … …  
    400403 *
    401404 * @param string $text The original activity entry text.
     405 *
    402406 * @return string $excerpt The truncated text.
    403407 */
    … …  
    408412     * Provides a filter that lets you choose whether to skip this filter on a per-activity basis.
    409413     *
    410      * @param bool $maybe_truncate_text If true, text should be checked to see if it needs truncating.
    411414     * @since BuddyPress (2.3.0)
     415     *
     416     * @param bool $value If true, text should be checked to see if it needs truncating.
    412417     */
    413418    $maybe_truncate_text = apply_filters(
    … …  
    457462     * @since BuddyPress (1.5.0)
    458463     *
    459      * @param string $excerpt Excerpt text and markup to be displayed.
    460      * @param string $text The original activity entry text.
     464     * @param string $excerpt     Excerpt text and markup to be displayed.
     465     * @param string $text        The original activity entry text.
    461466     * @param string $append_text The final append text applied.
    462467     */
    … …  
    472477 *
    473478 * @param array $js_handles The original dependencies.
     479 *
    474480 * @return array $js_handles The new dependencies.
    475481 */
    … …  
    492498 *
    493499 * @param string $classes
     500 *
    494501 * @return string $classes
    495502 */
    … …  
    511518 *
    512519 * @param string $classes
     520 *
    513521 * @return string $classes
    514522 */
    … …  
    540548 * @param array $response
    541549 * @param array $data
     550 *
    542551 * @return array $response
    543552 */
    … …  
    601610 *
    602611 * @param array $strings Localized strings.
     612 *
    603613 * @return array $strings
    604614 */
    … …  
    661671 * @since BuddyPress (2.2.0)
    662672 *
    663  * @param array $retval Empty array by default
    664  * @param array $filter Current activity arguments
     673 * @param array $retval Empty array by default.
     674 * @param array $filter Current activity arguments.
     675 *
    665676 * @return array
    666677 */
    … …  
    710721 * @since BuddyPress (2.2.0)
    711722 *
    712  * @param array $retval Empty array by default
    713  * @param array $filter Current activity arguments
     723 * @param array $retval Empty array by default.
     724 * @param array $filter Current activity arguments.
     725 *
    714726 * @return array
    715727 */
    … …  
    767779 * @since BuddyPress (2.2.0)
    768780 *
    769  * @param array $retval Empty array by default
    770  * @param array $filter Current activity arguments
     781 * @param array $retval Empty array by default.
     782 * @param array $filter Current activity arguments.
     783 *
    771784 * @return array
    772785 */
Note: See TracChangeset for help on using the changeset viewer.