Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/01/2024 04:59:14 PM (6 months ago)
Author:
espellcaste
Message:

PHPDoc: Update incorrect instances of void.

Closes ​https://github.com/buddypress/buddypress/pull/302
See #9164

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-groups/bp-groups-template.php

    r13876 r13882  
    42214221     * @global BP_Core_Members_Template $members_template The Members template loop class.
    42224222     *
    4223      * @return mixed|void
     4223     * @return string|null
    42244224     */
    42254225    function bp_get_group_member_name() {
    … …  
    42514251     * @global BP_Core_Members_Template $members_template The Members template loop class.
    42524252     *
    4253      * @return mixed|void
     4253     * @return string
    42544254     */
    42554255    function bp_get_group_member_url() {
    … …  
    42614261         * @since 1.0.0
    42624262         *
    4263          * @param string $value URL for the current user.
     4263         * @param string $group_member_url URL for the current user.
    42644264         */
    42654265        return apply_filters( 'bp_get_group_member_url', bp_members_get_user_url( $members_template->member->user_id ) );
    … …  
    42824282     * @global BP_Core_Members_Template $members_template The Members template loop class.
    42834283     *
    4284      * @return mixed|void
     4284     * @return string
    42854285     */
    42864286    function bp_get_group_member_link() {
    … …  
    42924292         * @since 1.0.0
    42934293         *
    4294          * @param string $value HTML link for the current user.
     4294         * @param string $group_member_link HTML link for the current user.
    42954295         */
    42964296        return apply_filters( 'bp_get_group_member_link', '<a href="' . esc_url( bp_members_get_user_url( $members_template->member->user_id ) ) . '">' . esc_html( $members_template->member->display_name ) . '</a>' );
    … …  
    43124312     * @global BP_Core_Members_Template $members_template The Members template loop class.
    43134313     *
    4314      * @return mixed|void
     4314     * @return string
    43154315     */
    43164316    function bp_get_group_member_domain() {
    … …  
    43224322         * @since 1.2.0
    43234323         *
    4324          * @param string $value Domain for the current user.
     4324         * @param string $group_member_domain Domain for the current user.
    43254325         */
    43264326        return apply_filters( 'bp_get_group_member_domain', bp_members_get_user_url( $members_template->member->user_id ) );
    … …  
    43424342     * @global BP_Core_Members_Template $members_template The Members template loop class.
    43434343     *
    4344      * @return mixed|void
     4344     * @return string
    43454345     */
    43464346    function bp_get_group_member_is_friend() {
    … …  
    45404540     * @since 1.0.0
    45414541     *
    4542      * @return mixed|void
     4542     * @return string
    45434543     */
    45444544    function bp_get_group_pag_id() {
    … …  
    45494549         * @since 1.0.0
    45504550         *
    4551          * @param string $value Value to use for the pag id.
     4551         * @param string $pag_id Value to use for the pag id.
    45524552         */
    45534553        return apply_filters( 'bp_get_group_pag_id', 'pag' );
    … …  
    45684568     * Returns the group members list pagination links.
    45694569     *
    4570      *  @since 1.0.0
     4570     * @since 1.0.0
    45714571     *
    45724572     * @global BP_Core_Members_Template $members_template The Members template loop class.
    45734573     *
    4574      * @return mixed|void
     4574     * @return string|null
    45754575     */
    45764576    function bp_get_group_member_pagination() {
    … …  
    46024602     * @global BP_Core_Members_Template $members_template The Members template loop class.
    46034603     *
    4604      * @return mixed|void
     4604     * @return string
    46054605     */
    46064606    function bp_get_group_member_pagination_count() {
    … …  
    46244624         * @since 1.0.0
    46254625         *
    4626          * @param string $value    "Viewing x-y of z members" text.
     4626         * @param string $message  "Viewing x-y of z members" text.
    46274627         * @param string $from_num Total amount for the low value in the range.
    46284628         * @param string $to_num   Total amount for the high value in the range.
    … …  
    61556155 * @since 1.1.0
    61566156 *
    6157  * @param string $args
    6158  * @return bool|mixed|void
     6157 * @param string|array $args {
     6158 *    @type int $group_id ID of the group. Defaults to current group.
     6159 *    @type int $user_id  ID of the user. Defaults to logged-in user.
     6160 *    @type int $per_page Number of records to return per page. Default: 10.
     6161 *    @type int $page     Page of results to return. Default: 1.
     6162 * }
     6163 * @return bool
    61596164 */
    61606165function bp_group_has_invites( $args = '' ) {
    … …  
    61966201     * @since 1.1.0
    61976202     *
    6198      * @param bool                      $value            Whether there are requests to display.
     6203     * @param bool                      $invites          Whether there are invites to display.
    61996204     * @param BP_Groups_Invite_Template $invites_template Object holding the invites query results.
    62006205     */
    … …  
    62346239     * @since 1.1.0
    62356240     *
    6236      * @return mixed|void
     6241     * @return string
    62376242     */
    62386243    function bp_get_group_invite_item_id() {
    … …  
    62446249         * @since 1.1.0
    62456250         *
    6246          * @param string $value Group invite item ID.
     6251         * @param string $group_invite_item_id Group invite item ID.
    62476252         */
    62486253        return apply_filters( 'bp_get_group_invite_item_id', 'uid-' . $invites_template->invite->user->id );
    … …  
    62606265     * @since 1.1.0
    62616266     *
    6262      * @return mixed|void
     6267     * @return string|null
    62636268     */
    62646269    function bp_get_group_invite_user_avatar() {
    … …  
    62706275         * @since 1.1.0
    62716276         *
    6272          * @param string $value Group invite user avatar.
     6277         * @param string $invite_user_avatar Group invite user avatar.
    62736278         */
    62746279        return apply_filters( 'bp_get_group_invite_user_avatar', $invites_template->invite->user->avatar_thumb );
    … …  
    62866291     * @since 1.1.0
    62876292     *
    6288      * @return mixed|void
     6293     * @return string
    62896294     */
    62906295    function bp_get_group_invite_user_link() {
    … …  
    62966301         * @since 1.1.0
    62976302         *
    6298          * @param string $value Group invite user link.
    6299          */
    6300         return apply_filters( 'bp_get_group_invite_user_link', bp_core_get_userlink( $invites_template->invite->user->id ) );
     6303         * @param string $user_link Group invite user link.
     6304         */
     6305        return apply_filters( 'bp_get_group_invite_user_link', (string) bp_core_get_userlink( $invites_template->invite->user->id ) );
    63016306    }
    63026307
    … …  
    63116316     * @since 1.1.0
    63126317     *
    6313      * @return mixed|void
     6318     * @return string|null
    63146319     */
    63156320    function bp_get_group_invite_user_last_active() {
    … …  
    63216326         * @since 1.1.0
    63226327         *
    6323          * @param string $value Group invite user's last active time.
     6328         * @param string $user_last_active Group invite user's last active time.
    63246329         */
    63256330        return apply_filters( 'bp_get_group_invite_user_last_active', $invites_template->invite->user->last_active );
Note: See TracChangeset for help on using the changeset viewer.