diff --git a/templates/profile.php b/templates/profile.php index de84b96a..8c1af9e4 100644 --- a/templates/profile.php +++ b/templates/profile.php @@ -6,7 +6,7 @@ * * Page: "Profile" * - * @version 2.6.9 + * @version 2.9.3 * * @var string $mode * @var int $form_id @@ -17,200 +17,227 @@ if ( ! defined( 'ABSPATH' ) ) { } $description_key = UM()->profile()->get_show_bio_key( $args ); ?> - -
- -
- +
+
Callback name -> Excerpt): + * 10 - `um_profile_completeness_show_notice()` displays Profile Completeness notices. + * + * @param {array} $args User Profile data. + * + * @since 1.3.x + * @hook um_profile_before_header + * + * @example Display some content before User Profile. + * function my_um_profile_before_header( $args ) { * // your code here + * echo $notice; * } - * ?> + * add_action( 'um_profile_before_header', 'my_um_profile_before_header' ); */ do_action( 'um_profile_before_header', $args ); - if ( um_is_on_edit_profile() ) { ?> + if ( um_is_on_edit_profile() ) { + ?>
- Callback name -> Excerpt): + * 9 - `um_profile_header_cover_area()` displays User Profile cover photo. + * + * @param {array} $args User Profile data. + * + * @since 1.3.x + * @hook um_profile_header_cover_area + * + * @example Display some content before or after User Profile cover. + * function my_um_profile_header_cover_area( $args ) { * // your code here + * echo $content; * } - * ?> + * add_action( 'um_profile_header_cover_area', 'my_um_profile_header_cover_area' ); */ do_action( 'um_profile_header_cover_area', $args ); - /** - * UM hook + * Fires for displaying User Profile header. * - * @type action - * @title um_profile_header - * @description Profile header area - * @input_vars - * [{"var":"$args","type":"array","desc":"Profile form shortcode arguments"}] - * @change_log - * ["Since: 2.0"] - * @usage add_action( 'um_profile_header', 'function_name', 10, 1 ); - * @example - * Callback name -> Excerpt): + * 9 - `um_profile_header()` displays User Profile header. + * + * @param {array} $args User Profile data. + * + * @since 1.3.x + * @hook um_profile_header + * + * @example Display some content before or after User Profile header. + * function my_um_profile_header( $args ) { * // your code here + * echo $content; * } - * ?> + * add_action( 'um_profile_header', 'my_um_profile_header' ); */ do_action( 'um_profile_header', $args ); - /** - * UM hook + * Filters classes of the User Profile navigation bar. * - * @type filter - * @title um_profile_navbar_classes - * @description Additional classes for profile navbar - * @input_vars - * [{"var":"$classes","type":"string","desc":"UM Posts Tab query"}] - * @change_log - * ["Since: 2.0"] - * @usage - * - * @example - * Callback name -> Excerpt): + * 10 - `um_followers_profile_navbar_classes()` from Followers extension class. + * 10 - `profile_navbar_classes()` from Messaging extension class. + * + * @param {string} $classes User Profile navigation bar classes. + * + * @since 2.0 + * @hook um_profile_navbar_classes + * + * @return {string} User Profile navigation bar classes. + * + * @example Adds `my_custom_class` class to the navigation bar on the User Profile page. + * function my_um_profile_navbar_classes( $classes ) { * // your code here - * return $classes; + * $classes .= ' my_custom_class'; + * echo $classes; * } - * ?> + * add_filter( 'um_profile_navbar_classes', 'my_um_profile_navbar_classes' ); */ - $classes = apply_filters( 'um_profile_navbar_classes', '' ); ?> + $classes = apply_filters( 'um_profile_navbar_classes', '' ); + ?>
Callback name -> Excerpt): + * 4 - `um_followers_add_profile_bar()` displays Followers button. + * 5 - `add_profile_bar()` displays Messaging button. + * + * @param {array} $args User Profile data. + * + * @since 1.3.x + * @hook um_profile_navbar + * + * @example Display some content before or after User Profile navigation bar. + * function my_um_profile_navbar( $args ) { * // your code here + * echo $content; * } - * ?> + * add_action( 'um_profile_navbar', 'my_um_profile_navbar' ); */ - do_action( 'um_profile_navbar', $args ); ?> + do_action( 'um_profile_navbar', $args ); + ?>
Callback name -> Excerpt): + * 9 - `um_profile_menu()` displays User Profile menu. + * + * @param {array} $args User Profile data. + * + * @since 2.0 + * @hook um_profile_menu + * + * @example Display some content before or after User Profile menu. + * function my_um_profile_menu( $args ) { * // your code here + * echo $content; * } - * ?> + * add_action( 'um_profile_menu', 'my_um_profile_menu' ); */ do_action( 'um_profile_menu', $args ); if ( um_is_on_edit_profile() || UM()->user()->preview ) { - - $nav = 'main'; + $nav = 'main'; $subnav = UM()->profile()->active_subnav(); - $subnav = ! empty( $subnav ) ? $subnav : 'default'; ?> - + $subnav = ! empty( $subnav ) ? $subnav : 'default'; + ?>
- Callback name -> Excerpt): + * 10 - `um_profile_content_main()` displays `About` menu tab's content (v2). + * 10 - `UM()->frontend()->profile()->about()` displays `About` menu tab's content (v3). + * 10 - `um_profile_content_followers()` displays `Followers` menu tab's content. + * 10 - `um_profile_content_following()` displays `Following` menu tab's content. + * 10 - `um_profile_content_groups_list()` displays `User Groups List` menu tab's content. + * 10 - `profile_tab_content()` displays `My Jobs` menu tab's content. + * 10 - `profile_tab_dashboard_content()` displays `My Jobs Dashboard` menu tab's content. + * 10 - `content_messages()` displays `Messages` menu tab's content. + * 10 - `um_profile_content_private_content()` displays `Private Content` menu tab's content. + * 10 - `um_profile_content_{$tab['tabid']}` displays custom Profile Tabs content. + * 10 - `um_profile_content_reviews()` displays `Reviews` menu tab's content. + * 10 - `show_wall()` displays `Activity` menu tab's content. + * + * @param {array} $args User Profile data. + * + * @since 1.3.x + * @hook um_profile_content_{$nav} + * + * @example Display some content in User Profile `main` nav content tab. + * function my_profile_content_main( $args ) { * // your code here + * echo $content; * } - * ?> + * add_action( 'um_profile_content_main', 'my_profile_content_main' ); */ - do_action("um_profile_content_{$nav}", $args); - + do_action( "um_profile_content_$nav", $args ); /** - * UM hook + * Fires for adding content in User Profile nav > subnav menu content tab. + * $nav profile menu tab key. + * $subnav profile sub-menu tab key. * - * @type action - * @title um_profile_content_{$nav}_{$subnav} - * @description Custom hook to display tabbed content - * @input_vars - * [{"var":"$args","type":"array","desc":"Profile form shortcode arguments"}] - * @change_log - * ["Since: 2.0"] - * @usage add_action( 'um_profile_content_{$nav}_{$subnav}', 'function_name', 10, 1 ); - * @example - * Callback name -> Excerpt): + * 10 - `um_bbpress_user_topics()` displays `Topics` submenu of bbPress tab's content. + * 10 - `um_bbpress_user_replies()` displays `Replies` submenu of bbPress tab's content. + * 10 - `um_bbpress_user_favorites()` displays `Favorites` submenu of bbPress tab's content. + * 10 - `um_bbpress_user_subscriptions()` displays `Subscriptions` submenu of bbPress tab's content. + * 10 - `profile_content_forums_topics()` displays `Topics` submenu of ForumWP tab's content. + * 10 - `profile_content_forums_replies()` displays `Replies` submenu of ForumWP tab's content. + * 10 - `profile_content_subscriptions()` displays `Subscriptions` submenu of ForumWP tab's content. + * 10 - `profile_content_bookmarks()` displays `Bookmarks` submenu of ForumWP tab's content. + * 10 - `profile_content_likes()` displays `Likes` submenu of ForumWP tab's content. + * 10 - `um_profile_content_friends_myfriends()` displays `My Friends` submenu of Friends tab's content. + * 10 - `um_profile_content_friends_friendreqs()` displays `Friends Requests` submenu of Friends tab's content. + * 10 - `um_profile_content_friends_sentreqs()` displays `Send Friends Requests` submenu of Friends tab's content. + * 10 - `um_profile_content_badges_my_badges()` displays `My badges` submenu of myCRED tab's content. + * 10 - `um_profile_content_badges_all_badges()` displays `All badges` submenu of myCRED tab's content. + * 10 - `get_bookmarks_content()` displays `All bookmarks with folders` submenu of User Bookmarks tab's content. + * 10 - `get_bookmarks_content_all()` displays `All bookmarks` submenu of User Bookmarks tab's content. + * 10 - `get_bookmarks_content_users()` displays `All bookmarked users` submenu of User Bookmarks tab's content. + * 10 - `user_notes_profile_tab()` displays `View Notes` submenu of User Notes tab's content. + * 10 - `get_add_note_form()` displays `Add Note` submenu of User Notes tab's content. + * 10 - `get_gallery_content()` displays `Albums` submenu of User Photos tab's content. + * 10 - `get_gallery_photos_content()` displays `Photos` submenu of User Photos tab's content. + * 10 - `um_profile_content_purchases()` displays `Purchases` submenu of Woocommerce tab's content. + * 10 - `um_profile_content_product_reviews()` displays `Product Reviews` submenu of Woocommerce tab's content. + * + * @param {array} $args User Profile data. + * + * @since 1.3.x + * @hook um_profile_content_{$nav}_{$subnav} + * + * @example Display some content in User Profile `main` nav and `step2` subnav content tab. + * function my_profile_content_main_step2( $args ) { * // your code here + * echo $content; * } - * ?> + * add_action( 'um_profile_content_main_step2', 'my_profile_content_main_step2' ); */ - do_action( "um_profile_content_{$nav}_{$subnav}", $args ); ?> - + do_action( "um_profile_content_{$nav}_$subnav", $args ); + ?>
@@ -218,69 +245,51 @@ $description_key = UM()->profile()->get_show_bio_key( $args );
- options()->get( 'profile_menu' ); - $tabs = UM()->profile()->tabs_active(); + $profile_tabs = UM()->profile()->tabs_active(); - $nav = UM()->profile()->active_tab(); + $nav = UM()->profile()->active_tab(); $subnav = UM()->profile()->active_subnav(); $subnav = ! empty( $subnav ) ? $subnav : 'default'; - if ( $menu_enabled || ! empty( $tabs[ $nav ]['hidden'] ) ) { ?> - + if ( $menu_enabled || ! empty( $profile_tabs[ $nav ]['hidden'] ) ) { + ?>
- */ - do_action("um_profile_content_{$nav}", $args); - - /** - * UM hook - * - * @type action - * @title um_profile_content_{$nav}_{$subnav} - * @description Custom hook to display tabbed content - * @input_vars - * [{"var":"$args","type":"array","desc":"Profile form shortcode arguments"}] - * @change_log - * ["Since: 2.0"] - * @usage add_action( 'um_profile_content_{$nav}_{$subnav}', 'function_name', 10, 1 ); - * @example - * - */ - do_action( "um_profile_content_{$nav}_{$subnav}", $args ); ?> - + /** This action is documented in ultimate-member/templates/profile.php */ + do_action( "um_profile_content_$nav", $args ); + /** This action is documented in ultimate-member/templates/profile.php */ + do_action( "um_profile_content_{$nav}_$subnav", $args ); + ?>
- - + /** + * Fires for adding content below User Profile menu. + * + * Internal Ultimate Member callbacks (Priority -> Callback name -> Excerpt): + * 99 - `profile_footer_login_form()` displays User Login form related to messaging extension. + * + * @param {array} $args User Profile data. + * + * @since 2.0 + * @hook um_profile_footer + * + * @example Display some content in User Profile footer. + * function my_um_profile_footer( $args ) { + * // your code here + * echo $content; + * } + * add_action( 'um_profile_footer', 'my_um_profile_footer' ); + */ + do_action( 'um_profile_footer', $args ); + ?>