Skip to:
Content

BuddyPress.org

Changeset 9268


Ignore:
Timestamp:
12/24/2014 02:29:00 AM (10 years ago)
Author:
tw2113
Message:

Add hook documentation in bp-members-classes.php.

Props tw2113.
See #5944

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-members/bp-members-classes.php

    r9200 r9268  
    176176        $sql['where'] = 'WHERE ' . implode( ' AND ', $sql['where'] );
    177177
     178        /**
     179         * Filters the Signups paged query.
     180         *
     181         * @since BuddyPress (2.0.0)
     182         *
     183         * @param string $value SQL statement.
     184         * @param array  $sql   Array of SQL statement parts.
     185         * @param array  $args  Array of original arguments for get() method.
     186         * @param array  $r     Array of parsed arguments for get() method.
     187         */
    178188        $paged_signups = $wpdb->get_results( apply_filters( 'bp_members_signups_paged_query', join( ' ', $sql ), $sql, $args, $r ) );
    179189
    … …  
    226236        unset( $sql['limit'] );
    227237        $sql['select'] = preg_replace( "/SELECT.*?FROM/", "SELECT COUNT(*) FROM", $sql['select'] );
     238
     239        /**
     240         * Filters the Signups count query.
     241         *
     242         * @since BuddyPress (2.0.0)
     243         *
     244         * @param string $value SQL statement.
     245         * @param array  $sql   Array of SQL statement parts.
     246         * @param array  $args  Array of original arguments for get() method.
     247         * @param array  $r     Array of parsed arguments for get() method.
     248         */
    228249        $total_signups = $wpdb->get_var( apply_filters( 'bp_members_signups_count_query', join( ' ', $sql ), $sql, $args, $r ) );
    229250
    … …  
    271292        }
    272293
     294        /**
     295         * Filters the result of a signup addition.
     296         *
     297         * @since BuddyPress (2.0.0)
     298         *
     299         * @param int|bool $retval Newly added user ID on success, false on failure.
     300         */
    273301        return apply_filters( 'bp_core_signups_add', $retval );
    274302    }
    … …  
    336364        }
    337365
     366        /**
     367         * Filters the user ID for the backcompat functionality.
     368         *
     369         * @since BuddyPress (2.0.0)
     370         *
     371         * @param int $user_id User ID being registered.
     372         */
    338373        return apply_filters( 'bp_core_signups_add_backcompat', $user_id );
    339374    }
    … …  
    356391        $user_status = $wpdb->get_var( $wpdb->prepare( "SELECT user_status FROM {$wpdb->users} WHERE ID = %d", $user_id ) );
    357392
     393        /**
     394         * Filters the user status of a provided user ID.
     395         *
     396         * @since BuddyPress (2.0.0)
     397         *
     398         * @param int $value User status of the provided user ID.
     399         */
    358400        return apply_filters( 'bp_core_signups_check_user_status', intval( $user_status ) );
    359401    }
    … …  
    395437        );
    396438
     439        /**
     440         * Filters the status of the activated user.
     441         *
     442         * @since BuddyPress (2.0.0)
     443         *
     444         * @param bool $activated Whether or not the activation was successful.
     445         */
    397446        return apply_filters( 'bp_core_signups_validate', $activated );
    398447    }
    … …  
    411460        $count_signups = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) AS total FROM {$signups_table} WHERE active = %d", 0 ) );
    412461
     462        /**
     463         * Filters the total inactive signups.
     464         *
     465         * @since BuddyPress (2.0.0)
     466         *
     467         * @param int $count_signups How many total signups there are.
     468         */
    413469        return apply_filters( 'bp_core_signups_count', (int) $count_signups );
    414470    }
    … …  
    461517        );
    462518
     519        /**
     520         * Filters the signup ID which received a meta update.
     521         *
     522         * @since BuddyPress (2.0.0)
     523         *
     524         * @param int $value The signup ID.
     525         */
    463526        return apply_filters( 'bp_core_signups_update', $r['signup_id'] );
    464527    }
    … …  
    487550        $result = array();
    488551
     552        /**
     553         * Fires before activation emails are resent.
     554         *
     555         * @since BuddyPress (2.0.0)
     556         *
     557         * @param array $signup_ids Array of IDs to resend activation emails to.
     558         */
    489559        do_action( 'bp_core_signup_before_resend', $signup_ids );
    490560
    … …  
    526596        }
    527597
     598        /**
     599         * Fires after activation emails are resent.
     600         *
     601         * @since BuddyPress (2.0.0)
     602         *
     603         * @param array $signup_ids Array of IDs to resend activation emails to.
     604         * @param array $result     Updated metadata related to activation emails.
     605         */
    528606        do_action( 'bp_core_signup_after_resend', $signup_ids, $result );
    529607
     608        /**
     609         * Filters the result of the metadata for signup activation email resends.
     610         *
     611         * @since BuddyPress (2.0.0)
     612         *
     613         * @param array $result Updated metadata related to activation emails.
     614         */
    530615        return apply_filters( 'bp_core_signup_resend', $result );
    531616    }
    … …  
    554639        $result = array();
    555640
     641        /**
     642         * Fires before activation of user accounts.
     643         *
     644         * @since BuddyPress (2.0.0)
     645         *
     646         * @param array $signup_ids Array of IDs to activate.
     647         */
    556648        do_action( 'bp_core_signup_before_activate', $signup_ids );
    557649
    … …  
    586678        }
    587679
     680        /**
     681         * Fires after activation of user accounts.
     682         *
     683         * @since BuddyPress (2.0.0)
     684         *
     685         * @param array $signup_ids Array of IDs activated activate.
     686         * @param array $result     Array of data for activated accounts.
     687         */
    588688        do_action( 'bp_core_signup_after_activate', $signup_ids, $result );
    589689
     690        /**
     691         * Filters the result of the metadata after user activation.
     692         *
     693         * @since BuddyPress (2.0.0)
     694         *
     695         * @param array $result Updated metadata related to user activation.
     696         */
    590697        return apply_filters( 'bp_core_signup_activate', $result );
    591698    }
    … …  
    616723        $result = array();
    617724
     725        /**
     726         * Fires before deletion of pending accounts.
     727         *
     728         * @since BuddyPress (2.0.0)
     729         *
     730         * @param array $signup_ids Array of pending IDs to delete.
     731         */
    618732        do_action( 'bp_core_signup_before_delete', $signup_ids );
    619733
    … …  
    651765        }
    652766
     767        /**
     768         * Fires after deletion of pending accounts.
     769         *
     770         * @since BuddyPress (2.0.0)
     771         *
     772         * @param array $signup_ids Array of pending IDs to delete.
     773         * @param array $result     Array of data for deleted accounts.
     774         */
    653775        do_action( 'bp_core_signup_after_delete', $signup_ids, $result );
    654776
     777        /**
     778         * Filters the result of the metadata for deleted pending accounts.
     779         *
     780         * @since BuddyPress (2.0.0)
     781         *
     782         * @param array $result Updated metadata related to deleted pending accounts.
     783         */
    655784        return apply_filters( 'bp_core_signup_delete', $result );
    656785    }
Note: See TracChangeset for help on using the changeset viewer.