Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/18/2018 09:56:44 PM (4 years ago)
Author:
djpaul
Message:

Templates, Nouveau: fix @since PHPDoc.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-templates/bp-nouveau/includes/groups/functions.php

    r11855 r11899  
    33 * Groups functions
    44 *
    5  * @since 1.0.0
     5 * @since 3.0.0
    66 */
    77
     
    3232 * Register Scripts for the Groups component
    3333 *
    34  * @since 1.0.0
     34 * @since 3.0.0
    3535 *
    3636 * @param  array  $scripts  The array of scripts to register
     
    5454 * Enqueue the groups scripts
    5555 *
    56  * @since 1.0.0
     56 * @since 3.0.0
    5757 */
    5858function bp_nouveau_groups_enqueue_scripts() {
     
    7777 * Can all members be invited to join any group?
    7878 *
    79  * @since 1.0.0
     79 * @since 3.0.0
    8080 *
    8181 * @param bool $default False to allow. True to disallow.
     
    8787     * Filter to remove the All members nav, returning true
    8888     *
    89      * @since 1.0.0
     89     * @since 3.0.0
    9090     *
    9191     * @param bool $default True to disable the nav. False otherwise.
     
    9797 * Localize the strings needed for the Group's Invite UI
    9898 *
    99  * @since 1.0.0
     99 * @since 3.0.0
    100100 *
    101101 * @param array $params Associative array containing the JS Strings needed by scripts
     
    143143
    144144/**
    145  * @since 1.0.0
     145 * @since 3.0.0
    146146 */
    147147function bp_nouveau_groups_get_inviter_ids( $user_id, $group_id ) {
     
    154154
    155155/**
    156  * @since 1.0.0
     156 * @since 3.0.0
    157157 */
    158158function bp_nouveau_prepare_group_potential_invites_for_js( $user ) {
     
    211211
    212212/**
    213  * @since 1.0.0
     213 * @since 3.0.0
    214214 */
    215215function bp_nouveau_get_group_potential_invites( $args = array() ) {
     
    264264
    265265/**
    266  * @since 1.0.0
     266 * @since 3.0.0
    267267 * @todo I don't see any reason why to restrict group invites to friends..
    268268 */
     
    284284
    285285/**
    286  * @since 1.0.0
     286 * @since 3.0.0
    287287 */
    288288function bp_nouveau_group_setup_nav() {
     
    321321
    322322/**
    323  * @since 1.0.0
     323 * @since 3.0.0
    324324 */
    325325function bp_nouveau_groups_invites_custom_message( $message = '' ) {
     
    346346 * Format a Group for a json reply
    347347 *
    348  * @since 1.0.0
     348 * @since 3.0.0
    349349 */
    350350function bp_nouveau_prepare_group_for_js( $item ) {
     
    372372 * Group invites restriction settings navigation.
    373373 *
    374  * @since 1.0.0
     374 * @since 3.0.0
    375375 */
    376376function bp_nouveau_groups_invites_restriction_nav() {
     
    397397 * Group invites restriction settings Admin Bar navigation.
    398398 *
    399  * @since 1.0.0
     399 * @since 3.0.0
    400400 *
    401401 * @param array $wp_admin_nav The list of settings admin subnav items.
     
    421421 * Group invites restriction screen.
    422422 *
    423  * @since 1.0.0
     423 * @since 3.0.0
    424424 */
    425425function bp_nouveau_groups_screen_invites_restriction() {
     
    452452     * Filters the template to load for the Group Invites settings screen.
    453453     *
    454      * @since 1.0.0
     454     * @since 3.0.0
    455455     *
    456456     * @param string $template Path to the Group Invites settings screen template to load.
     
    460460
    461461/**
    462  * @since 1.0.0
     462 * @since 3.0.0
    463463 */
    464464function bp_nouveau_get_groups_directory_nav_items() {
     
    516516     * Use this filter to introduce your custom nav items for the groups directory.
    517517     *
    518      * @since 1.0.0
     518     * @since 3.0.0
    519519     *
    520520     * @param  array $nav_items The list of the groups directory nav items.
     
    526526 * Get Dropdown filters for the groups component
    527527 *
    528  * @since 1.0.0
     528 * @since 3.0.0
    529529 *
    530530 * @param string $context 'directory' or 'user'
     
    548548     * or 'bp_groups_directory_order_options'
    549549     *
    550      * @since 1.0.0
     550     * @since 3.0.0
    551551     *
    552552     * @param array  the members filters.
     
    570570 * Catch the arguments for buttons
    571571 *
    572  * @since 1.0.0
     572 * @since 3.0.0
    573573 *
    574574 * @param array $button The arguments of the button that BuddyPress is about to create.
     
    590590 * Catch the content hooked to the 'bp_group_header_meta' action
    591591 *
    592  * @since 1.0.0
     592 * @since 3.0.0
    593593 *
    594594 * @return string|bool HTML Output if hooked. False otherwise.
     
    616616 * Display the Widgets of Group extensions into the default front page?
    617617 *
    618  * @since 1.0.0
     618 * @since 3.0.0
    619619 *
    620620 * @return bool True to display. False otherwise.
     
    629629 * Display description of the Group into the default front page?
    630630 *
    631  * @since 1.0.0
     631 * @since 3.0.0
    632632 *
    633633 * @return bool True to display. False otherwise.
     
    646646 * Add sections to the customizer for the groups component.
    647647 *
    648  * @since 1.0.0
     648 * @since 3.0.0
    649649 *
    650650 * @param array $sections the Customizer sections to add.
     
    672672 * Add settings to the customizer for the groups component.
    673673 *
    674  * @since 1.0.0
     674 * @since 3.0.0
    675675 *
    676676 * @param array $settings the settings to add.
     
    749749 * Add controls for the settings of the customizer for the groups component.
    750750 *
    751  * @since 1.0.0
     751 * @since 3.0.0
    752752 *
    753753 * @param array $controls the controls to add.
     
    819819 * Add the default group front template to the front template hierarchy.
    820820 *
    821  * @since 1.0.0
     821 * @since 3.0.0
    822822 *
    823823 * @param array           $templates The list of templates for the front.php template part.
     
    848848 * Locate a single group template into a specific hierarchy.
    849849 *
    850  * @since 1.0.0
     850 * @since 3.0.0
    851851 *
    852852 * @param string $template The template part to get (eg: activity, members...).
     
    901901 * Load a single group template part
    902902 *
    903  * @since 1.0.0
     903 * @since 3.0.0
    904904 *
    905905 * @param string $template The template part to get (eg: activity, members...).
     
    931931 * Are we inside the Current group's default front page sidebar?
    932932 *
    933  * @since 1.0.0
     933 * @since 3.0.0
    934934 *
    935935 * @return bool True if in the group's home sidebar. False otherwise.
     
    942942 * Filter the Latest activities Widget to only keep the one of the group displayed
    943943 *
    944  * @since 1.0.0
     944 * @since 3.0.0
    945945 *
    946946 * @param array $args The Activities Template arguments.
     
    958958 * Filter the Groups widget to only keep the displayed group.
    959959 *
    960  * @since 1.0.0
     960 * @since 3.0.0
    961961 *
    962962 * @param array $args The Groups Template arguments.
     
    973973 * Filter the Members widgets to only keep members of the displayed group.
    974974 *
    975  * @since 1.0.0
     975 * @since 3.0.0
    976976 *
    977977 * @param array $args The Members Template arguments.
     
    994994 * Init the Group's default front page filters as we're in the sidebar
    995995 *
    996  * @since 1.0.0
     996 * @since 3.0.0
    997997 */
    998998function bp_nouveau_groups_add_home_widget_filters() {
     
    10071007 * Remove the Group's default front page filters as we're no more in the sidebar
    10081008 *
    1009  * @since 1.0.0
     1009 * @since 3.0.0
    10101010 */
    10111011function bp_nouveau_groups_remove_home_widget_filters() {
     
    10201020 * Get the hook, nonce, and eventually a specific template for Core Group's create screens.
    10211021 *
    1022  * @since 1.0.0
     1022 * @since 3.0.0
    10231023 *
    10241024 * @param string $id The screen id
     
    10471047 * Get the hook and nonce for Core Group's manage screens.
    10481048 *
    1049  * @since 1.0.0
     1049 * @since 3.0.0
    10501050 *
    10511051 * @param string $id The screen id
     
    10761076 * Register notifications filters for the groups component.
    10771077 *
    1078  * @since 1.0.0
     1078 * @since 3.0.0
    10791079 */
    10801080function bp_nouveau_groups_notification_filters() {
Note: See TracChangeset for help on using the changeset viewer.