Home > PHP > Function > Apache > apache_note()

apache_note()

apache_note - Get and set apache request notes

Syntax

string apache_note (string $note_name, string $note_value)

Arguments

  • note_name - The name of the note.
  • note_value - The value of the note.

Description

This function is a wrapper for Apache's table_getand table_set. It edits the table of notes that exists during a request. The table's purpose is to allow Apache modules to communicate.

Version

PHP 4, 5

Return value

If called with one argument, it returns the current value of note note_name. If called with two arguments, it sets the value of note note_nameto note_valueand returns the previous value of note note_name. If the note cannot be retrieved, FALSE is returned.