Function Hook_profiles_tabs_edit_title->render_tab

Definitions

sources/hooks/systems/profiles_tabs_edit/title.php

  • Render function for profile tabs edit hooks.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id_of MEMBER No No required parameter N/A N/A The ID of the member who is being viewed
$member_id_viewing MEMBER No No required parameter N/A N/A The ID of the member who is doing the viewing
$leave_to_ajax_if_possible boolean No No False N/A N/A Whether to leave the tab contents null, if this hook supports it, so that AJAX can load it later

Returns

  • A tuple: The tab title, the tab body text (may be blank), the tab fields, extra JavaScript (may be blank) the suggested tab order, hidden fields (optional) (null: if $leave_to_ajax_if_possible was set), the icon
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Render function for profile tabs edit hooks.
 *
 * @param  MEMBER $member_id_of The ID of the member who is being viewed
 * @param  MEMBER $member_id_viewing The ID of the member who is doing the viewing
 * @param  boolean $leave_to_ajax_if_possible Whether to leave the tab contents null, if this hook supports it, so that AJAX can load it later
 * @return ?array A tuple: The tab title, the tab body text (may be blank), the tab fields, extra JavaScript (may be blank) the suggested tab order, hidden fields (optional) (null: if $leave_to_ajax_if_possible was set), the icon
 */
public function render_tab(int $member_id_of, int $member_id_viewing, bool $leave_to_ajax_if_possible = false) : ?array