Apache mod_rewrite Flags

Available Languages: en

+ +

This document discusses the flags which are available to the +RewriteRule directive, +providing more detailed explanations and examples of each.

Introduction
The flags

Introduction

RewriteRules can have +their behavior modified by one or more flags. Flags are included in +square brackets at the end of the rule, and multiple flags are separated +by commas.

Each flag has a long and short form. While it is most common to use +the short form, it is recommended that you familiarize yourself with the +long form, so that you remember what each flag is supposed to do.

+ +

Presented here are each of the available flags, along with an example +of how you might use them.

+ +

C|chain

The [C] or [chain] flag indicates that the RewriteRule is chained to the next +rule. That is, if the rule matches, then it is processed as usual and +control moves on to the next rule. However, if it does not match, then +the next rule, and any other ruls that are chained together, will be +skipped.

+ + + +

CO|cookie

The [CO], or [cookie] flag, allows you to set a cookie when a +particular RewriteRule +matches. The argument consists of three required fields and two optional +fields.

You must declare a name and value for the cookie to be set, and the +domain for which you wish the cookie to be valid. You may optionally set +the lifetime of the cookie, and the path for which it should be +returned.

By default, the lifetime of the cookie is the current browser +session.

By default, the path for which the cookie will be valid is "/" - that +is, the entire website.

Several examples are offered here:

+ +

+RewriteEngine On +RewriteRule ^/index.html - [CO=frontdoor=yes:.apache.org:1440:/] +

+ +

This rule doesn't rewrite the request (the "-" rewrite target tells +mod_rewrite to pass the request through unchanged) but sets a cookie +called 'frontdoor' to a value of 'yes'. The cookie is valid for any host +in the .apache.org domain. It will be set to expire in 1440 +minutes (24 hours) and will be returned for all URIs.

+ + + +

E|env

With the [E], or [env] flag, you can set the value of an environment +variable. Note that some variables may be set after the rule is run, and +so setting them in the RewriteRule won't work, since it will +be changed afterwards.

+ +

The following example sets an evironment variable called 'image' to a +value of '1' if the requested URI is an image file. Then, that +environment variable is used to exclude those requests from the access +log.

+ +

+RewriteRule %{REQUEST_URI} \.(png|gif|jpg) - [E=image:1] +CustomLog logs/access_log combined env=!image +

+ +

Note that this same effect can be obtained using SetEnvIf. This technique is offered as +an example, not as a recommendation.

+ + +

Apache mod_rewrite Flags

See also

Introduction

The flags

C|chain

CO|cookie

E|env

F|forbidden

G|gone

H|handler

L|last

N|next

NC|nocase

NE|noescape

NS|nosubreq

P|proxy

PT|passthrough

PT|passthrough

QSA|qsappend

R|redirect

S|skip

T|type