Function __global->_points_adjust_cpf

Definitions

sources/points2.php

  • Adjust a custom profile field for points and update the cache.This API method should normally never be called outside _points_transact as doing so violates the tenets of the points system.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: void

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_id MEMBER No No required parameter N/A N/A The member to adjust
$field_name ID_TEXT No No required parameter points_balance points_rank N/A The custom field to adjust
$adjustment integer No No required parameter N/A N/A By how much to adjust the field (use a negative number to subtract)

Preview

Code (PHP)

/**
 * Adjust a custom profile field for points and update the cache.This API method should normally never be called outside _points_transact as doing so violates the tenets of the points system.
 *
 * @param  MEMBER $member_id The member to adjust
 * @param  ID_TEXT $field_name The custom field to adjust
 * @set points_balance points_rank
 * @param  integer $adjustment By how much to adjust the field (use a negative number to subtract)
 */

function _points_adjust_cpf(int $member_id, string $field_name, int $adjustment) : void