PHP 8.1.0 Alpha 1 available for testing


(PHP 4, PHP 5, PHP 7, PHP 8)

apache_noteGet and set apache request notes


apache_note ( string $note_name , string|null $note_value = null ) : string|false

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

The main use for apache_note() is to pass information from one module to another within the same request.



The name of the note.


The value of the note.

Return Values

If note_value is omitted or null, it returns the current value of note note_name. Otherwise, it sets the value of note note_name to note_value and returns the previous value of note note_name. If the note cannot be retrieved, false is returned.


Version Description
8.0.0 note_value is nullable now.


Example #1 Passing information between PHP and Perl


('name''Fredrik Ekengren');

// Call perl script

$result apache_note("resultdata");
# Get Apache request object
my $r = Apache->request()->main();

# Get passed data
my $name = $r->notes('name');

# some processing

# Pass result back to PHP
$r->notes('resultdata', $result);

Example #2 Logging values in access.log



# "%{sessionID}n" can be used in the LogFormat directive

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top