Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/01/2014 01:58:27 AM (11 years ago)
Author:
boonebgorges
Message:

Improved documentation in Members component. See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bp-members/bp-members-screens.php

    r8119 r8335  
    44 * BuddyPress Member Screens
    55 *
    6  * Handlers for member screens that aren't handled elsewhere
     6 * Handlers for member screens that aren't handled elsewhere.
    77 *
    88 * @package BuddyPress
    … …  
    1414
    1515/**
    16  * Handles the display of the profile page by loading the correct template file.
    17  *
    18  * @package BuddyPress Members
    19  * @uses bp_core_load_template() Looks for and loads a template file within the current member theme (folder/filename)
     16 * Handle the display of the profile page by loading the correct template file.
    2017 */
    2118function bp_members_screen_display_profile() {
    … …  
    2522
    2623/**
    27  * Handles the display of the members directory index
    28  *
    29  * @global object $bp
    30  *
    31  * @uses bp_is_user()
    32  * @uses bp_is_current_component()
    33  * @uses do_action()
    34  * @uses bp_core_load_template()
    35  * @uses apply_filters()
     24 * Handle the display of the members directory index.
    3625 */
    3726function bp_members_screen_index() {
    … …  
    4635add_action( 'bp_screens', 'bp_members_screen_index' );
    4736
    48 
     37/**
     38 * Handle the loading of the signup screen.
     39 */
    4940function bp_core_screen_signup() {
    5041    global $bp;
    … …  
    221212add_action( 'bp_screens', 'bp_core_screen_signup' );
    222213
     214/**
     215 * Handle the loading of the Activate screen.
     216 */
    223217function bp_core_screen_activation() {
    224218    global $bp;
    … …  
    268262add_action( 'bp_screens', 'bp_core_screen_activation' );
    269263
    270 /** Theme Compatability *******************************************************/
     264/** Theme Compatibility *******************************************************/
    271265
    272266/**
    273267 * The main theme compat class for BuddyPress Members.
    274268 *
    275  * This class sets up the necessary theme compatability actions to safely output
     269 * This class sets up the necessary theme compatibility actions to safely output
    276270 * member template parts to the_title and the_content areas of a theme.
    277271 *
    278  * @since BuddyPress (1.7)
     272 * @since BuddyPress (1.7.0)
    279273 */
    280274class BP_Members_Theme_Compat {
    281275
    282276    /**
    283      * Setup the members component theme compatibility
    284      *
    285      * @since BuddyPress (1.7)
     277     * Set up the members component theme compatibility.
     278     *
     279     * @since BuddyPress (1.7.0)
    286280     */
    287281    public function __construct() {
    … …  
    290284
    291285    /**
    292      * Are we looking at something that needs members theme compatability?
    293      *
    294      * @since BuddyPress (1.7)
     286     * Are we looking at something that needs members theme compatibility?
     287     *
     288     * @since BuddyPress (1.7.0)
    295289     */
    296290    public function is_members() {
    … …  
    331325     * Add template hierarchy to theme compat for the members directory page.
    332326     *
    333      * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    334      *
    335      * @since BuddyPress (1.8)
    336      *
    337      * @param string $templates The templates from bp_get_theme_compat_templates()
     327     * This is to mirror how WordPress has
     328     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
     329     *
     330     * @since BuddyPress (1.8.0)
     331     *
     332     * @param string $templates The templates from bp_get_theme_compat_templates().
    338333     * @return array $templates Array of custom templates to look for.
    339334     */
    … …  
    353348
    354349    /**
    355      * Update the global $post with directory data
    356      *
    357      * @since BuddyPress (1.7)
     350     * Update the global $post with directory data.
     351     *
     352     * @since BuddyPress (1.7.0)
    358353     */
    359354    public function directory_dummy_post() {
    … …  
    372367
    373368    /**
    374      * Filter the_content with the members index template part
    375      *
    376      * @since BuddyPress (1.7)
     369     * Filter the_content with the members index template part.
     370     *
     371     * @since BuddyPress (1.7.0)
    377372     */
    378373    public function directory_content() {
    … …  
    385380     * Add custom template hierarchy to theme compat for member pages.
    386381     *
    387      * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    388      *
    389      * @since BuddyPress (1.8)
    390      *
    391      * @param string $templates The templates from bp_get_theme_compat_templates()
     382     * This is to mirror how WordPress has
     383     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
     384     *
     385     * @since BuddyPress (1.8.0)
     386     *
     387     * @param string $templates The templates from
     388     *        bp_get_theme_compat_templates().
    392389     * @return array $templates Array of custom templates to look for.
    393390     */
    … …  
    413410
    414411    /**
    415      * Update the global $post with the displayed user's data
    416      *
    417      * @since BuddyPress (1.7)
     412     * Update the global $post with the displayed user's data.
     413     *
     414     * @since BuddyPress (1.7.0)
    418415     */
    419416    public function single_dummy_post() {
    … …  
    432429
    433430    /**
    434      * Filter the_content with the members' single home template part
    435      *
    436      * @since BuddyPress (1.7)
     431     * Filter the_content with the members' single home template part.
     432     *
     433     * @since BuddyPress (1.7.0)
    437434     */
    438435    public function single_dummy_content() {
    … …  
    448445 * registration template parts to the_title and the_content areas of a theme.
    449446 *
    450  * @since BuddyPress (1.7)
     447 * @since BuddyPress (1.7.0)
    451448 */
    452449class BP_Registration_Theme_Compat {
    … …  
    455452     * Setup the groups component theme compatibility
    456453     *
    457      * @since BuddyPress (1.7)
     454     * @since BuddyPress (1.7.0)
    458455     */
    459456    public function __construct() {
    … …  
    464461     * Are we looking at either the registration or activation pages?
    465462     *
    466      * @since BuddyPress (1.7)
     463     * @since BuddyPress (1.7.0)
    467464     */
    468465    public function is_registration() {
    … …  
    485482
    486483    /**
    487      * Add template hierarchy to theme compat for registration / activation pages.
    488      *
    489      * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    490      *
    491      * @since BuddyPress (1.8)
    492      *
    493      * @param string $templates The templates from bp_get_theme_compat_templates()
     484     * Add template hierarchy to theme compat for registration/activation pages.
     485     *
     486     * This is to mirror how WordPress has
     487     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
     488     *
     489     * @since BuddyPress (1.8.0)
     490     *
     491     * @param string $templates The templates from bp_get_theme_compat_templates().
    494492     * @return array $templates Array of custom templates to look for.
    495493     */
    … …  
    510508
    511509    /**
    512      * Update the global $post with dummy data
    513      *
    514      * @since BuddyPress (1.7)
     510     * Update the global $post with dummy data.
     511     *
     512     * @since BuddyPress (1.7.0)
    515513     */
    516514    public function dummy_post() {
    … …  
    550548     * Filter the_content with either the register or activate templates.
    551549     *
    552      * @since BuddyPress (1.7)
     550     * @since BuddyPress (1.7.0)
    553551     */
    554552    public function dummy_content() {
Note: See TracChangeset for help on using the changeset viewer.