Context alter documentaion missing

Created on 30 December 2014, over 9 years ago
Updated 28 October 2023, 8 months ago

Problem/Motivation

Consider function tfa_get_context($account):

/**
 * Context for account TFA process.
 *
 * @param $account User account
 * @return array
 *   @see tfa_start_context() for format
 */
function tfa_get_context($account) {
  $context = array();
  if (isset($_SESSION['tfa'][$account->uid])) {
    $context = $_SESSION['tfa'][$account->uid];
  }
  // Allow other modules to modify TFA context.
  drupal_alter('tfa_context', $context);
  return $context;
}

It has drupal_alter('tfa_context', $context). There is no documentation for this in tfa.api.php.

Context is explained here → , but an API documentation always helps a developer. Also a sample code about how we can alter the context will help.

Proposed resolution

N/A

Remaining tasks

N/A

User interface changes

N/A

API changes

Please add the documentation for drupal_alter('tfa_context', $context) in tfa.api.php.

Thanks.

📌 Task
Status

Needs work

Version

2.0

Component

Documentation

Created by

🇮🇳India subhojit777

Live updates comments and jobs are added and updated live.
  • Needs reroll

    The patch will have to be re-rolled with new suggestions/changes described in the comments in the issue.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024