Function __global->points_url
Definitions
sources/points.php
- Generate a proper URL to a member's points profile and optionally pre-populate fields for sending / modifying points.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
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 view the profile |
| $skip_keep | boolean | No | No | False | N/A | N/A | Whether to skip actually putting on keep_ parameters (rarely will this skipping be desirable) |
| $send_amount | ?integer | No | No | Null | N/A | N/A | The number of points to pre-populate in the send / modify form (null: leave blank) |
| $send_reason | ?SHORT_TEXT | No | No | Null | N/A | N/A | The reason to pre-populate in the send / modify form (null: leave blank) |
| $trans_type | ?ID_TEXT | No | No | Null | send credit debit | N/A | The type of transaction to pre-select (ignored for those without "Moderate points" privilege) (null: do not set a default) |
Returns
- The URL to the member's points profile
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Generate a proper URL to a member's points profile and optionally pre-populate fields for sending / modifying points.
*
* @param MEMBER $member_id The member to view the profile
* @param boolean $skip_keep Whether to skip actually putting on keep_ parameters (rarely will this skipping be desirable)
* @param ?integer $send_amount The number of points to pre-populate in the send / modify form (null: leave blank)
* @param ?SHORT_TEXT $send_reason The reason to pre-populate in the send / modify form (null: leave blank)
* @param ?ID_TEXT $trans_type The type of transaction to pre-select (ignored for those without "Moderate points" privilege) (null: do not set a default)
* @set send credit debit
* @return Tempcode The URL to the member's points profile
*/
function points_url(int $member_id, bool $skip_keep = false, ?int $send_amount = null, ?string $send_reason = null, ?string $trans_type = null) : object
* Generate a proper URL to a member's points profile and optionally pre-populate fields for sending / modifying points.
*
* @param MEMBER $member_id The member to view the profile
* @param boolean $skip_keep Whether to skip actually putting on keep_ parameters (rarely will this skipping be desirable)
* @param ?integer $send_amount The number of points to pre-populate in the send / modify form (null: leave blank)
* @param ?SHORT_TEXT $send_reason The reason to pre-populate in the send / modify form (null: leave blank)
* @param ?ID_TEXT $trans_type The type of transaction to pre-select (ignored for those without "Moderate points" privilege) (null: do not set a default)
* @set send credit debit
* @return Tempcode The URL to the member's points profile
*/
function points_url(int $member_id, bool $skip_keep = false, ?int $send_amount = null, ?string $send_reason = null, ?string $trans_type = null) : object