Skip to content

Update single-variables.md #1020

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/templates/globals/single-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ This variable will be substituted for the global character set (UTF-8). It is ty

### `{cp_session_id}`

The session id for the control panel. This is the value needed in the "S=" portion of the control panel URL. Only output for logged-in members who have access to the Control Panel, for instance to build a front-end URL to an add-on in the control panel:
The session id for the control panel. This is the value needed in the "S=" portion of the control panel URL, for instance to build a URL from the front-end to an add-on in the control panel. Will only produce output for logged-in members who have access to the Control Panel.

{if logged_in_role_id == 1}
{if logged_in_primary_role_id == 1}
&bull; <a href="{cp_url}?/cp/addons/settings/my_addon&S={cp_session_id}"></a>
{/if}

### `{cp_url}`

The URL to the control panel for this site. Only output for logged-in members who have access to the Control Panel.
The URL to the control panel for this site. Will only produce output for logged-in members who have access to the Control Panel.

### `{csrf_token}`

Expand Down