Mirrors/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-10-06 09:37:12 +02:00
Code Issues Releases Wiki Activity

Updated Static filter syntax (markdown)

Raymond Hill 2021-01-15 13:56:23 -05:00
parent b78e65e0c3
commit 07b6ef4628
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Static-filter-syntax.md

@ -550,30 +550,6 @@ See also: [`empty`](#empty), [`redirect`](#redirect)
***
#### `queryprune`
New in [1.32.0](https://github.com/gorhill/uBlock/commit/1e2eb037e5b4754feb4a40519951b3e7a73d545d).
To remove query parameters from the URL of network requests. uBO can also parse and enforce [AdGuard's `removeparam`](https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters?aid=16593#removeparam-modifier) as a synonym of `queryprune`.
`queryprune` is a modifier option (like `csp`) in that it does not cause a network request to be blocked but rather modified before being emitted.
`queryprune` must be assigned a value, which value will determine which exact parameter from a query string will be removed:
*$queryprune=utm_source
The above filter tells uBO to remove the query parameter `utm_source` when present in a URL.
The value assigned to `queryprune` can be a literal regular expression, in which case uBO will remove query parameters matching the regular expression:
*$queryprune=/^utm_/
The above filter will remove all query parameters which name starts with `utm_`, regardless of their value. When using a literal regular expression, it is tested against each query parameter name-value pair assembled into a single string as `name=value`.
Poorly crafted `queryprune` filters can have deleterious effects on performance, experienced filter authors are expected to understand well how to craft optimal filters.
***
#### `redirect`
The `redirect` option means _"block and redirect"_, and really causes two filters to be created internally, a block filter and a redirect directive (`redirect-rule`).
@ -632,6 +608,30 @@ Available since [1.22.0](https://github.com/gorhill/uBlock/releases/tag/1.22.0).
***
#### `removeparam`
New in [1.32.0](https://github.com/gorhill/uBlock/commit/1e2eb037e5b4754feb4a40519951b3e7a73d545d).
To remove query parameters from the URL of network requests -- see also [AdGuard's `removeparam`'s documentation](https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters?aid=16593#removeparam-modifier). For historical reasons, `queryprune` is an alias of `ŕemoveparam`.
`removeparam` is a modifier option (like `csp`) in that it does not cause a network request to be blocked but rather modified before being emitted.
`removeparam` must be assigned a value, which value will determine which exact parameter from a query string will be removed:
*$removeparam=utm_source
The above filter tells uBO to remove the query parameter `utm_source` when present in a URL.
The value assigned to `removeparam` can be a literal regular expression, in which case uBO will remove query parameters matching the regular expression:
*$removeparam=/^utm_/
The above filter will remove all query parameters which name starts with `utm_`, regardless of their value. When using a literal regular expression, it is tested against each query parameter name-value pair assembled into a single string as `name=value`.
Poorly crafted `removeparam` filters can have deleterious effects on performance, experienced filter authors are expected to understand well how to craft optimal filters.
***
## Static extended filtering
Static extended filters are all of the form: