Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/25/2015 12:02:25 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Messages component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-messages/bp-messages-screens.php

    r10081 r10139  
    11<?php
    2 
    32/**
    43 * BuddyPress Messages Screens.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    1817 * Load the Messages > Inbox screen.
    1918 *
    20  * @since BuddyPress (1.0.0)
     19 * @since 1.0.0
    2120 */
    2221function messages_screen_inbox() {
     
    3029     * Fires right before the loading of the Messages inbox screen template file.
    3130     *
    32      * @since BuddyPress (1.0.0)
     31     * @since 1.0.0
    3332     */
    3433    do_action( 'messages_screen_inbox' );
     
    3736     * Filters the template to load for the Messages inbox screen.
    3837     *
    39      * @since BuddyPress (1.0.0)
     38     * @since 1.0.0
    4039     *
    4140     * @param string $template Path to the messages template to load.
     
    4746 * Load the Messages > Sent screen.
    4847 *
    49  * @since BuddyPress (1.0.0)
     48 * @since 1.0.0
    5049 */
    5150function messages_screen_sentbox() {
     
    5958     * Fires right before the loading of the Messages sentbox screen template file.
    6059     *
    61      * @since BuddyPress (1.0.0)
     60     * @since 1.0.0
    6261     */
    6362    do_action( 'messages_screen_sentbox' );
     
    6665     * Filters the template to load for the Messages sentbox screen.
    6766     *
    68      * @since BuddyPress (1.0.0)
     67     * @since 1.0.0
    6968     *
    7069     * @param string $template Path to the messages template to load.
     
    7675 * Load the Messages > Compose screen.
    7776 *
    78  * @since BuddyPress (1.0.0)
     77 * @since 1.0.0
    7978 */
    8079function messages_screen_compose() {
     
    9190     * Fires right before the loading of the Messages compose screen template file.
    9291     *
    93      * @since BuddyPress (1.0.0)
     92     * @since 1.0.0
    9493     */
    9594    do_action( 'messages_screen_compose' );
     
    9897     * Filters the template to load for the Messages compose screen.
    9998     *
    100      * @since BuddyPress (1.0.0)
     99     * @since 1.0.0
    101100     *
    102101     * @param string $template Path to the messages template to load.
     
    108107 * Load an individual conversation screen.
    109108 *
    110  * @since BuddyPress (1.0.0)
     109 * @since 1.0.0
    111110 *
    112111 * @return bool|null False on failure.
     
    134133     * Fires right before the loading of the Messages view screen template file.
    135134     *
    136      * @since BuddyPress (1.7.0)
     135     * @since 1.7.0
    137136     */
    138137    do_action( 'messages_screen_conversation' );
     
    141140     * Filters the template to load for the Messages view screen.
    142141     *
    143      * @since BuddyPress (1.0.0)
     142     * @since 1.0.0
    144143     *
    145144     * @param string $template Path to the messages template to load.
     
    152151 * Load the Messages > Notices screen.
    153152 *
    154  * @since BuddyPress (1.0.0)
     153 * @since 1.0.0
    155154 *
    156155 * @return false|null False on failure.
     
    166165     * Fires right before the loading of the Messages notices screen template file.
    167166     *
    168      * @since BuddyPress (1.0.0)
     167     * @since 1.0.0
    169168     */
    170169    do_action( 'messages_screen_notices' );
     
    173172     * Filters the template to load for the Messages notices screen.
    174173     *
    175      * @since BuddyPress (1.0.0)
     174     * @since 1.0.0
    176175     *
    177176     * @param string $template Path to the messages template to load.
     
    183182 * Render the markup for the Messages section of Settings > Notifications.
    184183 *
    185  * @since BuddyPress (1.0.0)
     184 * @since 1.0.0
    186185 */
    187186function messages_screen_notification_settings() {
     
    219218             * Fires inside the closing </tbody> tag for messages screen notification settings.
    220219             *
    221              * @since BuddyPress (1.0.0)
     220             * @since 1.0.0
    222221             */
    223222            do_action( 'messages_screen_notification_settings' ); ?>
Note: See TracChangeset for help on using the changeset viewer.