Skip to:
Content

BuddyPress.org


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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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.
Note: See TracChangeset for help on using the changeset viewer.