| 1 |
NOTE: While these old variables no longer appear in the URL, |
| 2 |
s2Member will create the following variables (internally) for backward compatibility |
| 3 |
with older versions of the software. |
| 4 |
|
| 5 |
----------------------------------------------------------------------------------------------------------- |
| 6 |
Example redirection links, including many of the possible MOP Variable variations. |
| 7 |
----------------------------------------------------------------------------------------------------------- |
| 8 |
|
| 9 |
.../membership-options-page/?_s2member_seeking[post]=369&_s2member_req[sp]=369 |
| 10 |
.../membership-options-page/?_s2member_seeking[page]=559&_s2member_req[sp]=559 |
| 11 |
.../membership-options-page/?_s2member_seeking[page]=587&_s2member_req[level]=1 |
| 12 |
.../membership-options-page/?_s2member_seeking[post]=545&_s2member_req[level]=2 |
| 13 |
.../membership-options-page/?_s2member_seeking[catg]=698&_s2member_req[level]=4 |
| 14 |
.../membership-options-page/?_s2member_seeking[ptag]=447&_s2member_req[level]=3 |
| 15 |
.../membership-options-page/?_s2member_seeking[page]=887&_s2member_req[ccap]=music |
| 16 |
.../membership-options-page/?_s2member_seeking[post]=871&_s2member_req[ccap]=videos |
| 17 |
.../membership-options-page/?_s2member_seeking[file]=example.zip&_s2member_req[level]=1 |
| 18 |
.../membership-options-page/?_s2member_seeking[ruri]=aHR0cDov...&_s2member_req[level]=1 |
| 19 |
|
| 20 |
----------------------------------------------------------------------------------------------------------- |
| 21 |
|
| 22 |
Here is a breakdown on each of these Variables: |
| 23 |
|
| 24 |
* `_s2member_seeking[post|page|catg|ptag|file|ruri]` = (Post ID, Page ID, Category ID, Tag ID, File, URI) |
| 25 |
Tip: `_s2member_seeking[file]` = (File path, relative to /s2member-files/, or your Amazon® S3 Bucket) |
| 26 |
Tip: `_s2member_seeking[ruri]` = (A base 64 encoded URI; only applies w/ Membership URI Restrictions) |
| 27 |
Tip: These array elements are mutually exclusive: [post|page|catg|ptag|file|ruri]. |
| 28 |
Only ONE of these array elements (i.e., Content Types) will be specified. |
| 29 |
|
| 30 |
* `_s2member_req[level]` = a Membership Level # required for access (only applies to Membership Level Access) |
| 31 |
* `_s2member_req[ccap]` = a Custom Capability required for access (only applies to Custom Capability Restrictions) |
| 32 |
* `_s2member_req[sp]` = a Specific Post/Page ID required (only applies to Specific Post/Page Access Restrictions) |
| 33 |
Tip: `_s2member_req[level|ccap|sp]` are mutually exclusive Requirement Types. |
| 34 |
Only ONE of these three elements will be passed in combination with: |
| 35 |
`_s2member_seeking[post|page|catg|ptag|file|ruri]`. |
| 36 |
|
| 37 |
----------------------------------------------------------------------------------------------------------- |
| 38 |
|
| 39 |
Additional Variables that might be useful to developers: |
| 40 |
|
| 41 |
* `_s2member_seeking[_uri]` = (A base 64 encoded URI; the URI they were originally seeking) |
| 42 |
Tip: this is ALWAYS passed through, regardless of which Content Type was protected. |
| 43 |
|
| 44 |
* `_s2member_seeking[type]` = (A string. One of: post|page|catg|ptag|file|ruri) |
| 45 |
Tip: this is ALWAYS passed through, regardless of which Content Type was protected. |
| 46 |
|
| 47 |
* `_s2member_req[type]` = (A string. One of: level|ccap|sp) |
| 48 |
Tip: this Requirement Type Variable is ALWAYS passed through. |
| 49 |
|
| 50 |
* `_s2member_res[type]` = (A string. One of: post|page|catg|ptag|file|ruri|ccap|sp|sys) |
| 51 |
Tip: Actual Restriction Type that's preventing access; may differ from `_s2member_seeking[type]`. |
| 52 |
Tip: Restriction Type `sys` Systematic (i.e., something s2Member protects automatically) |
| 53 |
Tip: Restriction Type `ccap` represents Custom Capability Restrictions by s2Member. |
| 54 |
Tip: Restriction Type `sp` represents Specific Post/Page Access Restrictions. |
| 55 |
Tip: this Restriction Type Variable is ALWAYS passed through. |
| 56 |
|
| 57 |
----------------------------------------------------------------------------------------------------------- |
| 58 |
|
| 59 |
* The use of MOP Vars is 100% completely optional (for advanced site owners). |
