Skip to:
Content

BuddyPress.org

Changeset 10149


Ignore:
Timestamp:
09/27/2015 05:43:55 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Members Component.

See #6576.

Location:
trunk/src/bp-members
Files:
15 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-members/admin/bp-members-admin-classes.php

    r10026 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Members List Classes
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1615 * List table class for signups admin page.
    1716 *
    18  * @since BuddyPress (2.0.0)
     17 * @since 2.0.0
    1918 */
    2019class BP_Members_List_Table extends WP_Users_List_Table {
     
    2322     * Signup counts.
    2423     *
    25      * @since BuddyPress (2.0.0)
     24     * @since 2.0.0
    2625     *
    2726     * @access public
     
    3332     * Constructor.
    3433     *
    35      * @since BuddyPress (2.0.0)
     34     * @since 2.0.0
    3635     */
    3736    public function __construct() {
     
    5049     * manipulation required prior to rendering.
    5150     *
    52      * @since BuddyPress (2.0.0)
     51     * @since 2.0.0
    5352     */
    5453    public function prepare_items() {
     
    8988     * Get the views (the links above the WP List Table).
    9089     *
    91      * @since BuddyPress (2.0.0)
     90     * @since 2.0.0
    9291     *
    9392     * @uses WP_Users_List_Table::get_views() to get the users views
     
    109108     * As we're dealing with signups, we don't need this.
    110109     *
    111      * @since BuddyPress (2.0.0)
     110     * @since 2.0.0
    112111     *
    113112     * @param array $which
     
    120119     * Specific signups columns.
    121120     *
    122      * @since BuddyPress (2.0.0)
     121     * @since 2.0.0
    123122     */
    124123    public function get_columns() {
     
    127126         * Filters the single site Members signup columns.
    128127         *
    129          * @since BuddyPress (2.0.0)
     128         * @since 2.0.0
    130129         *
    131130         * @param array $value Array of columns to display.
     
    145144     * Specific bulk actions for signups.
    146145     *
    147      * @since BuddyPress (2.0.0)
     146     * @since 2.0.0
    148147     */
    149148    public function get_bulk_actions() {
     
    165164     * Nice job, clean sheet!
    166165     *
    167      * @since BuddyPress (2.0.0)
     166     * @since 2.0.0
    168167     */
    169168    public function no_items() {
     
    189188     * The columns signups can be reordered with.
    190189     *
    191      * @since BuddyPress (2.0.0)
     190     * @since 2.0.0
    192191     */
    193192    public function get_sortable_columns() {
     
    202201     * Display signups rows.
    203202     *
    204      * @since BuddyPress (2.0.0)
     203     * @since 2.0.0
    205204     */
    206205    public function display_rows() {
     
    221220     * Display a signup row.
    222221     *
    223      * @since BuddyPress (2.0.0)
     222     * @since 2.0.0
    224223     *
    225224     * @see WP_List_Table::single_row() for explanation of params.
     
    241240     * Markup for the checkbox used to select items for bulk actions.
    242241     *
    243      * @since BuddyPress (2.0.0)
     242     * @since 2.0.0
    244243     *
    245244     * @param object $signup_object The signup data object.
     
    255254     * The row actions (delete/activate/email).
    256255     *
    257      * @since BuddyPress (2.0.0)
     256     * @since 2.0.0
    258257     *
    259258     * @param object $signup_object The signup data object.
     
    306305         * Filters the multisite row actions for each user in list.
    307306         *
    308          * @since BuddyPress (2.0.0)
     307         * @since 2.0.0
    309308         *
    310309         * @param array  $actions       Array of actions and corresponding links.
     
    319318     * Display user name, if any.
    320319     *
    321      * @since BuddyPress (2.0.0)
     320     * @since 2.0.0
    322321     *
    323322     * @param object $signup_object The signup data object.
     
    330329     * Display user email.
    331330     *
    332      * @since BuddyPress (2.0.0)
     331     * @since 2.0.0
    333332     *
    334333     * @param object $signup_object The signup data object.
     
    341340     * Display registration date.
    342341     *
    343      * @since BuddyPress (2.0.0)
     342     * @since 2.0.0
    344343     *
    345344     * @param object $signup_object The signup data object.
     
    352351     * Display the last time an activation email has been sent.
    353352     *
    354      * @since BuddyPress (2.0.0)
     353     * @since 2.0.0
    355354     *
    356355     * @param object $signup_object The signup data object.
     
    363362     * Display number of time an activation email has been sent.
    364363     *
    365      * @since BuddyPress (2.0.0)
     364     * @since 2.0.0
    366365     *
    367366     * @param object $signup_object Signup object instance.
     
    376375     * Allow plugins to add their custom column.
    377376     *
    378      * @since BuddyPress (2.1.0)
     377     * @since 2.1.0
    379378     *
    380379     * @param object|null $signup_object The signup data object.
     
    388387         * Filters the single site custom columns for plugins.
    389388         *
    390          * @since BuddyPress (2.1.0)
     389         * @since 2.1.0
    391390         *
    392391         * @param string $column_name   The column name.
     
    403402 * List table class for signups network admin page.
    404403 *
    405  * @since BuddyPress (2.0.0)
     404 * @since 2.0.0
    406405 */
    407406class BP_Members_MS_List_Table extends WP_MS_Users_List_Table {
     
    410409     * Signup counts.
    411410     *
    412      * @since BuddyPress (2.0.0)
     411     * @since 2.0.0
    413412     *
    414413     * @access public
     
    420419     * Constructor
    421420     *
    422      * @since BuddyPress (2.0.0)
     421     * @since 2.0.0
    423422     */
    424423    public function __construct() {
     
    437436     * manipulation required prior to rendering.
    438437     *
    439      * @since BuddyPress (2.0.0)
     438     * @since 2.0.0
    440439     */
    441440    public function prepare_items() {
     
    477476     * Get the views : the links above the WP List Table.
    478477     *
    479      * @since BuddyPress (2.0.0)
     478     * @since 2.0.0
    480479     *
    481480     * @uses WP_MS_Users_List_Table::get_views() to get the users views.
     
    494493     * Specific signups columns.
    495494     *
    496      * @since BuddyPress (2.0.0)
     495     * @since 2.0.0
    497496     */
    498497    public function get_columns() {
     
    501500         * Filters the multisite Members signup columns.
    502501         *
    503          * @since BuddyPress (2.0.0)
     502         * @since 2.0.0
    504503         *
    505504         * @param array $value Array of columns to display.
     
    519518     * Specific bulk actions for signups.
    520519     *
    521      * @since BuddyPress (2.0.0)
     520     * @since 2.0.0
    522521     */
    523522    public function get_bulk_actions() {
     
    539538     * Nice job, clean sheet!
    540539     *
    541      * @since BuddyPress (2.0.0)
     540     * @since 2.0.0
    542541     */
    543542    public function no_items() {
     
    558557     * The columns signups can be reordered with.
    559558     *
    560      * @since BuddyPress (2.0.0)
     559     * @since 2.0.0
    561560     */
    562561    public function get_sortable_columns() {
     
    571570     * Display signups rows.
    572571     *
    573      * @since BuddyPress (2.0.0)
     572     * @since 2.0.0
    574573     */
    575574    public function display_rows() {
     
    590589     * Display a signup row.
    591590     *
    592      * @since BuddyPress (2.0.0)
     591     * @since 2.0.0
    593592     *
    594593     * @see WP_List_Table::single_row() for explanation of params.
     
    604603
    605604    /**
    606      * Prevents regular users row actions to be output
    607      *
    608      * @since BuddyPress (2.4.0)
     605     * Prevents regular users row actions to be output.
     606     *
     607     * @since 2.4.0
    609608     * @access protected
    610609     *
     
    612611     * @param string $column_name   Current column name.
    613612     * @param string $primary       Primary column name.
     613     *
     614     * @return string
    614615     */
    615616    protected function handle_row_actions( $signup_object = null, $column_name = '', $primary = '' ) {
     
    620621     * Markup for the checkbox used to select items for bulk actions.
    621622     *
    622      * @since BuddyPress (2.0.0)
     623     * @since 2.0.0
    623624     *
    624625     * @param object|null $signup_object The signup data object.
     
    634635     * The row actions (delete/activate/email).
    635636     *
    636      * @since BuddyPress (2.0.0)
     637     * @since 2.0.0
    637638     *
    638639     * @param object $signup_object The signup data object.
     
    691692     * Display user name, if any.
    692693     *
    693      * @since BuddyPress (2.0.0)
     694     * @since 2.0.0
    694695     *
    695696     * @param object $signup_object The signup data object.
     
    702703     * Display user email.
    703704     *
    704      * @since BuddyPress (2.0.0)
     705     * @since 2.0.0
    705706     *
    706707     * @param object $signup_object The signup data object.
     
    713714     * Display registration date.
    714715     *
    715      * @since BuddyPress (2.0.0)
     716     * @since 2.0.0
    716717     *
    717718     * @param object $signup_object The signup data object.
     
    732733     * Display the last time an activation email has been sent.
    733734     *
    734      * @since BuddyPress (2.0.0)
     735     * @since 2.0.0
    735736     *
    736737     * @param object|null $signup_object Signup object instance.
     
    751752     * Display number of time an activation email has been sent.
    752753     *
    753      * @since BuddyPress (2.0.0)
     754     * @since 2.0.0
    754755     *
    755756     * @param object|null $signup_object Signup object instance.
     
    774775         * Filters the multisite custom columns for plugins.
    775776         *
    776          * @since BuddyPress (2.1.0)
     777         * @since 2.1.0
    777778         *
    778779         * @param string $column_name   The column name.
  • trunk/src/bp-members/admin/js/admin.js

    r9819 r10149  
    3030 *
    3131 * @param {String} container HTML ID of the field
    32  * @since BuddyPress (1.0.0)
     32 * @since 1.0.0
    3333 */
    3434function clear( container ) {
  • trunk/src/bp-members/bp-members-actions.php

    r9877 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Members Actions
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    6463    }
    6564}
    66 // Unhooked in BuddyPress (1.6.0) - moved to settings
     65// Unhooked in 1.6.0 - moved to settings
    6766//add_action( 'bp_actions', 'bp_core_action_set_spammer_status' );
    6867
     
    10099    }
    101100}
    102 // Unhooked in BuddyPress (1.6.0) - moved to settings
     101// Unhooked in 1.6.0 - moved to settings
    103102//add_action( 'bp_actions', 'bp_core_action_delete_user' );
    104103
     
    106105 * Redirect to a random member page when visiting a ?random-member URL.
    107106 *
    108  * @since BuddyPress (1.0.0)
     107 * @since 1.0.0
    109108 */
    110109function bp_core_get_random_member() {
  • trunk/src/bp-members/bp-members-activity.php

    r9877 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Activity
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Register the 'new member' activity type.
    1514 *
    16  * @since BuddyPress (2.2.0)
     15 * @since 2.2.0
    1716 *
    1817 * @uses bp_activity_set_action()
     
    3332     * Fires after the default 'new member' activity types are registered.
    3433     *
    35      * @since BuddyPress (2.2.0)
     34     * @since 2.2.0
    3635     */
    3736    do_action( 'bp_members_register_activity_actions' );
     
    4241 * Format 'new_member' activity actions.
    4342 *
    44  * @since BuddyPress (2.2.0)
     43 * @since 2.2.0
    4544 *
    4645 * @param string $action   Static activity action.
     
    6160     * Filters the formatted 'new member' activity actions.
    6261     *
    63      * @since BuddyPress (2.2.0)
     62     * @since 2.2.0
    6463     *
    6564     * @param string $action   Static activity action.
  • trunk/src/bp-members/bp-members-admin.php

    r10127 r10149  
    11<?php
    2 
    3 // Exit if accessed directly
     2/**
     3 * BuddyPress Members Admin
     4 *
     5 * @package BuddyPress
     6 * @subpackage MembersAdmin
     7 */
     8
     9// Exit if accessed directly.
    410defined( 'ABSPATH' ) || exit;
    511
    612if ( !class_exists( 'BP_Members_Admin' ) ) :
     13
    714/**
    815 * Load Members admin area.
     
    1118 * @subpackage membersAdministration
    1219 *
    13  * @since BuddyPress (2.0.0)
     20 * @since 2.0.0
    1421 */
    1522class BP_Members_Admin {
     
    6168     *
    6269     * @access public
    63      * @since BuddyPress (2.0.0)
     70     * @since 2.0.0
    6471     *
    6572     * @uses buddypress() to get BuddyPress main instance.
     
    8390     *
    8491     * @access public
    85      * @since BuddyPress (2.0.0)
     92     * @since 2.0.0
    8693     */
    8794    public function __construct() {
     
    94101     *
    95102     * @access private
    96      * @since BuddyPress (2.0.0)
     103     * @since 2.0.0
    97104     */
    98105    private function setup_globals() {
     
    153160     *
    154161     * @access private
    155      * @since BuddyPress (2.0.0)
     162     * @since 2.0.0
    156163     */
    157164    private function setup_actions() {
     
    213220     * current user's ID so they aren't left without a user to edit.
    214221     *
    215      * @since BuddyPress (2.1.0)
     222     * @since 2.1.0
    216223     *
    217224     * @return int
     
    240247     *
    241248     * @access public
    242      * @since BuddyPress (2.1.0)
     249     * @since 2.1.0
    243250     *
    244251     * @param int $user_id ID of the user being checked for edit ability.
     
    269276     * Get admin notice when saving a user or member profile.
    270277     *
    271      * @since BuddyPress (2.1.0)
     278     * @since 2.1.0
    272279     *
    273280     * @return array
     
    357364     *
    358365     * @access public
    359      * @since BuddyPress (2.1.0)
     366     * @since 2.1.0
    360367     *
    361368     * @uses add_submenu_page() To add the Edit Profile page in Profile section.
     
    396403     *
    397404     * @access public
    398      * @since BuddyPress (2.0.0)
     405     * @since 2.0.0
    399406     *
    400407     * @uses add_submenu_page() To add the Edit Profile page in Users/Profile section.
     
    471478     *
    472479     * @access public
    473      * @since BuddyPress (2.1.0)
     480     * @since 2.1.0
    474481     */
    475482    public function profile_admin_head() {
     
    531538     *
    532539     * @access public
    533      * @since BuddyPress (2.0.0)
     540     * @since 2.0.0
    534541     */
    535542    public function admin_head() {
     
    544551     *
    545552     * @access public
    546      * @since BuddyPress (2.0.0)
     553     * @since 2.0.0
    547554     */
    548555    public function enqueue_scripts() {
     
    557564         * Filters the CSS URL to enqueue in the Members admin area.
    558565         *
    559          * @since BuddyPress (2.0.0)
     566         * @since 2.0.0
    560567         *
    561568         * @param string $css URL to the CSS admin file to load.
     
    577584             * Filters the JS URL to enqueue in the Members admin area.
    578585             *
    579              * @since BuddyPress (2.0.0)
     586             * @since 2.0.0
    580587             *
    581588             * @param string $js URL to the JavaScript admin file to load.
     
    588595         * Fires after all of the members JavaScript and CSS are enqueued.
    589596         *
    590          * @since BuddyPress (2.0.0)
     597         * @since 2.0.0
    591598         *
    592599         * @param string $id        ID of the current screen.
     
    600607     *
    601608     * @access public
    602      * @since BuddyPress (2.0.0)
     609     * @since 2.0.0
    603610     *
    604611     * @param object|null $user   User to create profile navigation for.
     
    664671     *
    665672     * @access public
    666      * @since BuddyPress (2.0.0)
     673     * @since 2.0.0
    667674     */
    668675    public function user_admin_load() {
     
    691698         * Fires at the start of the signups admin load.
    692699         *
    693          * @since BuddyPress (2.0.0)
     700         * @since 2.0.0
    694701         *
    695702         * @param string $doaction Current bulk action being processed.
     
    701708         * Filters the allowed actions for use in the user admin page.
    702709         *
    703          * @since BuddyPress (2.0.0)
     710         * @since 2.0.0
    704711         *
    705712         * @param array $value Array of allowed actions to use.
     
    746753             * Plugins should not use this hook, please use 'bp_members_admin_user_metaboxes' instead.
    747754             *
    748              * @since BuddyPress (2.0.0)
     755             * @since 2.0.0
    749756             *
    750757             * @param int    $user_id       Current user ID for the screen.
     
    792799             * by setting it to true.
    793800             *
    794              * @since BuddyPress (2.0.0)
     801             * @since 2.0.0
    795802             *
    796803             * @param bool $is_self_profile Whether or not it is the current user's profile.
     
    823830             * Fires at end of user profile admin load if doaction does not match any available actions.
    824831             *
    825              * @since BuddyPress (2.0.0)
     832             * @since 2.0.0
    826833             *
    827834             * @param string $doaction Current bulk action being processed.
     
    840847     *
    841848     * @access public
    842      * @since BuddyPress (2.0.0)
     849     * @since 2.0.0
    843850     */
    844851    public function user_admin() {
     
    950957     *
    951958     * @access public
    952      * @since BuddyPress (2.0.0)
     959     * @since 2.0.0
    953960     *
    954961     * @param WP_User $user The WP_User object to be edited.
     
    10271034     *
    10281035     * @access public
    1029      * @since BuddyPress (2.0.0)
     1036     * @since 2.0.0
    10301037     *
    10311038     * @param WP_User $user The WP_User object to be edited.
     
    10411048     *
    10421049     * @access public
    1043      * @since BuddyPress (2.0.0)
     1050     * @since 2.0.0
    10441051     *
    10451052     * @param WP_User $user The WP_User object to be edited.
     
    10741081                 * Fires in the user stats metabox if the user has activated their account.
    10751082                 *
    1076                  * @since BuddyPress (2.0.0)
     1083                 * @since 2.0.0
    10771084                 *
    10781085                 * @param array  $value Array holding the user ID.
     
    10901097     * Render the Member Type metabox.
    10911098     *
    1092      * @since BuddyPress (2.2.0)
     1099     * @since 2.2.0
    10931100     * @access public
    10941101     *
     
    11211128     * Process changes from the Member Type metabox.
    11221129     *
    1123      * @since BuddyPress (2.2.0)
     1130     * @since 2.2.0
    11241131     * @access public
    11251132     */
     
    11571164     *
    11581165     * @access public
    1159      * @since BuddyPress (2.0.0)
     1166     * @since 2.0.0
    11601167     *
    11611168     * @param array|string $actions WordPress row actions (edit, delete).
     
    12171224     *
    12181225     * @access public
    1219      * @since BuddyPress (2.1.0)
     1226     * @since 2.1.0
    12201227     */
    12211228    public function add_edit_profile_url_filter() {
     
    12271234     *
    12281235     * @access public
    1229      * @since BuddyPress (2.1.0)
     1236     * @since 2.1.0
    12301237     *
    12311238     * @uses  user_admin_url()
     
    12481255     *
    12491256     * @access public
    1250      * @since BuddyPress (2.1.0)
     1257     * @since 2.1.0
    12511258     */
    12521259    public function remove_edit_profile_url_filter() {
     
    12601267     *
    12611268     * @access public
    1262      * @since BuddyPress (2.0.0)
     1269     * @since 2.0.0
    12631270     *
    12641271     * @param int    $value
     
    12881295     * before the 2.0.0 upgrade.
    12891296     *
    1290      * @since BuddyPress (2.0.0)
     1297     * @since 2.0.0
    12911298     *
    12921299     * @param WP_User_Query $query The users query.
     
    13311338     * Filter the WP Users List Table views to include 'bp-signups'.
    13321339     *
    1333      * @since BuddyPress (2.0.0)
     1340     * @since 2.0.0
    13341341     *
    13351342     * @param array $views WP List Table views.
     
    13591366     * Load the Signup WP Users List table.
    13601367     *
    1361      * @since BuddyPress (2.0.0)
     1368     * @since 2.0.0
    13621369     *
    13631370     * @param string $class    The name of the class to use.
     
    13861393     * help, and setting up screen options.
    13871394     *
    1388      * @since BuddyPress (2.0.0)
     1395     * @since 2.0.0
    13891396     *
    13901397     * @global $bp_members_signup_list_table
     
    14001407         * Fires at the start of the signups admin load.
    14011408         *
    1402          * @since BuddyPress (2.0.0)
     1409         * @since 2.0.0
    14031410         *
    14041411         * @param string $doaction Current bulk action being processed.
     
    14101417         * Filters the allowed actions for use in the user signups admin page.
    14111418         *
    1412          * @since BuddyPress (2.0.0)
     1419         * @since 2.0.0
    14131420         *
    14141421         * @param array $value Array of allowed actions to use.
     
    15471554                 * Fires at end of signups admin load if doaction does not match any actions.
    15481555                 *
    1549                  * @since BuddyPress (2.0.0)
     1556                 * @since 2.0.0
    15501557                 *
    15511558                 * @param string $doaction Current bulk action being processed.
     
    15631570     * Display any activation errors.
    15641571     *
    1565      * @since BuddyPress (2.0.0)
     1572     * @since 2.0.0
    15661573     */
    15671574    public function signups_display_errors() {
     
    15891596     * Get admin notice when viewing the sign-up page.
    15901597     *
    1591      * @since BuddyPress (2.1.0)
     1598     * @since 2.1.0
    15921599     *
    15931600     * @return array
     
    17451752     * Also prepare the admin notices.
    17461753     *
    1747      * @since BuddyPress (2.0.0)
     1754     * @since 2.0.0
    17481755     */
    17491756    public function signups_admin() {
     
    17951802     * This is the list of the Pending accounts (signups).
    17961803     *
    1797      * @since BuddyPress (2.0.0)
     1804     * @since 2.0.0
    17981805     *
    17991806     * @global $plugin_page
     
    18791886     * This is the confirmation screen for actions.
    18801887     *
    1881      * @since BuddyPress (2.0.0)
     1888     * @since 2.0.0
    18821889     *
    18831890     * @param string $action Delete, activate, or resend activation link.
  • trunk/src/bp-members/bp-members-adminbar.php

    r9877 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Members Toolbar.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Add the "My Account" menu and all submenus.
    1716 *
    18  * @since BuddyPress (1.6.0)
     17 * @since 1.6.0
    1918 *
    2019 * @todo Deprecate WP 3.2 Toolbar compatibility when we drop 3.2 support
     
    7271 * Add the User Admin top-level menu to user pages.
    7372 *
    74  * @since BuddyPress (1.5.0)
     73 * @since 1.5.0
    7574 */
    7675function bp_members_admin_bar_user_admin_menu() {
     
    143142 * Build the "Notifications" dropdown.
    144143 *
    145  * @since BuddyPress (1.5.0)
     144 * @since 1.5.0
    146145 */
    147146function bp_members_admin_bar_notifications_menu() {
     
    159158 * Remove rogue WP core Edit menu when viewing a single user.
    160159 *
    161  * @since BuddyPress (1.6.0)
     160 * @since 1.6.0
    162161 */
    163162function bp_members_remove_edit_page_menu() {
  • trunk/src/bp-members/bp-members-cache.php

    r9819 r10149  
    11<?php
    2 
    32/**
    43 * Caching functions specific to BuddyPress Members.
    54 *
    6  * @since BuddyPress (2.2.0)
     5 * @since 2.2.0
     6 *
     7 * @package BuddyPress
     8 * @subpackage MembersCache
    79 */
     10
     11// Exit if accessed directly.
     12defined( 'ABSPATH' ) || exit;
    813
    914/**
    1015 * Pre-fetch member type data when initializing a Members loop.
    1116 *
    12  * @since BuddyPress (2.2.0)
     17 * @since 2.2.0
    1318 *
    1419 * @param BP_User_Query $bp_user_query BP_User_Query object.
  • trunk/src/bp-members/bp-members-classes.php

    r9877 r10149  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
  • trunk/src/bp-members/bp-members-filters.php

    r9936 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Members Filters.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    3029 * safety of your network.
    3130 *
    32  * @since BuddyPress (1.5.0)
     31 * @since 1.5.0
    3332 */
    3433function bp_members_signup_sanitization() {
     
    6564 * is not the same than the blog slug for this particular config.
    6665 *
    67  * @since BuddyPress (2.1.0)
     66 * @since 2.1.0
    6867 *
    6968 * @param array $illegal_names
     
    9998 * Filter the user profile URL to point to BuddyPress profile edit.
    10099 *
    101  * @since BuddyPress (1.6.0)
     100 * @since 1.6.0
    102101 *
    103102 * @param string $url     WP profile edit URL.
     
    121120     * Filters the user profile URL to point to BuddyPress profile edit.
    122121     *
    123      * @since BuddyPress (1.5.2)
     122     * @since 1.5.2
    124123     *
    125124     * @param string $url WP profile edit URL.
  • trunk/src/bp-members/bp-members-functions.php

    r10022 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Functions.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Check for the existence of a Members directory page.
    1716 *
    18  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1918 *
    2019 * @return bool True if found, otherwise false.
     
    148147     * Filters the results of the user query.
    149148     *
    150      * @since BuddyPress (1.2.0)
     149     * @since 1.2.0
    151150     *
    152151     * @param array $retval Array of users for the current query.
     
    187186     * Filters the domain for the passed user.
    188187     *
    189      * @since BuddyPress (1.0.1)
     188     * @since 1.0.1
    190189     *
    191190     * @param string $domain        Domain for the passed user.
     
    217216     * Filters the userdata for a passed user.
    218217     *
    219      * @since BuddyPress (1.2.0)
     218     * @since 1.2.0
    220219     *
    221220     * @param array $userdata Array of user data for a passed user.
     
    242241 * Return the user ID based on a user's user_login.
    243242 *
    244  * @since BuddyPress (1.0.0)
     243 * @since 1.0.0
    245244 *
    246245 * @param string $username user_login to check.
     
    258257     * Filters the ID of a user, based on user_login.
    259258     *
    260      * @since BuddyPress (1.0.1)
     259     * @since 1.0.1
    261260     *
    262261     * @param int|null $value    ID of the user or null.
     
    269268 * Return the user ID based on a user's user_nicename.
    270269 *
    271  * @since BuddyPress (1.2.3)
     270 * @since 1.2.3
    272271 *
    273272 * @param string $user_nicename user_nicename to check.
     
    285284     * Filters the user ID based on user_nicename.
    286285     *
    287      * @since BuddyPress (1.2.3)
     286     * @since 1.2.3
    288287     *
    289288     * @param int|null $value         ID of the user or null.
     
    368367     * Filters the username based on originally provided user ID.
    369368     *
    370      * @since BuddyPress (1.0.1)
     369     * @since 1.0.1
    371370     *
    372371     * @param string $username Username determined by user ID.
     
    381380 * sanitized and unique slug to a user is needed.
    382381 *
    383  * @since BuddyPress (1.5.0)
     382 * @since 1.5.0
    384383 *
    385384 * @todo Refactor to use a WP core function, if possible.
     
    433432     * Filters the user_nicename based on originally provided user ID.
    434433     *
    435      * @since BuddyPress (1.5.0)
     434     * @since 1.5.0
    436435     *
    437436     * @param string $username User nice name determined by user ID.
     
    468467     * Filters the user email for user based on user ID.
    469468     *
    470      * @since BuddyPress (1.0.1)
     469     * @since 1.0.1
    471470     *
    472471     * @param string $email Email determined for the user.
     
    513512     * Filters the link text for the passed in user.
    514513     *
    515      * @since BuddyPress (1.2.0)
     514     * @since 1.2.0
    516515     *
    517516     * @param string $value   Link text based on passed parameters.
     
    527526 * display_name, and then user_nicename.
    528527 *
    529  * @since BuddyPress (2.0.0)
     528 * @since 2.0.0
    530529 *
    531530 * @param array $user_ids
     
    640639     * Filters the display name for the passed in user.
    641640     *
    642      * @since BuddyPress (1.0.1)
     641     * @since 1.0.1
    643642     *
    644643     * @param string $fullname Display name for the user.
     
    665664     * Filters the user link for the user based on user email address.
    666665     *
    667      * @since BuddyPress (1.0.1)
     666     * @since 1.0.1
    668667     *
    669668     * @param string|bool $value URL for the user if found, otherwise false.
     
    691690     * Filters the user link for the user based on username.
    692691     *
    693      * @since BuddyPress (1.0.1)
     692     * @since 1.0.1
    694693     *
    695694     * @param string|bool $value URL for the user if found, otherwise false.
     
    721720     * Filters the total number of members for the installation.
    722721     *
    723      * @since BuddyPress (1.2.0)
     722     * @since 1.2.0
    724723     *
    725724     * @param int $count Total number of members.
     
    757756     * Filters the total number of members for the installation limited to those with last_activity.
    758757     *
    759      * @since BuddyPress (1.6.0)
     758     * @since 1.6.0
    760759     *
    761760     * @param int $count Total number of active members.
     
    773772 * - bp_core_mark_user_ham_admin()        (from wp-admin)
    774773 *
    775  * @since BuddyPress (1.6.0)
     774 * @since 1.6.0
    776775 *
    777776 * @param int    $user_id       The ID of the user being spammed/hammed.
     
    845844             * Fires at end of processing spammer in Dashboard if not multisite and user is spam.
    846845             *
    847              * @since BuddyPress (1.5.0)
     846             * @since 1.5.0
    848847             *
    849848             * @param int $value user ID.
     
    855854             * Fires at end of processing spammer in Dashboard if not multisite and user is not spam.
    856855             *
    857              * @since BuddyPress (1.5.0)
     856             * @since 1.5.0
    858857             *
    859858             * @param int $value user ID.
     
    874873         * Fires at the end of the process spammer process if the user is spam.
    875874         *
    876          * @since BuddyPress (1.5.0)
     875         * @since 1.5.0
    877876         *
    878877         * @param int $value Displayed user ID.
     
    884883         * Fires at the end of the process spammer process if the user is not spam.
    885884         *
    886          * @since BuddyPress (1.5.0)
     885         * @since 1.5.0
    887886         *
    888887         * @param int $value Displayed user ID.
     
    894893     * Fires at the end of the process for hanlding spammer status.
    895894     *
    896      * @since BuddyPress (1.5.5)
     895     * @since 1.5.5
    897896     *
    898897     * @param int  $user_id ID of the processed user.
     
    910909 * Hook to WP's make_spam_user and run our custom BP spam functions.
    911910 *
    912  * @since BuddyPress (1.6.0)
     911 * @since 1.6.0
    913912 *
    914913 * @param int $user_id The user ID passed from the make_spam_user hook.
     
    922921 * Hook to WP's make_ham_user and run our custom BP spam functions.
    923922 *
    924  * @since BuddyPress (1.6.0)
     923 * @since 1.6.0
    925924 *
    926925 * @param int $user_id The user ID passed from the make_ham_user hook.
     
    989988     * Filters whether a user is marked as a spammer.
    990989     *
    991      * @since BuddyPress (1.6.0)
     990     * @since 1.6.0
    992991     *
    993992     * @param bool $is_spammer Whether or not user is marked as spammer.
     
    10541053     * Filters whether a user is marked as deleted.
    10551054     *
    1056      * @since BuddyPress (1.6.0)
     1055     * @since 1.6.0
    10571056     *
    10581057     * @param bool $is_deleted Whether or not user is marked as deleted.
     
    10641063 * Check whether a user is "active", ie neither deleted nor spammer.
    10651064 *
    1066  * @since BuddyPress (1.6.0)
     1065 * @since 1.6.0
    10671066 *
    10681067 * @uses is_user_logged_in() To check if user is logged in
     
    11041103 * Check whether user is not active.
    11051104 *
    1106  * @since BuddyPress (1.6.0)
     1105 * @since 1.6.0
    11071106 *
    11081107 * @todo No need for the user fallback checks, since they're done in
     
    11361135 * Update a user's last activity.
    11371136 *
    1138  * @since BuddyPress (1.9.0)
     1137 * @since 1.9.0
    11391138 *
    11401139 * @param int    $user_id ID of the user being updated.
     
    11801179 * the data from the proper location.
    11811180 *
    1182  * @since BuddyPress (2.0.0)
     1181 * @since 2.0.0
    11831182 *
    11841183 * @access private For internal use only.
     
    12151214 * the data in the proper location.
    12161215 *
    1217  * @since BuddyPress (2.0.0)
     1216 * @since 2.0.0
    12181217 *
    12191218 * @access private For internal use only.
     
    12511250     * Filters the last activity for a given user.
    12521251     *
    1253      * @since BuddyPress (1.9.0)
     1252     * @since 1.9.0
    12541253     *
    12551254     * @param string $activity Time of last activity, in 'Y-m-d H:i:s' format or
     
    12661265 * be called directly from the BuddyPress Tools panel.
    12671266 *
    1268  * @since BuddyPress (2.0.0)
     1267 * @since 2.0.0
    12691268 */
    12701269function bp_last_activity_migrate() {
     
    13471346     * Fires before the processing of an account deletion.
    13481347     *
    1349      * @since BuddyPress (1.6.0)
     1348     * @since 1.6.0
    13501349     *
    13511350     * @param int $user_id ID of the user account being deleted.
     
    13691368     * Fires after the deletion of an account.
    13701369     *
    1371      * @since BuddyPress (1.6.0)
     1370     * @since 1.6.0
    13721371     *
    13731372     * @param int $user_id ID of the user account that was deleted.
     
    13811380 * Delete a user's avatar when the user is deleted.
    13821381 *
    1383  * @since BuddyPress (1.9.0)
     1382 * @since 1.9.0
    13841383 *
    13851384 * @param int $user_id ID of the user who is about to be deleted.
     
    14201419 * then simply redirect them to the home page and stop them from logging in.
    14211420 *
    1422  * @since BuddyPress (1.1.2)
     1421 * @since 1.1.2
    14231422 *
    14241423 * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error
     
    15561555     * Filters the array of default illegal usernames.
    15571556     *
    1558      * @since BuddyPress (1.2.2)
     1557     * @since 1.2.2
    15591558     *
    15601559     * @param array $value Merged and unique array of illegal usernames.
     
    15711570     * Filters the array of default illegal names.
    15721571     *
    1573      * @since BuddyPress (1.2.5)
     1572     * @since 1.2.5
    15741573     *
    15751574     * @param array $value Merged and unique array of illegal names.
     
    15881587 *   - If there's an email domain whitelest, is the current domain on it?
    15891588 *
    1590  * @since BuddyPress (1.6.2)
     1589 * @since 1.6.2
    15911590 *
    15921591 * @param string $user_email The email being checked.
     
    16381637 * parses, adding the appropriate error messages to the WP_Error object.
    16391638 *
    1640  * @since BuddyPress (1.7.0)
     1639 * @since 1.7.0
    16411640 *
    16421641 * @see bp_core_validate_email_address()
     
    16911690         * Filters the username before being validated.
    16921691         *
    1693          * @since BuddyPress (1.5.5)
     1692         * @since 1.5.5
    16941693         *
    16951694         * @param string $user_name Username to validate.
     
    17611760     * Filters the result of the user signup validation.
    17621761     *
    1763      * @since BuddyPress (1.2.2)
     1762     * @since 1.2.2
    17641763     *
    17651764     * @param array $result Results of user validation including errors, if any.
     
    17861785     * Filters the validated blog url and title provided at signup.
    17871786     *
    1788      * @since BuddyPress (1.2.2)
     1787     * @since 1.2.2
    17891788     *
    17901789     * @param array $value Array with the new site data and error messages.
     
    18581857         * Filters if BuddyPress should send an activation key for a new signup.
    18591858         *
    1860          * @since BuddyPress (1.2.3)
     1859         * @since 1.2.3
    18611860         *
    18621861         * @param bool   $value          Whether or not to send the activation key.
     
    18771876     * Fires at the end of the process to sign up a user.
    18781877     *
    1879      * @since BuddyPress (1.2.2)
     1878     * @since 1.2.2
    18801879     *
    18811880     * @param bool|WP_Error   $user_id       True on success, WP_Error on failure.
     
    19141913     * backwards compatibility.
    19151914     *
    1916      * @since BuddyPress (1.2.2)
     1915     * @since 1.2.2
    19171916     *
    19181917     * @param void $value
     
    20242023             * Fires if the user has already been created.
    20252024             *
    2026              * @since BuddyPress (1.2.2)
     2025             * @since 1.2.2
    20272026             *
    20282027             * @param int    $user_id ID of the user being checked.
     
    20682067     * Fires at the end of the user activation process.
    20692068     *
    2070      * @since BuddyPress (1.2.2)
     2069     * @since 1.2.2
    20712070     *
    20722071     * @param int    $user_id ID of the user being checked.
     
    20822081 * Migrate signups from pre-2.0 configuration to wp_signups.
    20832082 *
    2084  * @since BuddyPress (2.0.1)
     2083 * @since 2.0.1
    20852084 */
    20862085function bp_members_migrate_signups() {
     
    22142213     * Filters the avatar storage directory for use during registration.
    22152214     *
    2216      * @since BuddyPress (1.1.1)
     2215     * @since 1.1.1
    22172216     *
    22182217     * @param array $value Array of path and URL values for created storage directory.
     
    22452244     * Filters the user email that the validation email will be sent to.
    22462245     *
    2247      * @since BuddyPress (1.5.0)
     2246     * @since 1.5.0
    22482247     *
    22492248     * @param string $user_email User email the notification is being sent to.
     
    22552254     * Filters the validation email subject that will be sent to user.
    22562255     *
    2257      * @since BuddyPress (1.5.0)
     2256     * @since 1.5.0
    22582257     *
    22592258     * @param string $subject Email validation subject text.
     
    22652264     * Filters the validation email message that will be sent to user.
    22662265     *
    2267      * @since BuddyPress (1.5.0)
     2266     * @since 1.5.0
    22682267     *
    22692268     * @param string $message      Email validation message text.
     
    22782277     * Fires after the sending of activation email to a newly registered user.
    22792278     *
    2280      * @since BuddyPress (1.5.0)
     2279     * @since 1.5.0
    22812280     *
    22822281     * @param string $subject    Subject for the sent email.
     
    22922291 * Display a "resend email" link when an unregistered user attempts to log in.
    22932292 *
    2294  * @since BuddyPress (1.2.2)
     2293 * @since 1.2.2
    22952294 *
    22962295 * @param WP_User|WP_Error $user     Either the WP_User or the WP_Error object.
     
    23532352 * On the login screen, resends the activation email for a user.
    23542353 *
    2355  * @since BuddyPress (2.0.0)
     2354 * @since 2.0.0
    23562355 *
    23572356 * @see bp_core_signup_disable_inactive()
     
    24242423 * This is important as the $bp->loggedin_user object is setup at priority 4.
    24252424 *
    2426  * @since BuddyPress (1.8.0)
     2425 * @since 1.8.0
    24272426 */
    24282427function bp_stop_live_spammer() {
     
    24582457         * Filters the url used for redirection for a logged in user marked as spam.
    24592458         *
    2460          * @since BuddyPress (1.8.0)
     2459         * @since 1.8.0
    24612460         *
    24622461         * @param string $value URL to redirect user to.
     
    24742473 * Show a custom error message when a logged-in user is marked as a spammer.
    24752474 *
    2476  * @since BuddyPress (1.8.0)
     2475 * @since 1.8.0
    24772476 */
    24782477function bp_live_spammer_login_error() {
     
    24912490 * Register a member type.
    24922491 *
    2493  * @since BuddyPress (2.2.0)
     2492 * @since 2.2.0
    24942493 *
    24952494 * @param string $member_type Unique string identifier for the member type.
     
    25312530     * - '_none' is used internally to denote an item that should not apply to any member types.
    25322531     *
    2533      * @since BuddyPress (2.4.0)
     2532     * @since 2.4.0
    25342533     *
    25352534     * @param array $illegal_names Array of illegal names.
     
    25722571     * Fires after a member type is registered.
    25732572     *
    2574      * @since BuddyPress (2.2.0)
     2573     * @since 2.2.0
    25752574     *
    25762575     * @param string $member_type Member type identifier.
     
    25852584 * Retrieve a member type object by name.
    25862585 *
    2587  * @since BuddyPress (2.2.0)
     2586 * @since 2.2.0
    25882587 *
    25892588 * @param string $member_type The name of the member type.
     
    26042603 * Get a list of all registered member type objects.
    26052604 *
    2606  * @since BuddyPress (2.2.0)
     2605 * @since 2.2.0
    26072606 *
    26082607 * @see bp_register_member_type() for accepted arguments.
     
    26292628     * filtering functions have access to the entire member type objects.
    26302629     *
    2631      * @since BuddyPress (2.2.0)
     2630     * @since 2.2.0
    26322631     *
    26332632     * @param array  $types     Member type objects, keyed by name.
     
    26472646 * Set type for a member.
    26482647 *
    2649  * @since BuddyPress (2.2.0)
     2648 * @since 2.2.0
    26502649 *
    26512650 * @param int    $user_id     ID of the user.
     
    26702669         * Fires just after a user's member type has been changed.
    26712670         *
    2672          * @since BuddyPress (2.2.0)
     2671         * @since 2.2.0
    26732672         *
    26742673         * @param int    $user_id     ID of the user whose member type has been updated.
     
    26852684 * Remove type for a member.
    26862685 *
    2687  * @since BuddyPress (2.3.0)
     2686 * @since 2.3.0
    26882687 *
    26892688 * @param int    $user_id     ID of the user.
     
    27072706         * Fires just after a user's member type has been removed.
    27082707         *
    2709          * @since BuddyPress (2.3.0)
     2708         * @since 2.3.0
    27102709         *
    27112710         * @param int    $user_id     ID of the user whose member type has been updated.
     
    27212720 * Get type for a member.
    27222721 *
    2723  * @since BuddyPress (2.2.0)
     2722 * @since 2.2.0
    27242723 *
    27252724 * @param int               $user_id ID of the user.
     
    27542753     * Filters a user's member type(s).
    27552754     *
    2756      * @since BuddyPress (2.2.0)
     2755     * @since 2.2.0
    27572756     *
    27582757     * @param string $type    Member type.
     
    27662765 * Check whether the given user has a certain member type.
    27672766 *
    2768  * @since BuddyPress (2.3.0)
     2767 * @since 2.3.0
    27692768 *
    27702769 * @param int    $user_id     $user_id ID of the user.
     
    27922791 * Delete a user's member type when the user when the user is deleted.
    27932792 *
    2794  * @since BuddyPress (2.2.0)
     2793 * @since 2.2.0
    27952794 *
    27962795 * @param int $user_id ID of the user.
     
    28072806 * Get the "current" member type, if one is provided, in member directories.
    28082807 *
    2809  * @since BuddyPress (2.3.0)
     2808 * @since 2.3.0
    28102809 *
    28112810 * @return string
  • trunk/src/bp-members/bp-members-loader.php

    r10110 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Loader.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1918     *
    2019     * @access public
    21      * @since  BuddyPress (2.2.0)
     20     * @since  2.2.0
    2221     * @var    array
    2322     */
     
    2726     * Start the members component creation process.
    2827     *
    29      * @since BuddyPress (1.5.0)
     28     * @since 1.5.0
    3029     */
    3130    public function __construct() {
     
    8180     * backwards compatibility.
    8281     *
    83      * @since BuddyPress (1.5.0)
     82     * @since 1.5.0
    8483     *
    8584     * @see BP_Component::setup_globals() for description of parameters.
     
    153152     * Set up canonical stack for this component.
    154153     *
    155      * @since BuddyPress (2.1.0)
     154     * @since 2.1.0
    156155     */
    157156    public function setup_canonical_stack() {
     
    211210     * Set up fall-back component navigation if XProfile is inactive.
    212211     *
    213      * @since BuddyPress (1.5.0)
     212     * @since 1.5.0
    214213     *
    215214     * @see BP_Component::setup_nav() for a description of arguments.
     
    290289     * Setup cache groups.
    291290     *
    292      * @since BuddyPress (2.2.0)
     291     * @since 2.2.0
    293292     */
    294293    public function setup_cache_groups() {
  • trunk/src/bp-members/bp-members-screens.php

    r9877 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Screens.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    2120     * Fires right before the loading of the Member profile screen template file.
    2221     *
    23      * @since BuddyPress (1.5.0)
     22     * @since 1.5.0
    2423     */
    2524    do_action( 'bp_members_screen_display_profile' );
     
    2827     * Filters the template to load for the Member profile page screen.
    2928     *
    30      * @since BuddyPress (1.5.0)
     29     * @since 1.5.0
    3130     *
    3231     * @param string $template Path to the Member template to load.
     
    4544         * Fires right before the loading of the Member directory index screen template file.
    4645         *
    47          * @since BuddyPress (1.5.0)
     46         * @since 1.5.0
    4847         */
    4948        do_action( 'bp_members_screen_index' );
     
    5251         * Filters the template to load for the Member directory page screen.
    5352         *
    54          * @since BuddyPress (1.5.0)
     53         * @since 1.5.0
    5554         *
    5655         * @param string $value Path to the member directory template to load.
     
    8382         * Filters the URL to redirect logged in users to when visiting registration page.
    8483         *
    85          * @since BuddyPress (1.5.1)
     84         * @since 1.5.1
    8685         *
    8786         * @param string $redirect_to URL to redirect user to.
     
    103102         * Fires before the validation of a new signup.
    104103         *
    105          * @since BuddyPress (2.0.0)
     104         * @since 2.0.0
    106105         */
    107106        do_action( 'bp_signup_pre_validate' );
     
    174173         * Fires after the validation of a new signup.
    175174         *
    176          * @since BuddyPress (1.1.0)
     175         * @since 1.1.0
    177176         */
    178177        do_action( 'bp_signup_validate' );
     
    187186                 * Filters the error message in the loop.
    188187                 *
    189                  * @since BuddyPress (1.5.0)
     188                 * @since 1.5.0
    190189                 *
    191190                 * @param string $value Error message wrapped in html.
     
    240239                 * Filters the user meta used for signup.
    241240                 *
    242                  * @since BuddyPress (1.1.0)
     241                 * @since 1.1.0
    243242                 *
    244243                 * @param array $usermeta Array of user meta to add to signup.
     
    263262             * Fires after the completion of a new signup.
    264263             *
    265              * @since BuddyPress (1.1.0)
     264             * @since 1.1.0
    266265             */
    267266            do_action( 'bp_complete_signup' );
     
    273272     * Fires right before the loading of the Member registration screen template file.
    274273     *
    275      * @since BuddyPress (1.5.0)
     274     * @since 1.5.0
    276275     */
    277276    do_action( 'bp_core_screen_signup' );
     
    280279     * Filters the template to load for the Member registration page screen.
    281280     *
    282      * @since BuddyPress (1.5.0)
     281     * @since 1.5.0
    283282     *
    284283     * @param string $value Path to the Member registration template to load.
     
    315314         * Filters the URL to redirect logged in users to when visiting activation page.
    316315         *
    317          * @since BuddyPress (1.9.0)
     316         * @since 1.9.0
    318317         *
    319318         * @param string $redirect_to URL to redirect user to.
     
    342341         * Filters the activation signup.
    343342         *
    344          * @since BuddyPress (1.1.0)
     343         * @since 1.1.0
    345344         *
    346345         * @param bool|int $value Value returned by activation.
     
    370369     * Filters the template to load for the Member activation page screen.
    371370     *
    372      * @since BuddyPress (1.1.1)
     371     * @since 1.1.1
    373372     *
    374373     * @param string $value Path to the Member activation template to load.
     
    386385 * member template parts to the_title and the_content areas of a theme.
    387386 *
    388  * @since BuddyPress (1.7.0)
     387 * @since 1.7.0
    389388 */
    390389class BP_Members_Theme_Compat {
     
    393392     * Set up the members component theme compatibility.
    394393     *
    395      * @since BuddyPress (1.7.0)
     394     * @since 1.7.0
    396395     */
    397396    public function __construct() {
     
    402401     * Are we looking at something that needs members theme compatibility?
    403402     *
    404      * @since BuddyPress (1.7.0)
     403     * @since 1.7.0
    405404     */
    406405    public function is_members() {
     
    418417             * Fires if looking at Members directory when needing theme compat.
    419418             *
    420              * @since BuddyPress (1.5.0)
     419             * @since 1.5.0
    421420             */
    422421            do_action( 'bp_members_screen_index' );
     
    438437             * Fires if looking at Members user page when needing theme compat.
    439438             *
    440              * @since BuddyPress (1.5.0)
     439             * @since 1.5.0
    441440             */
    442441            do_action( 'bp_members_screen_display_profile' );
     
    457456     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    458457     *
    459      * @since BuddyPress (1.8.0)
     458     * @since 1.8.0
    460459     *
    461460     * @param array $templates The templates from bp_get_theme_compat_templates().
     
    468467         * Filters the template hierarchy for theme compat and members directory page.
    469468         *
    470          * @since BuddyPress (1.8.0)
     469         * @since 1.8.0
    471470         *
    472471         * @param array $value Array of template paths to add to hierarchy.
     
    486485     * Update the global $post with directory data.
    487486     *
    488      * @since BuddyPress (1.7.0)
     487     * @since 1.7.0
    489488     */
    490489    public function directory_dummy_post() {
     
    505504     * Filter the_content with the members index template part.
    506505     *
    507      * @since BuddyPress (1.7.0)
     506     * @since 1.7.0
    508507     */
    509508    public function directory_content() {
     
    519518     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    520519     *
    521      * @since BuddyPress (1.8.0)
     520     * @since 1.8.0
    522521     *
    523522     * @param string $templates The templates from
     
    533532         * Filters the template hierarchy for theme compat and member pages.
    534533         *
    535          * @since BuddyPress (1.8.0)
     534         * @since 1.8.0
    536535         *
    537536         * @param array $value Array of template paths to add to hierarchy.
     
    555554     * Update the global $post with the displayed user's data.
    556555     *
    557      * @since BuddyPress (1.7.0)
     556     * @since 1.7.0
    558557     */
    559558    public function single_dummy_post() {
     
    574573     * Filter the_content with the members' single home template part.
    575574     *
    576      * @since BuddyPress (1.7.0)
     575     * @since 1.7.0
    577576     */
    578577    public function single_dummy_content() {
     
    588587 * registration template parts to the_title and the_content areas of a theme.
    589588 *
    590  * @since BuddyPress (1.7.0)
     589 * @since 1.7.0
    591590 */
    592591class BP_Registration_Theme_Compat {
     
    595594     * Setup the groups component theme compatibility.
    596595     *
    597      * @since BuddyPress (1.7.0)
     596     * @since 1.7.0
    598597     */
    599598    public function __construct() {
     
    604603     * Are we looking at either the registration or activation pages?
    605604     *
    606      * @since BuddyPress (1.7.0)
     605     * @since 1.7.0
    607606     */
    608607    public function is_registration() {
     
    630629     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    631630     *
    632      * @since BuddyPress (1.8.0)
     631     * @since 1.8.0
    633632     *
    634633     * @param string $templates The templates from bp_get_theme_compat_templates().
     
    645644         * being used.
    646645         *
    647          * @since BuddyPress (1.8.0)
     646         * @since 1.8.0
    648647         *
    649648         * @param array $value Array of template paths to add to hierarchy.
     
    663662     * Update the global $post with dummy data.
    664663     *
    665      * @since BuddyPress (1.7.0)
     664     * @since 1.7.0
    666665     */
    667666    public function dummy_post() {
     
    699698     * Filter the_content with either the register or activate templates.
    700699     *
    701      * @since BuddyPress (1.7.0)
     700     * @since 1.7.0
    702701     */
    703702    public function dummy_content() {
  • trunk/src/bp-members/bp-members-template.php

    r10126 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Template Tags.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Output the profile component slug.
    1716 *
    18  * @since BuddyPress (2.4.0)
     17 * @since 2.4.0
    1918 *
    2019 * @uses bp_get_profile_slug()
     
    2625     * Return the profile component slug.
    2726     *
    28      * @since BuddyPress (2.4.0)
     27     * @since 2.4.0
    2928     *
    3029     * @return string
     
    3534         * Filters the profile component slug.
    3635         *
    37          * @since BuddyPress (2.4.0)
     36         * @since 2.4.0
    3837         *
    3938         * @param string $slug Profile component slug.
     
    4544 * Output the members component slug.
    4645 *
    47  * @since BuddyPress (1.5.0)
     46 * @since 1.5.0
    4847 *
    4948 * @uses bp_get_members_slug()
     
    5554     * Return the members component slug.
    5655     *
    57      * @since BuddyPress (1.5.0)
     56     * @since 1.5.0
    5857     *
    5958     * @return string
     
    6463         * Filters the Members component slug.
    6564         *
    66          * @since BuddyPress (1.5.0)
     65         * @since 1.5.0
    6766         *
    6867         * @param string $slug Members component slug.
     
    7473 * Output the members component root slug.
    7574 *
    76  * @since BuddyPress (1.5.0)
     75 * @since 1.5.0
    7776 *
    7877 * @uses bp_get_members_root_slug()
     
    8483     * Return the members component root slug.
    8584     *
    86      * @since BuddyPress (1.5.0)
     85     * @since 1.5.0
    8786     *
    8887     * @return string
     
    9392         * Filters the Members component root slug.
    9493         *
    95          * @since BuddyPress (1.5.0)
     94         * @since 1.5.0
    9695         *
    9796         * @param string $slug Members component root slug.
     
    103102 * Output member directory permalink.
    104103 *
    105  * @since BuddyPress (1.5.0)
     104 * @since 1.5.0
    106105 *
    107106 * @uses bp_get_members_directory_permalink()
     
    113112     * Return member directory permalink.
    114113     *
    115      * @since BuddyPress (1.5.0)
     114     * @since 1.5.0
    116115     *
    117116     * @return string
     
    122121         * Filters the member directory permalink.
    123122         *
    124          * @since BuddyPress (1.5.0)
     123         * @since 1.5.0
    125124         *
    126125         * @param string $value Members directory permalink.
     
    132131 * Output the sign-up slug.
    133132 *
    134  * @since BuddyPress (1.5.0)
     133 * @since 1.5.0
    135134 *
    136135 * @uses bp_get_signup_slug()
     
    142141     * Return the sign-up slug.
    143142     *
    144      * @since BuddyPress (1.5.0)
     143     * @since 1.5.0
    145144     *
    146145     * @return string
     
    160159         * Filters the sign-up slug.
    161160         *
    162          * @since BuddyPress (1.5.0)
     161         * @since 1.5.0
    163162         *
    164163         * @param string $slug Sign-up slug.
     
    170169 * Output the activation slug.
    171170 *
    172  * @since BuddyPress (1.5.0)
     171 * @since 1.5.0
    173172 *
    174173 * @uses bp_get_activate_slug()
     
    180179     * Return the activation slug.
    181180     *
    182      * @since BuddyPress (1.5.0)
     181     * @since 1.5.0
    183182     *
    184183     * @return string
     
    198197         * Filters the activation slug.
    199198         *
    200          * @since BuddyPress (1.5.0)
     199         * @since 1.5.0
    201200         *
    202201         * @param string $slug Activation slug.
     
    442441             * Fires right before the rewinding of members listing.
    443442             *
    444              * @since BuddyPress (1.5.0)
     443             * @since 1.5.0
    445444             */
    446445            do_action('member_loop_end');
     
    473472             * Fires if the current member is the first in the loop.
    474473             *
    475              * @since BuddyPress (1.5.0)
     474             * @since 1.5.0
    476475             */
    477476            do_action( 'member_loop_start' );
     
    631630     * Filters whether or not BuddyPress has members to iterate over.
    632631     *
    633      * @since BuddyPress (1.2.4)
     632     * @since 1.2.4
    634633     *
    635634     * @param bool  $value            Whether or not there are members to iterate over.
     
    710709         * Filters the members pagination count.
    711710         *
    712          * @since BuddyPress (1.5.0)
     711         * @since 1.5.0
    713712         *
    714713         * @param string $pag Pagination count string.
     
    734733         * Filters the members pagination link.
    735734         *
    736          * @since BuddyPress (1.2.0)
     735         * @since 1.2.0
    737736         *
    738737         * @param string $pag_links HTML markup for pagination links.
     
    761760         * Filters the ID of the current member in the loop.
    762761         *
    763          * @since BuddyPress (1.2.0)
     762         * @since 1.2.0
    764763         *
    765764         * @param int $member_id ID of the member being iterated over.
     
    771770 * Output the row class of the current member in the loop.
    772771 *
    773  * @since BuddyPress (1.7.0)
     772 * @since 1.7.0
    774773 *
    775774 * @param array $classes Array of custom classes
     
    781780     * Return the row class of the current member in the loop.
    782781     *
    783      * @since BuddyPress (1.7.0)
     782     * @since 1.7.0
    784783     *
    785784     * @param array $classes Array of custom classes
     
    822821         * Filters the determined classes to add to the HTML element.
    823822         *
    824          * @since BuddyPress (1.7.0)
     823         * @since 1.7.0
    825824         *
    826825         * @param string $classes Classes to be added to the HTML element.
     
    850849         * Filters the nicename of the current member in the loop.
    851850         *
    852          * @since BuddyPress (1.2.5)
     851         * @since 1.2.5
    853852         *
    854853         * @param string $user_nicename Nicename for the current member.
     
    874873         * Filters the login of the current member in the loop.
    875874         *
    876          * @since BuddyPress (1.2.5)
     875         * @since 1.2.5
    877876         *
    878877         * @param string $user_login Login for the current member.
     
    898897         * Filters the email address of the current member in the loop.
    899898         *
    900          * @since BuddyPress (1.2.5)
     899         * @since 1.2.5
    901900         *
    902901         * @param string $user_email Email address for the current member.
     
    916915     * Filters whether the current member in the loop is the logged-in user.
    917916     *
    918      * @since BuddyPress (1.2.5)
     917     * @since 1.2.5
    919918     *
    920919     * @param bool $value Whether current member in the loop is logged in.
     
    935934     * Filters a members avatar.
    936935     *
    937      * @since BuddyPress (1.2.0)
     936     * @since 1.2.0
    938937     *
    939938     * @param string $value Formatted HTML <img> element,
     
    982981         * Filters a members avatar.
    983982         *
    984          * @since BuddyPress (1.2.0)
     983         * @since 1.2.0
    985984         *
    986985         * @param string $value Formatted HTML <img> element,
     
    10071006         * Filters the permalink for the current member in the loop.
    10081007         *
    1009          * @since BuddyPress (1.2.0)
     1008         * @since 1.2.0
    10101009         *
    10111010         * @param string $value Permalink for the current member in the loop.
     
    10321031     * Filters the display name of current member in the loop.
    10331032     *
    1034      * @since BuddyPress (1.2.0)
     1033     * @since 1.2.0
    10351034     *
    10361035     * @param string $value Display name for current member.
     
    10731072         * Filters the display name of current member in the loop.
    10741073         *
    1075          * @since BuddyPress (1.2.0)
     1074         * @since 1.2.0
    10761075         *
    10771076         * @param string $fullname Display name for current member.
     
    11331132         * Filters the current members last active time.
    11341133         *
    1135          * @since BuddyPress (1.2.0)
     1134         * @since 1.2.0
    11361135         *
    11371136         * @param string $last_activity Formatted time since last activity.
     
    11771176         * Filters the excerpt of the latest update for current member in the loop.
    11781177         *
    1179          * @since BuddyPress (1.2.5)
     1178         * @since 1.2.5
    11801179         *
    11811180         * @param string $value Excerpt of the latest update for current member in the loop.
     
    11961195         * Filters the latest update from the current member in the loop.
    11971196         *
    1198          * @since BuddyPress (1.2.0)
     1197         * @since 1.2.0
    11991198         *
    12001199         * @param string $update_content Formatted latest update for current member.
     
    12781277         * Filters resulting piece of member profile data.
    12791278         *
    1280          * @since BuddyPress (1.2.0)
     1279         * @since 1.2.0
    12811280         *
    12821281         * @param string|bool $data Profile data if found, otherwise false.
     
    13041303         * Filters the 'registered [x days ago]' string for the current member.
    13051304         *
    1306          * @since BuddyPress (2.1.0)
     1305         * @since 2.1.0
    13071306         *
    13081307         * @param string $registered The 'registered [x days ago]' string.
     
    13591358     * Filters the Members component search form.
    13601359     *
    1361      * @since BuddyPress (1.9.0)
     1360     * @since 1.9.0
    13621361     *
    13631362     * @param string $search_form_html HTML markup for the member search form.
     
    13821381         * Filters the total site member count.
    13831382         *
    1384          * @since BuddyPress (1.2.0)
     1383         * @since 1.2.0
    13851384         *
    13861385         * @param int $value Number-formatted total site member count.
     
    14711470         * This is a dynamic filter that is dependent on the navigation tab component being rendered.
    14721471         *
    1473          * @since BuddyPress (1.1.0)
     1472         * @since 1.1.0
    14741473         *
    14751474         * @param string $value         Markup for the tab list item including link.
     
    15251524         * Filters the logged in user's avatar.
    15261525         *
    1527          * @since BuddyPress (1.1.0)
     1526         * @since 1.1.0
    15281527         *
    15291528         * @param string $value User avatar string.
     
    15741573         * Filters the displayed user's avatar.
    15751574         *
    1576          * @since BuddyPress (1.1.0)
     1575         * @since 1.1.0
    15771576         *
    15781577         * @param string $value User avatar string.
     
    16041603         * Filters the email address of the displayed user.
    16051604         *
    1606          * @since BuddyPress (1.5.0)
     1605         * @since 1.5.0
    16071606         *
    16081607         * @param string $retval Email address for displayed user.
     
    16231622     * Filters the 'active [x days ago]' string for a user.
    16241623     *
    1625      * @since BuddyPress (1.0.0)
     1624     * @since 1.0.0
    16261625     *
    16271626     * @param string $value Formatted 'active [x days ago]' string.
     
    16461645         * Filters the 'active [x days ago]' string for a user.
    16471646         *
    1648          * @since BuddyPress (1.5.0)
     1647         * @since 1.5.0
    16491648         *
    16501649         * @param string $value Formatted 'active [x days ago]' string.
     
    16841683         * Filters the first name of a user.
    16851684         *
    1686          * @since BuddyPress (1.2.0)
     1685         * @since 1.2.0
    16871686         *
    16881687         * @param string $value    First name of user.
     
    17081707         * Filters the link for the logged-in user's profile.
    17091708         *
    1710          * @since BuddyPress (1.2.4)
     1709         * @since 1.2.4
    17111710         *
    17121711         * @param string $value Link for the logged-in user's profile.
     
    17311730         * Filters the link for the displayed user's profile.
    17321731         *
    1733          * @since BuddyPress (1.2.4)
     1732         * @since 1.2.4
    17341733         *
    17351734         * @param string $value Link for the displayed user's profile.
     
    17611760     * Filters the generated link for the displayed user's profile.
    17621761     *
    1763      * @since BuddyPress (1.0.0)
     1762     * @since 1.0.0
    17641763     *
    17651764     * @param string $value Generated link for the displayed user's profile.
     
    17791778     * Filters the generated link for the logged-in user's profile.
    17801779     *
    1781      * @since BuddyPress (1.0.0)
     1780     * @since 1.0.0
    17821781     *
    17831782     * @param string $value Generated link for the logged-in user's profile.
     
    18031802         * Filters the displayed user's display name.
    18041803         *
    1805          * @since BuddyPress (1.2.0)
     1804         * @since 1.2.0
    18061805         *
    18071806         * @param string $value Displayed user's display name.
     
    18331832         * Filters the logged-in user's display name.
    18341833         *
    1835          * @since BuddyPress (1.0.0)
     1834         * @since 1.0.0
    18361835         *
    18371836         * @param string $value Logged-in user's display name.
     
    18631862         * Filters the username of the displayed user.
    18641863         *
    1865          * @since BuddyPress (1.2.0)
     1864         * @since 1.2.0
    18661865         *
    18671866         * @param string $username Username of the displayed user.
     
    18931892         * Filters the username of the logged-in user.
    18941893         *
    1895          * @since BuddyPress (1.2.0)
     1894         * @since 1.2.0
    18961895         *
    18971896         * @param string $username Username of the logged-in user.
     
    19021901 * Echo the current member type message.
    19031902 *
    1904  * @since BuddyPress (2.3.0)
     1903 * @since 2.3.0
    19051904 */
    19061905function bp_current_member_type_message() {
     
    19101909     * Generate the current member type message.
    19111910     *
    1912      * @since BuddyPress (2.3.0)
     1911     * @since 2.3.0
    19131912     *
    19141913     * @return string
     
    19271926 * Do we have a working custom sign up page?
    19281927 *
    1929  * @since BuddyPress (1.5.0)
     1928 * @since 1.5.0
    19301929 *
    19311930 * @uses bp_get_signup_slug() To make sure there is a slug assigned to the page.
     
    19631962         * Filters the URL to the signup page.
    19641963         *
    1965          * @since BuddyPress (1.1.0)
     1964         * @since 1.1.0
    19661965         *
    19671966         * @param string $page URL to the signup page.
     
    19731972 * Do we have a working custom activation page?
    19741973 *
    1975  * @since BuddyPress (1.5.0)
     1974 * @since 1.5.0
    19761975 *
    19771976 * @uses bp_get_activate_slug() To make sure there is a slug assigned to the page.
     
    20092008         * Filters the URL of the activation page.
    20102009         *
    2011          * @since BuddyPress (1.2.0)
     2010         * @since 1.2.0
    20122011         *
    20132012         * @param string $page URL to the activation page.
     
    20372036         * Filters the username submitted during signup.
    20382037         *
    2039          * @since BuddyPress (1.1.0)
     2038         * @since 1.1.0
    20402039         *
    20412040         * @param string $value Username submitted during signup.
     
    20652064         * Filters the email address submitted during signup.
    20662065         *
    2067          * @since BuddyPress (1.1.0)
     2066         * @since 1.1.0
    20682067         *
    20692068         * @param string $value Email address submitted during signup.
     
    20912090         * Filters the 'signup_with_blog' value submitted during signup.
    20922091         *
    2093          * @since BuddyPress (1.1.0)
     2092         * @since 1.1.0
    20942093         *
    20952094         * @param string $value 'signup_with_blog' value submitted during signup.
     
    21192118         * Filters the 'signup_blog_url' value submitted during signup.
    21202119         *
    2121          * @since BuddyPress (1.1.0)
     2120         * @since 1.1.0
    21222121         *
    21232122         * @param string $value 'signup_blog_url' value submitted during signup.
     
    21292128 * Output the base URL for subdomain installations of WordPress Multisite.
    21302129 *
    2131  * @since BuddyPress (2.1.0)
     2130 * @since 2.1.0
    21322131 */
    21332132function bp_signup_subdomain_base() {
     
    21392138     * Replaces bp_blogs_get_subdomain_base()
    21402139     *
    2141      * @since BuddyPress (2.1.0)
     2140     * @since 2.1.0
    21422141     *
    21432142     * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com.
     
    21522151         * Filters the base URL for subdomain installations of WordPress Multisite.
    21532152         *
    2154          * @since BuddyPress (2.1.0)
     2153         * @since 2.1.0
    21552154         *
    21562155         * @param string $subdomain_base The base URL - eg, 'example.com' for
     
    21812180         * Filters the 'signup_blog_title' value submitted during signup.
    21822181         *
    2183          * @since BuddyPress (1.1.0)
     2182         * @since 1.1.0
    21842183         *
    21852184         * @param string $value 'signup_blog_title' value submitted during signup.
     
    22092208         * Filters the 'signup_blog_privacy' value submitted during signup.
    22102209         *
    2211          * @since BuddyPress (1.1.0)
     2210         * @since 1.1.0
    22122211         *
    22132212         * @param string $value 'signup_blog_privacy' value submitted during signup.
     
    22452244         * Filters the avatar dir used during signup.
    22462245         *
    2247          * @since BuddyPress (1.1.0)
     2246         * @since 1.1.0
    22482247         *
    22492248         * @param string|bool $signup_avatar_dir Avatar dir used during signup or false.
     
    23302329             * Filters the base Gravatar url used for signup avatars when no avatar dir found.
    23312330             *
    2332              * @since BuddyPress (1.0.2)
     2331             * @since 1.0.2
    23332332             *
    23342333             * @param string $value Gravatar url to use.
     
    23422341         * Filters the user avatar during signup.
    23432342         *
    2344          * @since BuddyPress (1.1.0)
     2343         * @since 1.1.0
    23452344         *
    23462345         * @param string $gravatar_img Avatar HTML image tag.
     
    23842383         * Filters whether or not new signups are allowed.
    23852384         *
    2386          * @since BuddyPress (1.5.0)
     2385         * @since 1.5.0
    23872386         *
    23882387         * @param bool $signup_allowed Whether or not new signups are allowed.
     
    23942393 * Hook member activity feed to <head>.
    23952394 *
    2396  * @since BuddyPress (1.5.0)
     2395 * @since 1.5.0
    23972396 */
    23982397function bp_members_activity_feed() {
  • trunk/src/bp-members/bp-members-widgets.php

    r10123 r10149  
    66 */
    77
    8 // Exit if accessed directly
     8// Exit if accessed directly.
    99defined( 'ABSPATH' ) || exit;
    1010
     
    1414 * Previously, these widgets were registered in bp-core.
    1515 *
    16  * @since BuddyPress (2.2.0)
     16 * @since 2.2.0
    1717 */
    1818function bp_members_register_widgets() {
     
    2626 * Members Widget.
    2727 *
    28  * @since BuddyPress (1.0.3)
     28 * @since 1.0.3
    2929 */
    3030class BP_Core_Members_Widget extends WP_Widget {
     
    6767         * Filters the title of the Members widget.
    6868         *
    69          * @since BuddyPress (1.8.0)
    70          * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     69         * @since 1.8.0
     70         * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    7171         *
    7272         * @param string $title    The widget title.
     
    8080         * Filters the separator of the member widget links.
    8181         *
    82          * @since BuddyPress (2.4.0)
     82         * @since 2.4.0
    8383         *
    8484         * @param string $separator Separator string. Default '|'.
     
    231231     * Merge the widget settings into defaults array.
    232232     *
    233      * @since BuddyPress (2.3.0)
     233     * @since 2.3.0
    234234     *
    235235     * @param array $instance Widget instance settings.
     
    252252 * Who's Online Widget.
    253253 *
    254  * @since BuddyPress (1.0.3)
     254 * @since 1.0.3
    255255 */
    256256class BP_Core_Whos_Online_Widget extends WP_Widget {
     
    284284         * Filters the title of the Who's Online widget.
    285285         *
    286          * @since BuddyPress (1.8.0)
    287          * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     286         * @since 1.8.0
     287         * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    288288         *
    289289         * @param string $title    The widget title.
     
    383383     * Merge the widget settings into defaults array.
    384384     *
    385      * @since BuddyPress (2.3.0)
     385     * @since 2.3.0
    386386     *
    387387     * @param array $instance Widget instance settings.
     
    402402 * Recently Active Members Widget.
    403403 *
    404  * @since BuddyPress (1.0.3)
     404 * @since 1.0.3
    405405 */
    406406class BP_Core_Recently_Active_Widget extends WP_Widget {
     
    434434         * Filters the title of the Recently Active widget.
    435435         *
    436          * @since BuddyPress (1.8.0)
    437          * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     436         * @since 1.8.0
     437         * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    438438         *
    439439         * @param string $title    The widget title.
     
    533533     * Merge the widget settings into defaults array.
    534534     *
    535      * @since BuddyPress (2.3.0)
     535     * @since 2.3.0
    536536     *
    537537     * @param array $instance Widget instance settings.
     
    552552 * AJAX request handler for Members widgets.
    553553 *
    554  * @since BuddyPress (1.0.0)
     554 * @since 1.0.0
    555555 *
    556556 * @see BP_Core_Members_Widget
  • trunk/src/bp-members/classes/class-bp-signup.php

    r9877 r10149  
    11<?php
    2 
    32/**
    43 * Signups Management class.
    54 *
     5 * @since 2.0.0
     6 *
    67 * @package BuddyPress
    78 * @subpackage coreClasses
    8  *
    9  * @since BuddyPress (2.0.0)
    109 */
     10
    1111class BP_Signup {
    1212
     
    7373     * Class constructor.
    7474     *
    75      * @since BuddyPress (2.0.0)
     75     * @since 2.0.0
    7676     *
    7777     * @param integer $signup_id The ID for the signup being queried.
     
    8787     * Populate the instantiated class with data based on the signup_id provided.
    8888     *
    89      * @since BuddyPress (2.0.0)
     89     * @since 2.0.0
    9090     */
    9191    public function populate() {
     
    109109     * Fetch signups based on parameters.
    110110     *
    111      * @since BuddyPress (2.0.0)
     111     * @since 2.0.0
    112112     *
    113113     * @param array $args the argument to retrieve desired signups.
     
    180180         * Filters the Signups paged query.
    181181         *
    182          * @since BuddyPress (2.0.0)
     182         * @since 2.0.0
    183183         *
    184184         * @param string $value SQL statement.
     
    241241         * Filters the Signups count query.
    242242         *
    243          * @since BuddyPress (2.0.0)
     243         * @since 2.0.0
    244244         *
    245245         * @param string $value SQL statement.
     
    256256     * Add a signup.
    257257     *
    258      * @since BuddyPress (2.0.0)
     258     * @since 2.0.0
    259259     *
    260260     * @param array $args
     
    297297         * Filters the result of a signup addition.
    298298         *
    299          * @since BuddyPress (2.0.0)
     299         * @since 2.0.0
    300300         *
    301301         * @param int|bool $retval Newly added user ID on success, false on failure.
     
    314314     * default behavior.
    315315     *
    316      * @since BuddyPress (2.0.0)
     316     * @since 2.0.0
    317317     *
    318318     * @param string $user_login    User login string.
     
    370370         * Filters the user ID for the backcompat functionality.
    371371         *
    372          * @since BuddyPress (2.0.0)
     372         * @since 2.0.0
    373373         *
    374374         * @param int $user_id User ID being registered.
     
    380380     * Check a user status (from wp_users) on a non-multisite config.
    381381     *
    382      * @since BuddyPress (2.0.0)
     382     * @since 2.0.0
    383383     *
    384384     * @param int $user_id ID of the user being checked.
     
    398398         * Filters the user status of a provided user ID.
    399399         *
    400          * @since BuddyPress (2.0.0)
     400         * @since 2.0.0
    401401         *
    402402         * @param int $value User status of the provided user ID.
     
    408408     * Activate a signup.
    409409     *
    410      * @since BuddyPress (2.0.0)
     410     * @since 2.0.0
    411411     *
    412412     * @param string $key Activation key.
     
    445445         * Filters the status of the activated user.
    446446         *
    447          * @since BuddyPress (2.0.0)
     447         * @since 2.0.0
    448448         *
    449449         * @param bool $activated Whether or not the activation was successful.
     
    455455     * How many inactive signups do we have?
    456456     *
    457      * @since BuddyPress (2.0.0)
     457     * @since 2.0.0
    458458     *
    459459     * @return int The number of signups.
     
    468468         * Filters the total inactive signups.
    469469         *
    470          * @since BuddyPress (2.0.0)
     470         * @since 2.0.0
    471471         *
    472472         * @param int $count_signups How many total signups there are.
     
    481481     * email was sent and how many times activation was sent.
    482482     *
    483      * @since BuddyPress (2.0.0)
     483     * @since 2.0.0
    484484     *
    485485     * @param array $args
     
    526526         * Filters the signup ID which received a meta update.
    527527         *
    528          * @since BuddyPress (2.0.0)
     528         * @since 2.0.0
    529529         *
    530530         * @param int $value The signup ID.
     
    536536     * Resend an activation email.
    537537     *
    538      * @since BuddyPress (2.0.0)
     538     * @since 2.0.0
    539539     *
    540540     * @param array $signup_ids Single ID or list of IDs to resend.
     
    560560         * Fires before activation emails are resent.
    561561         *
    562          * @since BuddyPress (2.0.0)
     562         * @since 2.0.0
    563563         *
    564564         * @param array $signup_ids Array of IDs to resend activation emails to.
     
    606606         * Fires after activation emails are resent.
    607607         *
    608          * @since BuddyPress (2.0.0)
     608         * @since 2.0.0
    609609         *
    610610         * @param array $signup_ids Array of IDs to resend activation emails to.
     
    616616         * Filters the result of the metadata for signup activation email resends.
    617617         *
    618          * @since BuddyPress (2.0.0)
     618         * @since 2.0.0
    619619         *
    620620         * @param array $result Updated metadata related to activation emails.
     
    626626     * Activate a pending account.
    627627     *
    628      * @since BuddyPress (2.0.0)
     628     * @since 2.0.0
    629629     *
    630630     * @param array $signup_ids Single ID or list of IDs to activate.
     
    650650         * Fires before activation of user accounts.
    651651         *
    652          * @since BuddyPress (2.0.0)
     652         * @since 2.0.0
    653653         *
    654654         * @param array $signup_ids Array of IDs to activate.
     
    689689         * Fires after activation of user accounts.
    690690         *
    691          * @since BuddyPress (2.0.0)
     691         * @since 2.0.0
    692692         *
    693693         * @param array $signup_ids Array of IDs activated activate.
     
    699699         * Filters the result of the metadata after user activation.
    700700         *
    701          * @since BuddyPress (2.0.0)
     701         * @since 2.0.0
    702702         *
    703703         * @param array $result Updated metadata related to user activation.
     
    709709     * Delete a pending account.
    710710     *
    711      * @since BuddyPress (2.0.0)
     711     * @since 2.0.0
    712712     *
    713713     * @param array $signup_ids Single ID or list of IDs to delete.
     
    735735         * Fires before deletion of pending accounts.
    736736         *
    737          * @since BuddyPress (2.0.0)
     737         * @since 2.0.0
    738738         *
    739739         * @param array $signup_ids Array of pending IDs to delete.
     
    777777         * Fires after deletion of pending accounts.
    778778         *
    779          * @since BuddyPress (2.0.0)
     779         * @since 2.0.0
    780780         *
    781781         * @param array $signup_ids Array of pending IDs to delete.
     
    787787         * Filters the result of the metadata for deleted pending accounts.
    788788         *
    789          * @since BuddyPress (2.0.0)
     789         * @since 2.0.0
    790790         *
    791791         * @param array $result Updated metadata related to deleted pending accounts.
Note: See TracChangeset for help on using the changeset viewer.