Packages are only used to organize (i.e. group) classes/functions/globals/constants together logically. Although PHP v5.3+ supports the concept of Namespaces (i.e. Packages), this software does not require that type of usage. All Classes contained within this software are top-level. In other words, you don't need to reference any particular Package within code. Again, at this time, Packages are only used to improve organization within this documentation.
( All 69 Packages ) Packages | |
---|---|
s2Member | Core Package for the s2Member plugin. ( 140 Hooks/Filters ) |
s2Member\API_Constants | Easy API Constants for site owners to use in their own projects. ( 4 Hooks/Filters ) |
s2Member\API_Functions | Easy API Functions for site owners to use in their own projects. ( 1 Hook/Filter ) |
s2Member\API_Remote_Ops | Easy API Operations for site owners to use in their own projects. ( 2 Hooks/Filters ) |
s2Member\Admin_CSS_JS | Administrative CSS/JS for menu pages. ( 6 Hooks/Filters ) |
s2Member\Admin_Lockouts | Locks Users/Members out of admin panels. ( 5 Hooks/Filters ) |
s2Member\Admin_Notes | Administrative notes. ( 6 Hooks/Filters ) |
s2Member\Admin_Notices | Enqueue/display administrative notices. ( 10 Hooks/Filters ) |
s2Member\AliPay | AliPay® integration classes. ( 0 Hooks/Filters ) |
s2Member\AuthNet | Authorize.Net® integration classes. ( 21 Hooks/Filters ) |
s2Member\Auto_EOT_System | Auto-EOT System (EOT = End Of Term). ( 19 Hooks/Filters ) |
s2Member\Brute_Force | Brute Force protection classes. ( 6 Hooks/Filters ) |
s2Member\CSS_JS | CSS/JS classes for s2Member. ( 13 Hooks/Filters ) |
s2Member\Cache | s2Member's caching classes. ( 2 Hooks/Filters ) |
s2Member\Categories | Category protection classes. ( 8 Hooks/Filters ) |
s2Member\ClickBank | ClickBank® integration classes. ( 0 Hooks/Filters ) |
s2Member\Cron_Jobs | Cron routines handled by s2Member. ( 5 Hooks/Filters ) |
s2Member\Custom_Reg_Fields | Custom Registration Fields. ( 64 Hooks/Filters ) |
s2Member\Email_Configs | Email configurations for s2Member. ( 23 Hooks/Filters ) |
s2Member\Exports | Various exportation classes. ( 2 Hooks/Filters ) |
s2Member\Files | File Download classes. ( 28 Hooks/Filters ) |
s2Member\Gateways | Loading routines for Payment Gateways. ( 2 Hooks/Filters ) |
s2Member\Google | Google® Checkout integration classes. ( 0 Hooks/Filters ) |
s2Member\IP_Restrictions | IP Restriction classes. ( 21 Hooks/Filters ) |
s2Member\Imports | Various importation classes. ( 1 Hook/Filter ) |
s2Member\Installation | Installation classes for s2Member. ( 7 Hooks/Filters ) |
s2Member\List_Servers | List Server integrations. ( 30 Hooks/Filters ) |
s2Member\Lock_Icons | s2Member Lock Icon classes. ( 12 Hooks/Filters ) |
s2Member\Login_Customizations | Login/Registration customizations. ( 14 Hooks/Filters ) |
s2Member\Login_Redirects | Login redirections. ( 19 Hooks/Filters ) |
s2Member\Main_Multisite_Patches | Main Multisite patches. ( 7 Hooks/Filters ) |
s2Member\Membership_Options_Page | Membership Options Page. ( 6 Hooks/Filters ) |
s2Member\Menu_Pages | Administrative menu pages. ( 543 Hooks/Filters ) |
s2Member\Meta_Boxes | Administrative meta boxes. ( 8 Hooks/Filters ) |
s2Member\New_Users | New User, administrative handlers. ( 34 Hooks/Filters ) |
s2Member\No_Cache | No-cache classes. ( 10 Hooks/Filters ) |
s2Member\Option_Forces | Forces WordPress® options. ( 14 Hooks/Filters ) |
s2Member\Option_Notices | Option panel notices. ( 9 Hooks/Filters ) |
s2Member\Pages | Page protection classes. ( 8 Hooks/Filters ) |
s2Member\PayPal | PayPal® integration classes. ( 211 Hooks/Filters ) |
s2Member\Posts | Post protection classes. ( 8 Hooks/Filters ) |
s2Member\Profiles | User/Member Profile classes. ( 41 Hooks/Filters ) |
s2Member\Queries | Query protection classes. ( 13 Hooks/Filters ) |
s2Member\Readmes | Readme file parsing classes. ( 6 Hooks/Filters ) |
s2Member\Registrations | Registration classes/handlers. ( 48 Hooks/Filters ) |
s2Member\Return_Templates | Thank-You Page Return templates. ( 8 Hooks/Filters ) |
s2Member\Roles_Caps | Configuration of Roles/Capabilities. ( 11 Hooks/Filters ) |
s2Member\SP_Access | Specific Post/Page Access. ( 11 Hooks/Filters ) |
s2Member\SSL | SSL classes for s2Member. ( 18 Hooks/Filters ) |
s2Member\Security | s2Member's Security Gate. ( 4 Hooks/Filters ) |
s2Member\Security_Badges | s2Member Security Badges. ( 5 Hooks/Filters ) |
s2Member\Systematics | Systematic conditional classes. ( 6 Hooks/Filters ) |
s2Member\Tags | Tag protection classes. ( 8 Hooks/Filters ) |
s2Member\Tracking | Tracking classes. ( 19 Hooks/Filters ) |
s2Member\Translations | Translation classes. ( 3 Hooks/Filters ) |
s2Member\URIs | URI protection classes. ( 10 Hooks/Filters ) |
s2Member\Upgrader | s2Member upgrade wizard classes. ( 4 Hooks/Filters ) |
s2Member\User_Access | User access classes. ( 5 Hooks/Filters ) |
s2Member\User_Deletions | User deletion classes. ( 11 Hooks/Filters ) |
s2Member\User_Securities | User security classes. ( 8 Hooks/Filters ) |
s2Member\Users_List | WordPress® Users list. ( 50 Hooks/Filters ) |
s2Member\Utilities | s2Member utility classes. ( 11 Hooks/Filters ) |
s2Member\WP_Footer | WordPress® footer classes. ( 2 Hooks/Filters ) |
s2Member\Widgets | Widget loading routines & classes. ( 14 Hooks/Filters ) |
s2Member\ccBill | ccBill® integration classes. ( 2 Hooks/Filters ) |
s2Member\s2File | Shortcode [s2File /] classes. ( 6 Hooks/Filters ) |
s2Member\s2Get | Shortcode [s2Get /] classes. ( 3 Hooks/Filters ) |
s2Member\s2If | Shortcode [s2If /] classes. ( 4 Hooks/Filters ) |
s2Member\s2Key | Shortcode [s2Key /] classes. ( 3 Hooks/Filters ) |
The free version of s2Member®, is referred to as the s2Member® Framework. It supports PayPal® Standard Button integration through WordPress® Shortcodes. Suitable for most sites.
This documentation also covers routines introduced by s2Member® Pro (an optional paid upgrade). s2Member® Pro adds support for PayPal® Pro, Authorize.Net®, Google® Checkout, and ClickBank®. In addition, s2Member® Pro includes User Import/Export tools, Coupon Codes, and a Pro Login Widget (plus Profile Summary). Your purchase of s2Member® Pro includes free upgrades via s2Member.com (new features, bug fixes, updates, improvements), along with full access to our video tutorial library.
If you need to add custom processing routines, or modify the behavior of existing processing routines; please use s2Member's Hooks/Filters for WordPress®. Hooks & Filters, give you the ability to "hook into", and/or "filter" processing routines, with files/functions of your own; instead of editing the s2Member® plugin files directly. This way you won't need to merge your changes/tweaks each time a new version of s2Member® is released. To create custom processing routines, place those routines into a PHP file here: /wp-content/mu-plugins/s2-hacks.php
. If you don't have an /mu-plugins/
directory, please create one. These are (mu) MUST USE plugins, which are loaded into WordPress® automatically; that's what you want! If you're not familiar with Hooks/Filters for WordPress®, please read this article in the WordPress® Codex.
/wp-content/mu-plugins/s2-hacks.php
)Please make sure there are NO blank lines in your PHP file. Do NOT introduce spaces/tabs/lines before or after the <?php ?>
tags.
<?php add_action("hook_name", "my_action_hook_function"); function my_action_hook_function($vars = array()) { echo "My Hook works.";</p><p> # Optional. s2Member® passes you an array of defined variables. # print_r($vars); # Would give you a list of defined variables. # These are PHP variables defined within the scope of the Hook, # at the precise point in which the Hook is fired by s2Member®.</p><p> # $vars["__refs"] are also included (with some Hooks). # These are internal PHP variable references (very useful). # To learn all about references, please see PHP documentation: # http://www.php.net/manual/en/language.references.pass.php } ?>
/wp-content/mu-plugins/s2-hacks.php
)Please make sure there are NO blank lines in your PHP file. Do NOT introduce spaces/tabs/lines before or after the <?php ?>
tags.
<?php add_filter("filter_name", "my_filtering_function", 10, 2); function my_filtering_function($original_value, $vars = array()) { if($original_value !== "something I like") return ($my_custom_value = "My Filter works.");</p><p> else # Return original value. return $original_value;</p><p> # Optional. s2Member® passes you an array of defined variables. # print_r($vars); # Would give you a list of defined variables. # These are PHP variables defined within the scope of the Filter, # at the precise point in which the Filter is fired by s2Member®.</p><p> # $vars["__refs"] are also included (with some Filters). # These are internal PHP variable references (very useful). # To learn all about references, please see PHP documentation: # http://www.php.net/manual/en/language.references.pass.php } ?>
The free version of s2Member®, is referred to as the s2Member® Framework. It supports PayPal® Standard Button integration through WordPress® Shortcodes. Suitable for most sites.
This documentation also covers routines introduced by s2Member® Pro (an optional paid upgrade). s2Member® Pro adds support for PayPal® Pro, Authorize.Net®, Google® Checkout, and ClickBank®. In addition, s2Member® Pro includes User Import/Export tools, Coupon Codes, and a Pro Login Widget (plus Profile Summary). Your purchase of s2Member® Pro includes free upgrades via s2Member.com (new features, bug fixes, updates, improvements), along with full access to our video tutorial library.