docs(basics/controllers): clarify session variable usage, locking, best practices#14037
Merged
docs(basics/controllers): clarify session variable usage, locking, best practices#14037
Conversation
kesselb
reviewed
Jan 31, 2026
Contributor
kesselb
left a comment
kesselb
left a comment
There was a problem hiding this comment.
Thanks a lot 🙏
It reads well. I am not deep enough into our session handling code to approve this, but I will ask around for another reviewer.
| // write a session variable | ||
| $this->session['value'] = 'new value'; | ||
| } | ||
| The entire ``OCP\\ISession`` API: |
Member
There was a problem hiding this comment.
Shouldn't duplicate this list here. Just link to the file instead.
Contributor
There was a problem hiding this comment.
Done in 79b0ebe — removed the method list and replaced it with a single link to ISession.php.
…d API best practices Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
skjnldsv
force-pushed
the
jtr/dev-sessions-clarifications
branch
from
495f4ea to
ac62862
Compare
…rce instead Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/27800d6c-aa12-41dc-a65f-0a927234ce8c Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
auto-merge was automatically disabled
April 29, 2026 06:41
Head branch was pushed to by a user without write access
skjnldsv
approved these changes
Apr 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
☑️ Resolves
This PR improves and clarifies the documentation for session handling and session variables for developers.
Completed while working on nextcloud/server#57794
Key updates:
ISessionand raw$_SESSION, warning against the latter.#[UseSession]attribute should be used for efficiency.ISessionAPI and links directly to its definition.This brings the documentation fully in line with actual Nextcloud session implementation and gives app authors clear, accurate advice for robust and performant apps.
🖼️ Screenshots