Skip to:
Content

BuddyPress.org

Changeset 7429


Ignore:
Timestamp:
10/15/2013 03:07:46 AM (11 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-blogs-template.php

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-blogs/bp-blogs-template.php

    r7345 r7429  
    22
    33/**
    4  * BuddyPress Blogs Template Tags
     4 * BuddyPress Blogs Template Tags.
    55 *
    66 * @package BuddyPress
     
    1212
    1313/**
    14  * Output the blogs component slug
    15  *
    16  * @package BuddyPress
    17  * @subpackage BlogsTemplate
     14 * Output the blogs component slug.
     15 *
    1816 * @since BuddyPress (1.5)
    1917 *
     
    2422}
    2523    /**
    26      * Return the blogs component slug
    27      *
    28      * @package BuddyPress
    29      * @subpackage BlogsTemplate
     24     * Return the blogs component slug.
     25     *
    3026     * @since BuddyPress (1.5)
     27     *
     28     * @return string The 'blogs' slug.
    3129     */
    3230    function bp_get_blogs_slug() {
     
    3533
    3634/**
    37  * Output the blogs component root slug
    38  *
    39  * @package BuddyPress
    40  * @subpackage BlogsTemplate
     35 * Output the blogs component root slug.
     36 *
    4137 * @since BuddyPress (1.5)
    4238 *
     
    4743}
    4844    /**
    49      * Return the blogs component root slug
    50      *
    51      * @package BuddyPress
    52      * @subpackage BlogsTemplate
     45     * Return the blogs component root slug.
     46     *
    5347     * @since BuddyPress (1.5)
     48     *
     49     * @return string The 'blogs' root slug.
    5450     */
    5551    function bp_get_blogs_root_slug() {
     
    5854
    5955/**
    60  * Output blog directory permalink
    61  *
    62  * @package BuddyPress
    63  * @subpackage BlogsTemplate
     56 * Output blog directory permalink.
     57 *
    6458 * @since BuddyPress (1.5)
     59 *
    6560 * @uses bp_get_blogs_directory_permalink()
    6661 */
     
    6964}
    7065    /**
    71      * Return blog directory permalink
    72      *
    73      * @package BuddyPress
    74      * @subpackage BlogsTemplate
     66     * Return blog directory permalink.
     67     *
    7568     * @since BuddyPress (1.5)
     69     *
    7670     * @uses apply_filters()
    77      * @uses traisingslashit()
     71     * @uses trailingslashit()
    7872     * @uses bp_get_root_domain()
    7973     * @uses bp_get_blogs_root_slug()
    80      * @return string
     74     * @return string The URL of the Blogs directory.
    8175     */
    8276    function bp_get_blogs_directory_permalink() {
     
    8478    }
    8579
    86 /**********************************************************************
    87  * Blog listing template class.
    88  */
    89 
     80/**
     81 * The main blog template loop class.
     82 *
     83 * Responsible for loading a group of blogs into a loop for display.
     84 */
    9085class BP_Blogs_Template {
     86    /**
     87     * The loop iterator.
     88     *
     89     * @access public
     90     * @var int
     91     */
    9192    var $current_blog = -1;
     93
     94    /**
     95     * The number of blogs returned by the paged query.
     96     *
     97     * @access public
     98     * @var int
     99     */
    92100    var $blog_count;
     101
     102    /**
     103     * Array of blogs located by the query..
     104     *
     105     * @access public
     106     * @var array
     107     */
    93108    var $blogs;
     109
     110    /**
     111     * The blog object currently being iterated on.
     112     *
     113     * @access public
     114     * @var object
     115     */
    94116    var $blog;
    95117
     118    /**
     119     * A flag for whether the loop is currently being iterated.
     120     *
     121     * @access public
     122     * @var bool
     123     */
    96124    var $in_the_loop;
    97125
     126    /**
     127     * The page number being requested.
     128     *
     129     * @access public
     130     * @var public
     131     */
    98132    var $pag_page;
     133
     134    /**
     135     * The number of items being requested per page.
     136     *
     137     * @access public
     138     * @var public
     139     */
    99140    var $pag_num;
     141
     142    /**
     143     * An HTML string containing pagination links.
     144     *
     145     * @access public
     146     * @var string
     147     */
    100148    var $pag_links;
     149
     150    /**
     151     * The total number of blogs matching the query parameters.
     152     *
     153     * @access public
     154     * @var int
     155     */
    101156    var $total_blog_count;
    102157
     158    /**
     159     * Constructor method.
     160     *
     161     * @see BP_Blogs_Blog::get() for a description of parameters.
     162     *
     163     * @param string $type See {@link BP_Blogs_Blog::get()}.
     164     * @param string $page See {@link BP_Blogs_Blog::get()}.
     165     * @param string $per_page See {@link BP_Blogs_Blog::get()}.
     166     * @param string $max See {@link BP_Blogs_Blog::get()}.
     167     * @param string $user_id See {@link BP_Blogs_Blog::get()}.
     168     * @param string $search_terms See {@link BP_Blogs_Blog::get()}.
     169     * @param string $page_arg The string used as a query parameter in
     170     *        pagination links. Default: 'bpage'.
     171     */
    103172    function __construct( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage' ) {
    104173
     
    141210    }
    142211
     212    /**
     213     * Whether there are blogs available in the loop.
     214     *
     215     * @see bp_has_blogs()
     216     *
     217     * @return bool True if there are items in the loop, otherwise false.
     218     */
    143219    function has_blogs() {
    144220        if ( $this->blog_count )
     
    148224    }
    149225
     226    /**
     227     * Set up the next blog and iterate index.
     228     *
     229     * @return object The next blog to iterate over.
     230     */
    150231    function next_blog() {
    151232        $this->current_blog++;
     
    155236    }
    156237
     238    /**
     239     * Rewind the blogs and reset blog index.
     240     */
    157241    function rewind_blogs() {
    158242        $this->current_blog = -1;
     
    162246    }
    163247
     248    /**
     249     * Whether there are blogs left in the loop to iterate over.
     250     *
     251     * This method is used by {@link bp_blogs()} as part of the while loop
     252     * that controls iteration inside the blogs loop, eg:
     253     *     while ( bp_blogs() ) { ...
     254     *
     255     * @see bp_blogs()
     256     *
     257     * @return bool True if there are more blogs to show, otherwise false.
     258     */
    164259    function blogs() {
    165260        if ( $this->current_blog + 1 < $this->blog_count ) {
     
    175270    }
    176271
     272    /**
     273     * Set up the current blog inside the loop.
     274     *
     275     * Used by {@link bp_the_blog()} to set up the current blog data while
     276     * looping, so that template tags used during that iteration make
     277     * reference to the current blog.
     278     *
     279     * @see bp_the_blog()
     280     */
    177281    function the_blog() {
    178282
     
    185289}
    186290
     291/**
     292 * Rewind the blogs and reset blog index.
     293 */
    187294function bp_rewind_blogs() {
    188295    global $blogs_template;
     
    191298}
    192299
     300/**
     301 * Initialize the activity loop.
     302 *
     303 * Based on the $args passed, bp_has_blogs() populates the $blogs_template
     304 * global, enabling the use of BuddyPress templates and template functions to
     305 * display a list of activity items.
     306 *
     307 * @global object $blogs_template {@link BP_Blogs_Template}
     308 *
     309 * @param array $args {
     310 *     Arguments for limiting the contents of the blogs loop. Most arguments
     311 *     are in the same format as {@link BP_Blogs_Blog::get()}. However, because
     312 *     the format of the arguments accepted here differs in a number of ways,
     313 *     and because bp_has_blogs() determines some default arguments in a
     314 *     dynamic fashion, we list all accepted arguments here as well.
     315 *
     316 *     Arguments can be passed as an associative array, or as a URL query
     317 *     string (eg, 'user_id=4&per_page=3').
     318 *
     319 *     @type int $page Which page of results to fetch. Using page=1 without
     320 *           per_page will result in no pagination. Default: 1.
     321 *     @type int|bool $per_page Number of results per page. Default: 20.
     322 *     @type string $page_arg The string used as a query parameter in
     323 *           pagination links. Default: 'bpage'.
     324 *     @type int|bool $max Maximum number of results to return.
     325 *           Default: false (unlimited).
     326 *     @type string $type The order in which results should be fetched.
     327         'active', 'alphabetical', 'newest', or 'random'.
     328 *     @type string $sort 'ASC' or 'DESC'. Default: 'DESC'.
     329 *     @type string $search_terms Limit results by a search term. Default: null.
     330 *     @type int $user_id The ID of the user whose blogs should be retrieved.
     331 *           When viewing a user profile page, 'user_id' defaults to the ID of
     332 *           the displayed user. Otherwise the default is false.
     333 * }
     334 * @return bool Returns true when blogs are found, otherwise false.
     335 */
    193336function bp_has_blogs( $args = '' ) {
    194337    global $blogs_template;
     
    239382}
    240383
     384/**
     385 * Determine if there are still blogs left in the loop.
     386 *
     387 * @global object $blogs_template {@link BP_Blogs_Template}
     388 *
     389 * @return bool Returns true when blogs are found.
     390 */
    241391function bp_blogs() {
    242392    global $blogs_template;
     
    245395}
    246396
     397/**
     398 * Get the current blog object in the loop.
     399 *
     400 * @global object $blogs_template {@link BP_Blogs_Template}
     401 *
     402 * @return object The current blog within the loop.
     403 */
    247404function bp_the_blog() {
    248405    global $blogs_template;
     
    251408}
    252409
     410/**
     411 * Output the blogs pagination count.
     412 *
     413 * @global object $blogs_template {@link BP_Blogs_Template}
     414 */
    253415function bp_blogs_pagination_count() {
    254416    global $blogs_template;
     
    262424}
    263425
     426/**
     427 * Output the blogs pagination links.
     428 */
    264429function bp_blogs_pagination_links() {
    265430    echo bp_get_blogs_pagination_links();
    266431}
     432    /**
     433     * Return the blogs pagination links.
     434     *
     435     * @global object $blogs_template {@link BP_Blogs_Template}
     436     *
     437     * @return string HTML pagination links.
     438     */
    267439    function bp_get_blogs_pagination_links() {
    268440        global $blogs_template;
     
    271443    }
    272444
     445/**
     446 * Output a blog's avatar.
     447 *
     448 * @see bp_get_blog_avatar() for description of arguments.
     449 *
     450 * @param array $args See {@link bp_get_blog_avatar()}.
     451 */
    273452function bp_blog_avatar( $args = '' ) {
    274453    echo bp_get_blog_avatar( $args );
    275454}
     455    /**
     456     * Get a blog's avatar.
     457     *
     458     * At the moment, blog avatars are simply the user avatars of the blog
     459     * admin. Filter 'bp_get_blog_avatar_' . $blog_id to customize.
     460     *
     461     * @see bp_core_fetch_avatar() For a description of arguments and
     462     *      return values.
     463     *
     464     * @param array $args  {
     465     *     Arguments are listed here with an explanation of their defaults.
     466     *     For more information about the arguments, see
     467     *     {@link bp_core_fetch_avatar()}.
     468     *     @type string $alt Default: 'Profile picture of site author
     469     *           [user name]'.
     470     *     @type string $class Default: 'avatar'.
     471     *     @type string $type Default: 'full'.
     472     *     @type int|bool $width Default: false.
     473     *     @type int|bool $height Default: false.
     474     *     @type bool $id Currently unused.
     475     *     @type bool $no_grav Default: false.
     476     * }
     477     * @return string User avatar string.
     478     */
    276479    function bp_get_blog_avatar( $args = '' ) {
    277480        global $blogs_template;
     
    322525    }
    323526
     527/**
     528 * Output the name of the current blog in the loop.
     529 */
    324530function bp_blog_name() {
    325531    echo bp_get_blog_name();
    326532}
     533    /**
     534     * Return the name of the current blog in the loop.
     535     *
     536     * @return string The name of the current blog in the loop.
     537     */
    327538    function bp_get_blog_name() {
    328539        global $blogs_template;
     
    332543
    333544/**
    334  * Outputs the blog ID
     545 * Output the ID of the current blog in the loop.
    335546 *
    336547 * @since BuddyPress (1.7)
     
    340551}
    341552    /**
    342      * Returns the blog ID
    343      *
    344      * @return int
     553     * Return the ID of the current blog in the loop.
     554     *
    345555     * @since BuddyPress (1.7)
     556     *
     557     * @return int ID of the current blog in the loop.
    346558     */
    347559    function bp_get_blog_id() {
     
    351563    }
    352564
     565/**
     566 * Output the description of the current blog in the loop.
     567 */
    353568function bp_blog_description() {
    354569    echo apply_filters( 'bp_blog_description', bp_get_blog_description() );
    355570}
     571    /**
     572     * Return the description of the current blog in the loop.
     573     *
     574     * @return string Description of the current blog in the loop.
     575     */
    356576    function bp_get_blog_description() {
    357577        global $blogs_template;
     
    360580    }
    361581
    362 
    363 /**
    364  * Output the row class of a site
     582/**
     583 * Output the row class of the current blog in the loop.
    365584 *
    366585 * @since BuddyPress (1.7)
     
    370589}
    371590    /**
    372      * Return the row class of a site
     591     * Return the row class of the current blog in the loop.
     592     *
     593     * @since BuddyPress (1.7)
    373594     *
    374595     * @global BP_Blogs_Template $blogs_template
    375      * @return string Row class of the site
    376      * @since BuddyPress (1.7)
     596     *
     597     * @return string Row class of the site.
    377598     */
    378599    function bp_get_blog_class() {
     
    395616    }
    396617
     618/**
     619 * Output the last active date of the current blog in the loop.
     620 */
    397621function bp_blog_last_active() {
    398622    echo bp_get_blog_last_active();
    399623}
     624    /**
     625     * Return the last active date of the current blog in the loop.
     626     *
     627     * @return string Last active date.
     628     */
    400629    function bp_get_blog_last_active() {
    401630        global $blogs_template;
     
    404633    }
    405634
     635/**
     636 * Output the latest post from the current blog in the loop.
     637 */
    406638function bp_blog_latest_post() {
    407639    echo bp_get_blog_latest_post();
    408640}
     641    /**
     642     * Return the latest post from the current blog in the loop.
     643     *
     644     * @return string $retval String of the form 'Latest Post: [link to post]'.
     645     */
    409646    function bp_get_blog_latest_post() {
    410647        global $blogs_template;
     
    419656
    420657/**
    421  * Prints this site's latest article's title
     658 * Output the title of the latest post on the current blog in the loop.
    422659 *
    423660 * @since BuddyPress (1.7)
     
    429666}
    430667    /**
    431      * Returns this site's latest article's title
     668     * Return the title of the latest post on the current blog in the loop.
    432669     *
    433670     * @since BuddyPress (1.7)
    434671     *
    435672     * @global BP_Blogs_Template
    436      * @return string
     673     *
     674     * @return string Post title.
    437675     */
    438676    function bp_get_blog_latest_post_title() {
     
    448686
    449687/**
    450  * Prints this site's latest article's permalink
     688 * Output the permalink of the latest post on the current blog in the loop.
     689 *
     690 * @since BuddyPress (1.7)
    451691 *
    452692 * @see bp_get_blog_latest_post_title()
    453  * @since BuddyPress (1.7)
    454693 */
    455694function bp_blog_latest_post_permalink() {
     
    457696}
    458697    /**
    459      * Returns this site's latest article's permalink
     698     * Return the permalink of the latest post on the current blog in the loop.
     699     *
     700     * @since BuddyPress (1.7)
    460701     *
    461702     * @global BP_Blogs_Template
    462      * @return string
    463      * @since BuddyPress (1.7)
     703     *
     704     * @return string URL of the blog's latest post.
    464705     */
    465706    function bp_get_blog_latest_post_permalink() {
     
    475716
    476717/**
    477  * Prints this site's latest article's content
     718 * Output the content of the latest post on the current blog in the loop.
    478719 *
    479720 * @since BuddyPress (1.7)
     
    485726}
    486727    /**
    487      * Returns this site's latest article's content
     728     * Return the content of the latest post on the current blog in the loop.
    488729     *
    489730     * @since BuddyPress (1.7)
    490731     *
    491732     * @global BP_Blogs_Template
    492      * @return string
     733     *
     734     * @return string Content of the blog's latest post.
    493735     */
    494736    function bp_get_blog_latest_post_content() {
     
    504746
    505747/**
    506  * Prints this site's latest article's featured image
     748 * Output the featured image of the latest post on the current blog in the loop.
    507749 *
    508750 * @since BuddyPress (1.7)
    509751 *
    510  * @param string $size Image version to return. Either "thumbnail", "medium", "large", "post-thumbnail".
    511  * @see bp_get_blog_latest_post_content()
     752 * @see bp_get_blog_latest_post_content() For description of parameters.
     753 *
     754 * @param string $size See {@link bp_get_blog_latest_post_featured_image()}.
    512755 */
    513756function bp_blog_latest_post_featured_image( $size = 'thumbnail' ) {
     
    515758}
    516759    /**
    517      * Returns this site's latest article's featured image
     760     * Return the featured image of the latest post on the current blog in the loop.
    518761     *
    519762     * @since BuddyPress (1.7)
    520763     *
    521764     * @global BP_Blogs_Template
    522      * @param string $size Image version to return. Either "thumbnail", "medium", "large", "post-thumbnail".
    523      * @return string
     765     *
     766     * @param string $size Image version to return. 'thumbnail', 'medium',
     767     *        'large', or 'post-thumbnail'. Default: 'thumbnail'.
     768     * @return string URL of the image.
    524769     */
    525770    function bp_get_blog_latest_post_featured_image( $size = 'thumbnail' ) {
     
    537782 * Does the latest blog post have a featured image?
    538783 *
    539  * @param string $size Image version to check for. Either "thumbnail", "medium", "large", "post-thumbnail".
    540  * @return bool
    541784 * @since BuddyPress (1.7)
     785 *
     786 * @param string $size Image version to return. 'thumbnail', 'medium', 'large',
     787 *        or 'post-thumbnail'. Default: 'thumbnail'.
     788 * @return bool True if the latest blog post from the current blog has a
     789 *         featured image of the given size.
    542790 */
    543791function bp_blog_latest_post_has_featured_image( $thumbnail = 'thumbnail' ) {
     
    547795}
    548796
     797/**
     798 * Output hidden fields to help with form submissions in Sites directory.
     799 *
     800 * This function detects whether 's', 'letter', or 'blogs_search' requests are
     801 * currently being made (as in a URL parameter), and creates corresponding
     802 * hidden fields.
     803 */
    549804function bp_blog_hidden_fields() {
    550805    if ( isset( $_REQUEST['s'] ) )
     
    558813}
    559814
     815/**
     816 * Output the total number of blogs on the site.
     817 */
    560818function bp_total_blog_count() {
    561819    echo bp_get_total_blog_count();
    562820}
     821    /**
     822     * Return the total number of blogs on the site.
     823     *
     824     * @return int Total number of blogs.
     825     */
    563826    function bp_get_total_blog_count() {
    564827        return apply_filters( 'bp_get_total_blog_count', bp_blogs_total_blogs() );
     
    566829    add_filter( 'bp_get_total_blog_count', 'bp_core_number_format' );
    567830
     831/**
     832 * Output the total number of blogs for a given user.
     833 *
     834 * @param int $user_id ID of the user.
     835 */
    568836function bp_total_blog_count_for_user( $user_id = 0 ) {
    569837    echo bp_get_total_blog_count_for_user( $user_id );
    570838}
     839    /**
     840     * Return the total number of blogs for a given user.
     841     *
     842     * @param int $user_id ID of the user.
     843     * @return int Total number of blogs for the user.
     844     */
    571845    function bp_get_total_blog_count_for_user( $user_id = 0 ) {
    572846        return apply_filters( 'bp_get_total_blog_count_for_user', bp_blogs_total_blogs_for_user( $user_id ) );
     
    575849
    576850
    577 /* Blog registration template tags */
    578 
     851/** Blog Registration ********************************************************/
     852
     853/**
     854 * Checks whether blog creation is enabled.
     855 *
     856 * Returns true when blog creation is enabled for logged-in users only, or
     857 * when it's enabled for new registrations.
     858 *
     859 * @return bool True if blog registration is enabled.
     860 */
    579861function bp_blog_signup_enabled() {
    580862    global $bp;
     
    590872}
    591873
     874/**
     875 * Output the wrapper markup for the blog signup form.
     876 *
     877 * @param string $blogname Optional. The default blog name (path or domain).
     878 * @param string $blog_title Optional. The default blog title.
     879 * @param string|WP_Error Optional. The WP_Error object returned by a previous
     880 *        submission attempt.
     881 */
    592882function bp_show_blog_signup_form($blogname = '', $blog_title = '', $errors = '') {
    593883    global $current_user;
     
    630920}
    631921
     922/**
     923 * Output the input fields for the blog creation form.
     924 *
     925 * @param string $blogname Optional. The default blog name (path or domain).
     926 * @param string $blog_title Optional. The default blog title.
     927 * @param string|WP_Error Optional. The WP_Error object returned by a previous
     928 *        submission attempt.
     929 */
    632930function bp_blogs_signup_blog( $blogname = '', $blog_title = '', $errors = '' ) {
    633931    global $current_site;
     
    694992
    695993/**
    696  * Echo the value of bp_blogs_get_subdomain_base()
     994 * Output the base URL for subdomain installations of WordPress Multisite.
    697995 *
    698996 * @since BuddyPress (1.6)
     
    7021000}
    7031001    /**
    704      * Return the base URL to be displayed when a user chooses an address for a new blog, on
    705      * a subdomain installation of WordPress MS
     1002     * Return the base URL for subdomain installations of WordPress Multisite.
    7061003     *
    7071004     * @since BuddyPress (1.6)
    708      * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com
     1005     *
     1006     * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com.
    7091007     */
    7101008    function bp_blogs_get_subdomain_base() {
     
    7141012    }
    7151013
     1014/**
     1015 * Process a blog registration submission.
     1016 *
     1017 * Passes submitted values to {@link wpmu_create_blog()}.
     1018 *
     1019 * @return bool True on success, false on failure.
     1020 */
    7161021function bp_blogs_validate_blog_signup() {
    7171022    global $wpdb, $current_user, $blogname, $blog_title, $errors, $domain, $path, $current_site;
     
    7481053}
    7491054
     1055/**
     1056 * Validate a blog creation submission.
     1057 *
     1058 * Essentially, a wrapper for {@link wpmu_validate_blog_signup()}.
     1059 *
     1060 * @return array Contains the new site data and error messages.
     1061 */
    7501062function bp_blogs_validate_blog_form() {
    7511063    $user = '';
     
    7561068}
    7571069
     1070/**
     1071 * Display a message after successful blog registration.
     1072 *
     1073 * @param string $domain The new blog's domain.
     1074 * @param string $path The new blog's path.
     1075 * @param string $blog_title The new blog's title.
     1076 * @param string $user_name The user name of the user who created the blog. Unused.
     1077 * @param string $user_email The email of the user who created the blog. Unused.
     1078 * @param string|array $meta Meta values associated with the new blog. Unused.
     1079 */
    7581080function bp_blogs_confirm_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = '' ) {
    7591081    $protocol = is_ssl() ? 'https://' : 'http://';
     
    7691091}
    7701092
     1093/**
     1094 * Output a "Create a Site" link for users viewing their own profiles.
     1095 */
    7711096function bp_create_blog_link() {
    7721097    if ( bp_is_my_profile() )
     
    7741099}
    7751100
     1101/**
     1102 * Output navigation tabs for a user Blogs page.
     1103 *
     1104 * Currently unused by BuddyPress.
     1105 */
    7761106function bp_blogs_blog_tabs() {
    7771107
     
    7931123
    7941124/**
    795  * Echoes the blog directory search form
     1125 * Output the blog directory search form.
    7961126 */
    7971127function bp_directory_blogs_search_form() {
     
    8081138
    8091139/**
    810  * bp_blogs_visit_blog_button()
    811  *
    812  * Output button for visiting a blog in a loop
    813  *
    814  * @param array $args Custom button properties
     1140 * Output button for visiting a blog in a loop.
     1141 *
     1142 * @see bp_get_blogs_visit_blog_button() for description of arguments.
     1143 *
     1144 * @param array $args See {@link bp_get_blogs_visit_blog_button()}.
    8151145 */
    8161146function bp_blogs_visit_blog_button( $args = '' ) {
     
    8181148}
    8191149    /**
    820      * bp_get_blogs_visit_blog_button()
    821      *
    822      * Return button for visiting a blog in a loop
    823      *
    824      * @param array $args Custom button properties
    825      * @return string
     1150     * Return button for visiting a blog in a loop.
     1151     *
     1152     * @see BP_Button for a complete description of arguments and return
     1153     *      value.
     1154     *
     1155     * @param array $args {
     1156     *     Arguments are listed below, with their default values. For a
     1157     *     complete description of arguments, see {@link BP_Button}.
     1158     *     @type string $id Default: 'visit_blog'.
     1159     *     @type string $component Default: 'blogs'.
     1160     *     @type bool $must_be_logged_in Default: false.
     1161     *     @type bool $block_self Default: false.
     1162     *     @type string $wrapper_class Default: 'blog-button visit'.
     1163     *     @type string $link_href Permalink of the current blog in the loop.
     1164     *     @type string $link_class Default: 'blog-button visit'.
     1165     *     @type string $link_text Default: 'Visit Site'.
     1166     *     @type string $link_title Default: 'Visit Site'.
     1167     * }
     1168     * @return string The HTML for the Visit button.
    8261169     */
    8271170    function bp_get_blogs_visit_blog_button( $args = '' ) {
Note: See TracChangeset for help on using the changeset viewer.