Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/12/2015 06:03:18 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Blogs component.

See #6576

File:
1 edited

Legend:

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

    r10011 r10100  
    11<?php
    2 
    32/**
    43 * BuddyPress Blogs Template Tags.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Output the blogs component slug.
    1514 *
    16  * @since BuddyPress (1.5.0)
     15 * @since 1.5.0
    1716 *
    1817 * @uses bp_get_blogs_slug()
     
    2423         * Return the blogs component slug.
    2524         *
    26          * @since BuddyPress (1.5.0)
     25         * @since 1.5.0
    2726         *
    2827         * @return string The 'blogs' slug.
     
    3332                 * Filters the blogs component slug.
    3433                 *
    35                  * @since BuddyPress (1.5.0)
     34                 * @since 1.5.0
    3635                 *
    3736                 * @param string $slug Slug for the blogs component.
     
    4342 * Output the blogs component root slug.
    4443 *
    45  * @since BuddyPress (1.5.0)
     44 * @since 1.5.0
    4645 *
    4746 * @uses bp_get_blogs_root_slug()
     
    5352         * Return the blogs component root slug.
    5453         *
    55          * @since BuddyPress (1.5.0)
     54         * @since 1.5.0
    5655         *
    5756         * @return string The 'blogs' root slug.
     
    6261                 * Filters the blogs component root slug.
    6362                 *
    64                  * @since BuddyPress (1.5.0)
     63                 * @since 1.5.0
    6564                 *
    6665                 * @param string $root_slug Root slug for the blogs component.
     
    7271 * Output blog directory permalink.
    7372 *
    74  * @since BuddyPress (1.5.0)
     73 * @since 1.5.0
    7574 *
    7675 * @uses bp_get_blogs_directory_permalink()
     
    8281         * Return blog directory permalink.
    8382         *
    84          * @since BuddyPress (1.5.0)
     83         * @since 1.5.0
    8584         *
    8685         * @uses apply_filters()
     
    9695                 * Filters the blog directory permalink.
    9796                 *
    98                  * @since BuddyPress (1.5.0)
     97                 * @since 1.5.0
    9998                 *
    10099                 * @param string $value Permalink URL for the blog directory.
     
    309308                         * Fires right before the rewinding of blogs listing after all are shown.
    310309                         *
    311                          * @since BuddyPress (1.5.0)
     310                         * @since 1.5.0
    312311                         */
    313312                        do_action( 'blog_loop_end' );
     
    340339                         * Fires if on the first blog in the loop.
    341340                         *
    342                          * @since BuddyPress (1.5.0)
     341                         * @since 1.5.0
    343342                         */
    344343                        do_action( 'blog_loop_start' );
     
    426425         * Filters whether or not there are blogs to list.
    427426         *
    428          * @since BuddyPress (1.1.0)
     427         * @since 1.1.0
    429428         *
    430429         * @param bool              $value          Whether or not there are blogs to list.
     
    502501                 * Filters the blogs pagination links.
    503502                 *
    504                  * @since BuddyPress (1.0.0)
     503                 * @since 1.0.0
    505504                 *
    506505                 * @param string $pag_links HTML pagination links.
     
    525524         * admin. Filter 'bp_get_blog_avatar_' . $blog_id to customize.
    526525         *
    527          * @since BuddyPress (2.4.0) Introduced `$title` argument.
     526         * @since 2.4.0 Introduced `$title` argument.
    528527         *
    529528         * @see bp_core_fetch_avatar() For a description of arguments and
     
    595594                 * Filters a blog's avatar.
    596595                 *
    597                  * @since BuddyPress (1.5.0)
     596                 * @since 1.5.0
    598597                 *
    599598                 * @param string $avatar  Formatted HTML <img> element, or raw avatar
     
    624623                 * Filters the blog permalink.
    625624                 *
    626                  * @since BuddyPress (1.0.0)
     625                 * @since 1.0.0
    627626                 *
    628627                 * @param string $permalink Permalink URL for the blog.
     
    648647                 * Filters the name of the current blog in the loop.
    649648                 *
    650                  * @since BuddyPress (1.2.0)
     649                 * @since 1.2.0
    651650                 *
    652651                 * @param string $name Name of the current blog in the loop.
     
    658657 * Output the ID of the current blog in the loop.
    659658 *
    660  * @since BuddyPress (1.7.0)
     659 * @since 1.7.0
    661660 */
    662661function bp_blog_id() {
     
    666665         * Return the ID of the current blog in the loop.
    667666         *
    668          * @since BuddyPress (1.7.0)
     667         * @since 1.7.0
    669668         *
    670669         * @return int ID of the current blog in the loop.
     
    676675                 * Filters the ID of the current blog in the loop.
    677676                 *
    678                  * @since BuddyPress (1.7.0)
     677                 * @since 1.7.0
    679678                 *
    680679                 * @param int $blog_id ID of the current blog in the loop.
     
    691690         * Filters the description of the current blog in the loop.
    692691         *
    693          * @since BuddyPress (1.2.0)
     692         * @since 1.2.0
    694693         *
    695694         * @param string $value Description of the current blog in the loop.
     
    708707                 * Filters the description of the current blog in the loop.
    709708                 *
    710                  * @since BuddyPress (1.0.0)
     709                 * @since 1.0.0
    711710                 *
    712711                 * @param string $value Description of the current blog in the loop.
     
    718717 * Output the row class of the current blog in the loop.
    719718 *
    720  * @since BuddyPress (1.7.0)
     719 * @since 1.7.0
    721720 *
    722721 * @param array $classes Array of custom classes
     
    728727         * Return the row class of the current blog in the loop.
    729728         *
    730          * @since BuddyPress (1.7.0)
     729         * @since 1.7.0
    731730         *
    732731         * @global BP_Blogs_Template $blogs_template
     
    751750                 * Filters the row class of the current blog in the loop.
    752751                 *
    753                  * @since BuddyPress (1.7.0)
     752                 * @since 1.7.0
    754753                 *
    755754                 * @param array $classes Array of classes to be applied to row.
     
    852851                                 * Filters the title text of the latest post for the current blog in loop.
    853852                                 *
    854                                  * @since BuddyPress (1.0.0)
     853                                 * @since 1.0.0
    855854                                 *
    856855                                 * @param string $retval Title of the latest post.
     
    867866                 * Filters the HTML markup result for the latest blog post in loop.
    868867                 *
    869                  * @since BuddyPress (1.2.0)
     868                 * @since 1.2.0
    870869                 *
    871870                 * @param string $retval HTML markup for the latest post.
     
    877876 * Output the title of the latest post on the current blog in the loop.
    878877 *
    879  * @since BuddyPress (1.7.0)
     878 * @since 1.7.0
    880879 *
    881880 * @see bp_get_blog_latest_post_title()
     
    887886         * Return the title of the latest post on the current blog in the loop.
    888887         *
    889          * @since BuddyPress (1.7.0)
     888         * @since 1.7.0
    890889         *
    891890         * @global BP_Blogs_Template
     
    904903                 * Filters the title text of the latest post on the current blog in the loop.
    905904                 *
    906                  * @since BuddyPress (1.7.0)
     905                 * @since 1.7.0
    907906                 *
    908907                 * @param string $retval Title text for the latest post.
     
    914913 * Output the permalink of the latest post on the current blog in the loop.
    915914 *
    916  * @since BuddyPress (1.7.0)
     915 * @since 1.7.0
    917916 *
    918917 * @see bp_get_blog_latest_post_title()
     
    924923         * Return the permalink of the latest post on the current blog in the loop.
    925924         *
    926          * @since BuddyPress (1.7.0)
     925         * @since 1.7.0
    927926         *
    928927         * @global BP_Blogs_Template
     
    941940                 * Filters the permalink of the latest post on the current blog in the loop.
    942941                 *
    943                  * @since BuddyPress (1.7.0)
     942                 * @since 1.7.0
    944943                 *
    945944                 * @param string $retval Permalink URL of the latest post.
     
    951950 * Output the content of the latest post on the current blog in the loop.
    952951 *
    953  * @since BuddyPress (1.7.0)
     952 * @since 1.7.0
    954953 *
    955954 * @uses bp_get_blog_latest_post_content()
     
    961960         * Return the content of the latest post on the current blog in the loop.
    962961         *
    963          * @since BuddyPress (1.7.0)
     962         * @since 1.7.0
    964963         *
    965964         * @global BP_Blogs_Template
     
    978977                 * Filters the content of the latest post on the current blog in the loop.
    979978                 *
    980                  * @since BuddyPress (1.7.0)
     979                 * @since 1.7.0
    981980                 *
    982981                 * @param string $retval Content of the latest post on the current blog in the loop.
     
    988987 * Output the featured image of the latest post on the current blog in the loop.
    989988 *
    990  * @since BuddyPress (1.7.0)
     989 * @since 1.7.0
    991990 *
    992991 * @see bp_get_blog_latest_post_content() For description of parameters.
     
    1000999         * Return the featured image of the latest post on the current blog in the loop.
    10011000         *
    1002          * @since BuddyPress (1.7.0)
     1001         * @since 1.7.0
    10031002         *
    10041003         * @global BP_Blogs_Template
     
    10201019                 * Filters the featured image of the latest post on the current blog in the loop.
    10211020                 *
    1022                  * @since BuddyPress (1.7.0)
     1021                 * @since 1.7.0
    10231022                 *
    10241023                 * @param string $retval The featured image of the latest post on the current blog in the loop.
     
    10301029 * Does the latest blog post have a featured image?
    10311030 *
    1032  * @since BuddyPress (1.7.0)
     1031 * @since 1.7.0
    10331032 *
    10341033 * @param string $thumbnail Image version to return. 'thumbnail', 'medium', 'large',
     
    10441043         * Filters whether or not the latest blog post has a featured image.
    10451044         *
    1046          * @since BuddyPress (1.7.0)
     1045         * @since 1.7.0
    10471046         *
    10481047         * @param bool   $value     Whether or not the latest blog post has a featured image.
     
    10871086                 * Filters the total number of blogs on the site.
    10881087                 *
    1089                  * @since BuddyPress (1.2.0)
     1088                 * @since 1.2.0
    10901089                 *
    10911090                 * @param int $value Total number of blogs on the site.
     
    11151114                 * Filters the total number of blogs for a given user.
    11161115                 *
    1117                  * @since BuddyPress (1.2.0)
     1116                 * @since 1.2.0
    11181117                 *
    11191118                 * @param int $value Total number of blogs for a given user.
     
    11441143         * Filters whether or not blog creation is enabled.
    11451144         *
    1146          * @since BuddyPress (1.0.0)
     1145         * @since 1.0.0
    11471146         *
    11481147         * @param string $active_signup Value of the registration site option creation status.
     
    11771176                 * Filters the default values for Blog name, title, and any current errors.
    11781177                 *
    1179                  * @since BuddyPress (1.0.0)
     1178                 * @since 1.0.0
    11801179                 *
    11811180                 * @param array $value {
     
    12061205                         * Fires after the default hidden fields in blog signup form markup.
    12071206                         *
    1208                          * @since BuddyPress (1.0.0)
     1207                         * @since 1.0.0
    12091208                         */
    12101209                        do_action( 'signup_hidden_fields' ); ?>
     
    12931292         * Fires at the end of all of the default input fields for blog creation form.
    12941293         *
    1295          * @since BuddyPress (1.0.0)
     1294         * @since 1.0.0
    12961295         *
    12971296         * @param WP_Error $errors WP_Error object if any present.
     
    13341333         * Filters the default values for Blog meta.
    13351334         *
    1336          * @since BuddyPress (1.0.0)
     1335         * @since 1.0.0
    13371336         *
    13381337         * @param array $meta {
     
    13911390         * Fires after the default successful blog registration message markup.
    13921391         *
    1393          * @since BuddyPress (1.0.0)
     1392         * @since 1.0.0
    13941393         */
    13951394        do_action('signup_finished');
     
    14121411         * Filters "Create a Site" links for users viewing their own profiles.
    14131412         *
    1414          * @since BuddyPress (1.0.0)
     1413         * @since 1.0.0
    14151414         *
    14161415         * @param string $value HTML link for creating a site.
     
    14421441         * Fires after the markup for the navigation tabs for a user Blogs page.
    14431442         *
    1444          * @since BuddyPress (1.0.0)
     1443         * @since 1.0.0
    14451444         */
    14461445        do_action( 'bp_blogs_blog_tabs' );
     
    14621461         * Filters the output for the blog directory search form.
    14631462         *
    1464          * @since BuddyPress (1.9.0)
     1463         * @since 1.9.0
    14651464         *
    14661465         * @param string $search_form_html HTML markup for blog directory search form.
     
    14721471 * Output the Create a Site button.
    14731472 *
    1474  * @since BuddyPress (2.0.0)
     1473 * @since 2.0.0
    14751474 */
    14761475function bp_blog_create_button() {
     
    14801479         * Get the Create a Site button.
    14811480         *
    1482          * @since BuddyPress (2.0.0)
     1481         * @since 2.0.0
    14831482         *
    14841483         * @return string
     
    15071506                 * Filters the Create a Site button.
    15081507                 *
    1509                  * @since BuddyPress (2.0.0)
     1508                 * @since 2.0.0
    15101509                 *
    15111510                 * @param array $button_args Array of arguments to be used for the Create a Site button.
     
    15171516 * Output the Create a Site nav item.
    15181517 *
    1519  * @since BuddyPress (2.2.0)
     1518 * @since 2.2.0
    15201519 */
    15211520function bp_blog_create_nav_item() {
     
    15261525         * Get the Create a Site nav item.
    15271526         *
    1528          * @since BuddyPress (2.2.0)
     1527         * @since 2.2.0
    15291528         *
    15301529         * @return string
     
    15481547 * if so, transform the title button into a Blogs directory nav item.
    15491548 *
    1550  * @since BuddyPress (2.2.0)
     1549 * @since 2.2.0
    15511550 *
    15521551 * @uses bp_blog_create_nav_item() to output the Create a Site nav item.
     
    16181617                 * Filters the button for visiting a blog in a loop.
    16191618                 *
    1620                  * @since BuddyPress (1.2.10)
     1619                 * @since 1.2.10
    16211620                 *
    16221621                 * @param array $button Array of arguments to be used for the button to visit a blog.
     
    16301629 * Display the number of blogs in user's profile.
    16311630 *
    1632  * @since BuddyPress (2.0.0)
     1631 * @since 2.0.0
    16331632 *
    16341633 * @uses bp_blogs_admin_get_profile_stats() to get the stats.
     
    16441643 * Return the number of blogs in user's profile.
    16451644 *
    1646  * @since BuddyPress (2.0.0)
     1645 * @since 2.0.0
    16471646 *
    16481647 * @param array|string $args before|after|user_id
     
    16801679         * Filters the number of blogs in user's profile.
    16811680         *
    1682          * @since BuddyPress (2.0.0)
     1681         * @since 2.0.0
    16831682         *
    16841683         * @param string $value Output determined for the profile stats.
Note: See TracChangeset for help on using the changeset viewer.