Repository navigation
Clarify the output buffering note on the header() page - #5915
Merged
Merged
Conversation
The first note in the Notes section starts with "You can use output buffering to get around this problem", but there is no problem mentioned anywhere before it. The note that comes before it is the one about SAPI support, and the paragraph it actually refers to is in the Description section, where it says that header() must be called before any output is sent. Rewrote the opening so the note says what it is about without depending on a paragraph in another section. The rest of the note is unchanged.
Member
|
Thanks @angeliszotis, few linter nits, but LGTM |
The DocBook style check flagged the note's para as inline-only.
Contributor
Author
|
Thanks @lacatoire! Switched the note to |
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.
Fixes #2680
The first note in the Notes section of the
header()page reads:There is no problem mentioned before it. The note that comes right before is the SAPI one, which comes from the
note.network.header.sapientity:so a reader going through the Notes section has nothing to attach "this problem" to. What it refers to is in the Description section:
As the reporter pointed out, that is also not really a "problem" by itself. It is a requirement, and it only becomes a problem if something is output by accident.
I rewrote the opening clause so the note stands on its own:
The rest of the note, the part about
ob_start(),ob_end_flush()andoutput_buffering, is unchanged.