Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
11/10/2013 02:04:14 AM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-blogs

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r7386 r7555  
    1111if ( !defined( 'ABSPATH' ) ) exit;
    1212
     13/**
     14 * Load the "My Blogs" screen.
     15 */
    1316function bp_blogs_screen_my_blogs() {
    1417    if ( !is_multisite() )
    … …  
    2023}
    2124
     25/**
     26 * Load the "Create a Blog" screen.
     27 */
    2228function bp_blogs_screen_create_a_blog() {
    2329
    … …  
    3440add_action( 'bp_screens', 'bp_blogs_screen_create_a_blog', 3 );
    3541
     42/**
     43 * Load the top-level Blogs directory.
     44 */
    3645function bp_blogs_screen_index() {
    3746    if ( is_multisite() && bp_is_blogs_component() && !bp_current_action() ) {
    … …  
    4857
    4958/**
    50  * The main theme compat class for BuddyPress Activity
     59 * The main theme compat class for BuddyPress Blogs
    5160 *
    5261 * This class sets up the necessary theme compatability actions to safely output
    5362 * group template parts to the_title and the_content areas of a theme.
    5463 *
    55  * @since BuddyPress (1.7)
     64 * @since BuddyPress (1.7.0)
    5665 */
    5766class BP_Blogs_Theme_Compat {
    5867
    5968    /**
    60      * Setup the groups component theme compatibility
    61      *
    62      * @since BuddyPress (1.7)
     69     * Set up theme compatibility for the Blogs component.
     70     *
     71     * @since BuddyPress (1.7.0)
    6372     */
    6473    public function __construct() {
    … …  
    6776
    6877    /**
    69      * Are we looking at something that needs group theme compatability?
    70      *
    71      * @since BuddyPress (1.7)
     78     * Are we looking at something that needs Blogs theme compatability?
     79     *
     80     * @since BuddyPress (1.7.0)
    7281     */
    7382    public function is_blogs() {
    … …  
    104113     * Add template hierarchy to theme compat for the blog directory page.
    105114     *
    106      * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    107      *
    108      * @since BuddyPress (1.8)
    109      *
    110      * @param string $templates The templates from bp_get_theme_compat_templates()
     115     * This is to mirror how WordPress has
     116     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
     117     *
     118     * @since BuddyPress (1.8.0)
     119     *
     120     * @param string $templates The templates from
     121     *        bp_get_theme_compat_templates().
    111122     * @return array $templates Array of custom templates to look for.
    112123     */
    … …  
    125136
    126137    /**
    127      * Update the global $post with directory data
    128      *
    129      * @since BuddyPress (1.7)
     138     * Update the global $post with directory data.
     139     *
     140     * @since BuddyPress (1.7.0)
    130141     */
    131142    public function directory_dummy_post() {
    … …  
    152163
    153164    /**
    154      * Filter the_content with the groups index template part
    155      *
    156      * @since BuddyPress (1.7)
     165     * Filter the_content with the groups index template part.
     166     *
     167     * @since BuddyPress (1.7.0)
    157168     */
    158169    public function directory_content() {
    … …  
    165176     * Add custom template hierarchy to theme compat for the blog create page.
    166177     *
    167      * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    168      *
    169      * @since BuddyPress (1.8)
    170      *
    171      * @param string $templates The templates from bp_get_theme_compat_templates()
     178     * This is to mirror how WordPress has
     179     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
     180     *
     181     * @since BuddyPress (1.8.0)
     182     *
     183     * @param string $templates The templates from
     184     *        bp_get_theme_compat_templates().
    172185     * @return array $templates Array of custom templates to look for.
    173186     */
    … …  
    186199
    187200    /**
    188      * Update the global $post with create screen data
    189      *
    190      * @since BuddyPress (1.7)
     201     * Update the global $post with create screen data.
     202     *
     203     * @since BuddyPress (1.7.0)
    191204     */
    192205    public function create_dummy_post() {
    … …  
    213226
    214227    /**
    215      * Filter the_content with the create screen template part
    216      *
    217      * @since BuddyPress (1.7)
     228     * Filter the_content with the create screen template part.
     229     *
     230     * @since BuddyPress (1.7.0)
    218231     */
    219232    public function create_content() {
Note: See TracChangeset for help on using the changeset viewer.