Function __global->find_overridden_comment_forum

Definitions

sources/feedback.php

  • Get the comment topic forum for a feedback scenario.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$feedback_code ID_TEXT No No required parameter N/A N/A The feedback code, which we may have overridden the comment forum against
$category_id ?ID_TEXT No No Null N/A N/A The category ID, which we may have overridden the comment forum against (null: no category ID to override against)

Returns

  • The comment topic forum (may be integer as string, or string forum name - so use forum_id_from_name on the result)
  • Type: ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the comment topic forum for a feedback scenario.
 *
 * @param  ID_TEXT $feedback_code The feedback code, which we may have overridden the comment forum against
 * @param  ?ID_TEXT $category_id The category ID, which we may have overridden the comment forum against (null: no category ID to override against)
 * @return ID_TEXT The comment topic forum (may be integer as string, or string forum name - so use forum_id_from_name on the result)
 */
function find_overridden_comment_forum(string $feedback_code, ?string $category_id = null) : string