Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 06:04:27 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Templates Component.

Fixes #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-templates/bp-legacy/buddypress-functions.php

    r10048 r10150  
    11<?php
    2 
    32/**
    43 * Functions of BuddyPress's Legacy theme
     4 *
     5 * @since 1.7.0
    56 *
    67 * @package BuddyPress
    78 * @subpackage BP_Theme_Compat
    8  * @since BuddyPress (1.7)
    9  */
    10 
    11 // Exit if accessed directly
     9 */
     10
     11// Exit if accessed directly.
    1212defined( 'ABSPATH' ) || exit;
    1313
     
    2828 * See @link BP_Theme_Compat() for more.
    2929 *
    30  * @since BuddyPress (1.7)
     30 * @since 1.7.0
    3131 *
    3232 * @package BuddyPress
     
    4040     * The main BuddyPress (Legacy) Loader
    4141     *
    42      * @since BuddyPress (1.7)
     42     * @since 1.7.0
    4343     *
    4444     * @uses BP_Legacy::setup_globals()
     
    5555     * needs are.
    5656     *
    57      * @since BuddyPress (1.7)
     57     * @since 1.7.0
    5858     * @access private
    5959     */
     
    7070     * Setup the theme hooks
    7171     *
    72      * @since BuddyPress (1.7)
     72     * @since 1.7.0
    7373     * @access private
    7474     *
     
    201201         * Fires after all of the BuddyPress theme compat actions have been added.
    202202         *
    203          * @since BuddyPress (1.7.0)
     203         * @since 1.7.0
    204204         *
    205205         * @param BP_Legacy $this Current BP_Legacy instance.
     
    211211     * Load the theme CSS
    212212     *
    213      * @since BuddyPress (1.7)
    214      * @since BuddyPress (2.3.0) Support custom CSS file named after the current theme or parent theme.
     213     * @since 1.7.0
     214     * @since 2.3.0 Support custom CSS file named after the current theme or parent theme.
    215215     *
    216216     * @uses wp_enqueue_style() To enqueue the styles
     
    275275     * Enqueue the required JavaScript files
    276276     *
    277      * @since BuddyPress (1.7)
     277     * @since 1.7.0
    278278     */
    279279    public function enqueue_scripts() {
     
    292292         * Filters core JavaScript strings for internationalization before AJAX usage.
    293293         *
    294          * @since BuddyPress (2.0.0)
     294         * @since 2.0.0
    295295         *
    296296         * @param array $value Array of key/value pairs for AJAX usage.
     
    372372     * and theme authors should not attempt to use what follows.
    373373     *
    374      * @since BuddyPress (1.8)
     374     * @since 1.8.0
    375375     * @access private
    376376     * @param string $file A filename like buddypress.css
     
    436436     * Put some scripts in the header, like AJAX url for wp-lists
    437437     *
    438      * @since BuddyPress (1.7)
     438     * @since 1.7.0
    439439     */
    440440    public function head_scripts() {
     
    459459     * The no-js class is removed by the JavaScript created in buddypress.js.
    460460     *
    461      * @since BuddyPress (1.7)
     461     * @since 1.7.0
    462462     */
    463463    public function add_nojs_body_class( $classes ) {
     
    473473     * These localizations require information that may not be loaded even by init.
    474474     *
    475      * @since BuddyPress (1.7)
     475     * @since 1.7.0
    476476     */
    477477    public function localize_scripts() {
     
    481481     * Outputs sitewide notices markup in the footer.
    482482     *
    483      * @since BuddyPress (1.7)
     483     * @since 1.7.0
    484484     *
    485485     * @see https://buddypress.trac.wordpress.org/ticket/4802
     
    501501     * Add secondary avatar image to this activity stream's record, if supported.
    502502     *
    503      * @since BuddyPress (1.7)
     503     * @since 1.7.0
    504504     *
    505505     * @param string $action The text of this activity
     
    530530     * @see https://buddypress.trac.wordpress.org/ticket/6065
    531531     *
    532      * @since BuddyPress (2.2.0)
     532     * @since 2.2.0
    533533     *
    534534     * @param  array $templates
     
    542542         * Filters whether or not we are looking at a directory to determine if to return early.
    543543         *
    544          * @since BuddyPress (2.2.0)
     544         * @since 2.2.0
    545545         *
    546546         * @param bool $value Whether or not we are viewing a directory.
     
    608608 * the behavior of bp-default.
    609609 *
    610  * @since BuddyPress (2.0.0)
     610 * @since 2.0.0
    611611 * @todo Deprecate
    612612 *
     
    624624 * the Groups directory navigation.
    625625 *
    626  * @since BuddyPress (2.2.0)
     626 * @since 2.2.0
    627627 *
    628628 * @uses   bp_group_create_nav_item() to output the create a Group nav item
     
    639639 * the behavior of bp-default.
    640640 *
    641  * @since BuddyPress (2.0.0)
     641 * @since 2.0.0
    642642 * @todo Deprecate
    643643 *
     
    655655 * the Sites directory navigation.
    656656 *
    657  * @since BuddyPress (2.2.0)
     657 * @since 2.2.0
    658658 *
    659659 * @uses   bp_blog_create_nav_item() to output the Create a Site nav item
     
    678678 *
    679679 * @return string Query string for the component loops
    680  * @since BuddyPress (1.2)
     680 * @since 1.2.0
    681681 */
    682682function bp_legacy_theme_ajax_querystring( $query_string, $object ) {
     
    760760     * Filters the AJAX query string for the component loops.
    761761     *
    762      * @since BuddyPress (1.7.0)
     762     * @since 1.7.0
    763763     *
    764764     * @param string $query_string        The query string we are working with.
     
    777777 *
    778778 * @return string Prints template loop for the specified object
    779  * @since BuddyPress (1.2)
     779 * @since 1.2.0
    780780 */
    781781function bp_legacy_theme_object_template_loader() {
     
    820820 *
    821821 * @return string Prints template loop for the Messages component
    822  * @since BuddyPress (1.6)
     822 * @since 1.6.0
    823823 */
    824824function bp_legacy_theme_messages_template_loader() {
     
    830830 * Load group invitations loop to handle pagination requests sent via AJAX.
    831831 *
    832  * @since BuddyPress (2.0.0)
     832 * @since 2.0.0
    833833 */
    834834function bp_legacy_theme_invite_template_loader() {
     
    840840 * Load group membership requests loop to handle pagination requests sent via AJAX.
    841841 *
    842  * @since BuddyPress (2.0.0)
     842 * @since 2.0.0
    843843 */
    844844function bp_legacy_theme_requests_template_loader() {
     
    853853 * for the Activity component) and 'feed_url' (URL to the relevant RSS feed).
    854854 *
    855  * @since BuddyPress (1.2)
     855 * @since 1.2.0
    856856 */
    857857function bp_legacy_theme_activity_template_loader() {
     
    892892     * Filters the feed URL for when activity is requested via AJAX.
    893893     *
    894      * @since BuddyPress (1.7.0)
     894     * @since 1.7.0
    895895     *
    896896     * @param string $feed_url URL for the feed to be used.
     
    907907 *
    908908 * @return string HTML
    909  * @since BuddyPress (1.2)
     909 * @since 1.2.0
    910910 */
    911911function bp_legacy_theme_post_update() {
     
    970970 * @global BP_Activity_Template $activities_template
    971971 * @return string HTML
    972  * @since BuddyPress (1.2)
     972 * @since 1.2.0
    973973 */
    974974function bp_legacy_theme_new_activity_comment() {
     
    10461046 *
    10471047 * @return mixed String on error, void on success
    1048  * @since BuddyPress (1.2)
     1048 * @since 1.2.0
    10491049 */
    10501050function bp_legacy_theme_delete_activity() {
     
    10831083 *
    10841084 * @return mixed String on error, void on success
    1085  * @since BuddyPress (1.2)
     1085 * @since 1.2.0
    10861086 */
    10871087function bp_legacy_theme_delete_activity_comment() {
     
    11201120 *
    11211121 * @return mixed String on error, void on success
    1122  * @since BuddyPress (1.6)
     1122 * @since 1.6.0
    11231123 */
    11241124function bp_legacy_theme_spam_activity() {
     
    11651165 *
    11661166 * @return string HTML
    1167  * @since BuddyPress (1.2)
     1167 * @since 1.2.0
    11681168 */
    11691169function bp_legacy_theme_mark_activity_favorite() {
     
    11841184 *
    11851185 * @return string HTML
    1186  * @since BuddyPress (1.2)
     1186 * @since 1.2.0
    11871187 */
    11881188function bp_legacy_theme_unmark_activity_favorite() {
     
    12041204 *
    12051205 * @return string HTML
    1206  * @since BuddyPress (1.5)
     1206 * @since 1.5.0
    12071207 */
    12081208function bp_legacy_theme_get_single_activity_content() {
     
    12241224     * Fires before the return of an activity's full, non-excerpted content via a POST request.
    12251225     *
    1226      * @since BuddyPress (1.7.0)
     1226     * @since 1.7.0
    12271227     *
    12281228     * @param string $activity Activity content. Passed by reference.
     
    12421242 * Invites a friend to join a group via a POST request.
    12431243 *
    1244  * @since BuddyPress (1.2)
     1244 * @since 1.2.0
    12451245 * @todo Audit return types
    12461246 */
     
    13251325 *
    13261326 * @return string HTML
    1327  * @since BuddyPress (1.2)
     1327 * @since 1.2.0
    13281328 */
    13291329function bp_legacy_theme_ajax_addremove_friend() {
     
    13781378 *
    13791379 * @return mixed String on error, void on success
    1380  * @since BuddyPress (1.2)
     1380 * @since 1.2.0
    13811381 */
    13821382function bp_legacy_theme_ajax_accept_friendship() {
     
    13971397 *
    13981398 * @return mixed String on error, void on success
    1399  * @since BuddyPress (1.2)
     1399 * @since 1.2.0
    14001400 */
    14011401function bp_legacy_theme_ajax_reject_friendship() {
     
    14161416 *
    14171417 * @return string HTML
    1418  * @since BuddyPress (1.2)
     1418 * @since 1.2.0
    14191419 */
    14201420function bp_legacy_theme_ajax_joinleave_group() {
     
    14861486 *
    14871487 * @return mixed String on error, void on success
    1488  * @since BuddyPress (1.2)
     1488 * @since 1.2.0
    14891489 */
    14901490function bp_legacy_theme_ajax_close_notice() {
     
    15111511 *
    15121512 * @return string HTML
    1513  * @since BuddyPress (1.2)
     1513 * @since 1.2.0
    15141514 */
    15151515function bp_legacy_theme_ajax_messages_send_reply() {
     
    15661566 *
    15671567 * @return mixed String on error, void on success
    1568  * @since BuddyPress (1.2)
     1568 * @since 1.2.0
    15691569 */
    15701570function bp_legacy_theme_ajax_message_markunread() {
     
    15911591 *
    15921592 * @return mixed String on error, void on success
    1593  * @since BuddyPress (1.2)
     1593 * @since 1.2.0
    15941594 */
    15951595function bp_legacy_theme_ajax_message_markread() {
     
    16161616 *
    16171617 * @return string HTML
    1618  * @since BuddyPress (1.2)
     1618 * @since 1.2.0
    16191619 */
    16201620function bp_legacy_theme_ajax_messages_delete() {
     
    16411641 * Displays friends only, unless BP_MESSAGES_AUTOCOMPLETE_ALL is defined.
    16421642 *
    1643  * @since BuddyPress (1.2.0)
     1643 * @since 1.2.0
    16441644 *
    16451645 * @return string HTML.
     
    16501650     * Filters the max results default value for ajax messages autocomplete results.
    16511651     *
    1652      * @since BuddyPress (1.5.0)
     1652     * @since 1.5.0
    16531653     *
    16541654     * @param int $value Max results for autocomplete. Default 10.
     
    16911691 * AJAX callback to set a message's star status.
    16921692 *
    1693  * @since BuddyPress (2.3.0)
     1693 * @since 2.3.0
    16941694 */
    16951695function bp_legacy_theme_ajax_messages_star_handler() {
Note: See TracChangeset for help on using the changeset viewer.