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-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() {
Note: See TracChangeset for help on using the changeset viewer.