Skip to:
Content

BuddyPress.org


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

Templates, Nouveau: fix @since PHPDoc.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-templates/bp-nouveau/includes/members/template-tags.php

    r11856 r11899  
    33 * Members template tags
    44 *
    5  * @since 1.0.0
     5 * @since 3.0.0
    66 */
    77
     
    1313 * before the members directory content
    1414 *
    15  * @since 1.0.0
     15 * @since 3.0.0
    1616 */
    1717function bp_nouveau_before_members_directory_content() {
     
    4949 * after the members directory content
    5050 *
    51  * @since 1.0.0
     51 * @since 3.0.0
    5252 */
    5353function bp_nouveau_after_members_directory_content() {
     
    8484 * Fire specific hooks into the single members templates
    8585 *
    86  * @since 1.0.0
    87  * @since 1.2.0 (BuddyPress) for the 'activity_content', 'blogs_content', 'header_meta',
    88  *                           'friends_content', 'groups_content', 'home_content', 'plugin_template'
    89  *                           'friend_requests_content' suffixes.
    90  * @since 1.5.0 (BuddyPress) for the 'settings_template' suffix.
    91  *
    92  * @param string $when    'before' or 'after'
    93  * @param string $suffix  Use it to add terms at the end of the hook name
     86 * @since 3.0.0
     87 *
     88 * @param string $when   'before' or 'after'
     89 * @param string $suffix Use it to add terms at the end of the hook name
    9490 */
    9591function bp_nouveau_member_hook( $when = '', $suffix = '' ) {
     
    113109 * Template tag to wrap the notification settings hook
    114110 *
    115  * @since 1.0.0
     111 * @since 3.0.0
    116112 */
    117113function bp_nouveau_member_email_notice_settings() {
     
    127123 * Output the action buttons for the displayed user profile
    128124 *
    129  * @since 1.0.0
     125 * @since 3.0.0
    130126 *
    131127 * @param array $args See bp_nouveau_wrapper() for the description of parameters.
     
    176172 * Output the action buttons in member loops
    177173 *
    178  * @since 1.0.0
     174 * @since 3.0.0
    179175 *
    180176 * @param array $args See bp_nouveau_wrapper() for the description of parameters.
     
    219215     * Get the action buttons for the displayed user profile
    220216     *
    221      * @since 1.0.0
     217     * @since 3.0.0
    222218     *
    223219     * @return array
     
    477473         * Filter to add your buttons, use the position argument to choose where to insert it.
    478474         *
    479          * @since 1.0.0
     475         * @since 3.0.0
    480476         *
    481477         * @param array  $buttons The list of buttons.
     
    508504         * Leave a chance to adjust the $return
    509505         *
    510          * @since 1.0.0
     506         * @since 3.0.0
    511507         *
    512508         * @param array  $return  The list of buttons ordered.
     
    522518 * Does the member has meta.
    523519 *
    524  * @since 1.0.0
     520 * @since 3.0.0
    525521 *
    526522 * @return bool True if the member has meta. False otherwise.
     
    533529 * Display the member meta.
    534530 *
    535  * @since 1.0.0
     531 * @since 3.0.0
    536532 *
    537533 * @return string HTML Output.
     
    544540     * Get the member meta.
    545541     *
    546      * @since 1.0.0
     542     * @since 3.0.0
    547543     *
    548544     * @return array The member meta.
     
    588584             * Filter to add/remove Member meta.
    589585             *
    590              * @since 1.0.0
     586             * @since 3.0.0
    591587             *
    592588             * @param array  $meta    The list of meta to output.
     
    603599 * Load the appropriate content for the single member pages
    604600 *
    605  * @since 1.0.0
     601 * @since 3.0.0
    606602 */
    607603function bp_nouveau_member_template_part() {
     
    651647 * Use the appropriate Member header and enjoy a template hierarchy
    652648 *
    653  * @since 1.0.0
     649 * @since 3.0.0
    654650 *
    655651 * @return string HTML Output
     
    686682 * reach the Customizer section where it's possible to do it.
    687683 *
    688  * @since 1.0.0
     684 * @since 3.0.0
    689685 *
    690686 * @return string HTML Output
     
    704700 * reach the Customizer section where it's possible to do it.
    705701 *
    706  * @since 1.0.0
     702 * @since 3.0.0
    707703 *
    708704 * @return string HTML Output
     
    721717 * Display the Member description making sure linefeeds are taking in account
    722718 *
    723  * @since 1.0.0
     719 * @since 3.0.0
    724720 *
    725721 * @param int $user_id Optional.
     
    757753 * Display the Edit profile link (temporary).
    758754 *
    759  * @since 1.0.0
     755 * @since 3.0.0
    760756 *
    761757 * @todo replace with Ajax feature
     
    771767     * @todo  replace with Ajax featur
    772768     *
    773      * @since 1.0.0
     769     * @since 3.0.0
    774770     *
    775771     * @return string HTML Output
     
    797793 * before and after the WP User's Profile.
    798794 *
    799  * @since 1.0.0
     795 * @since 3.0.0
    800796 */
    801797function bp_nouveau_wp_profile_hooks( $type = 'before' ) {
     
    841837 * Does the displayed user has WP profile fields?
    842838 *
    843  * @since 1.0.0
     839 * @since 3.0.0
    844840 *
    845841 * @return bool True if user has profile fields. False otherwise.
     
    886882 * Check if there are still profile fields to output.
    887883 *
    888  * @since 1.0.0
     884 * @since 3.0.0
    889885 *
    890886 * @return bool True if the profile field exists. False otherwise.
     
    906902 * Set the current profile field and iterate into the loop.
    907903 *
    908  * @since 1.0.0
     904 * @since 3.0.0
    909905 */
    910906function bp_nouveau_wp_profile_field() {
     
    918914 * Output the WP profile field ID.
    919915 *
    920  * @since 1.0.0
     916 * @since 3.0.0
    921917 */
    922918function bp_nouveau_wp_profile_field_id() {
     
    926922     * Get the WP profile field ID.
    927923     *
    928      * @since 1.0.0
     924     * @since 3.0.0
    929925     *
    930926     * @return int the profile field ID.
     
    938934 * Output the WP profile field label.
    939935 *
    940  * @since 1.0.0
     936 * @since 3.0.0
    941937 */
    942938function bp_nouveau_wp_profile_field_label() {
     
    947943     * Get the WP profile label.
    948944     *
    949      * @since 1.0.0
     945     * @since 3.0.0
    950946     *
    951947     * @return string the profile field label.
     
    959955 * Output the WP profile field data.
    960956 *
    961  * @since 1.0.0
     957 * @since 3.0.0
    962958 */
    963959function bp_nouveau_wp_profile_field_data() {
     
    984980     * Get the WP profile field data.
    985981     *
    986      * @since 1.0.0
     982     * @since 3.0.0
    987983     *
    988984     * @return string the profile field data.
Note: See TracChangeset for help on using the changeset viewer.