AdditionalOptions.xtpl — Post Affiliate Pro trunk

postaffiliatepro / Template / AdditionalOptions.xtpl

postaffiliatepro / Template Last commit date

AdditionalOptions.xtpl

87 lines

1	<!-- BEGIN: main -->
2	<div class="wrap">
3	<h2>Additional options</h2>
4	<div>This section is to inform you about more options that this plugin offers</div>
5
6	<h3>Shortcodes</h3>
7	<div>
8	What is a shortcode? The Shortcode is a simple function for use in posts and pages. The Post Affiliate Pro plugin uses it for easy and quick access to affiliate details. If the logged user is also an affiliate (there is a match between WP nice_name and affiliate referral ID, or a match by email) you can show them some info, e.g. their affiliate link, so they do not have to redirect to their affiliate panel to get it. Or you can let them easily login without the need to enter their credentials once again.
9	<br />The shortcode, from the point of view, is just a short text that you add to a place in post or page where you want the specific data to be displayed.
10	<br />
11	<br />Here are some examples of use:
12	<br />
13	<strong>[affiliate item="name"]</strong> - prints name of currently loaded affiliate.
14	<br />
15	<strong>[affiliate item="loginurl"]</strong> - prints link "Affiliate panel" that affiliate can use to login to his panel
16	<br />
17	<strong>[affiliate item="loginurl" caption="Log me in!"]</strong> - prints link "Log me in!" that affiliate can use to login to his panel
18	<br />
19	<strong>[affiliate item="loginurl_raw"]</strong> - prints raw url link: http://www.yoursite.com/affiliate/affiliates/panel.php?S=sessionid
20	<br />
21	<strong>[affiliate item="<i>OTHER_ATTRIBUTES</i>"]</strong> - prints other affiliate attributes.
22	<br />
23	<br />
24	The <i>OTHER_ATTRIBUTES</i> can be one of these items:
25	<ul>
26	<li><strong>userid</strong> - ID of user</li>
27	<li><strong>refid</strong> - user referral ID</li>
28	<li><strong>rstatus</strong> - user status</li>
29	<li><strong>minimumpayout</strong> - amount of the minimum payout for user</li>
30	<li><strong>payoutoptionid</strong> - ID of the payout option used by user</li>
31	<li><strong>note</strong> - user note</li>
32	<li><strong>photo</strong> - URL of user image</li>
33	<li><strong>username</strong> - username</li>
34	<li><strong>rpassword</strong> - user password</li>
35	<li><strong>firstname</strong> - user first name</li>
36	<li><strong>lastname</strong> - user last name</li>
37	<li><strong>parentuserid</strong> - ID of parent user</li>
38	<li><strong>ip</strong> - user signup IP address</li>
39	<li><strong>notificationemail</strong> - user notification email</li>
40	<li><strong>data1</strong> to <strong>data25</strong> - user data fields</li>
41	</ul>
42	<br />Example of getting user notification email:
43	<br />[affiliate item="notificationemail"]
44	<br />
45	<br />You can get the same values of affiliate parent, instead of 'affiliate' shortcode use 'parent' and then the needed item. E.g. for parent name use this: [parent item="name"/]
46	<br />
47	<br />
48	It is also possible to get <strong>affiliate's unpaid commissions</strong> (balance). To do this use this shortcode:
49	<br />
50	<strong>[affiliate item="unpaidCommissions"]</strong> - prints value of all unpaid commissions
51	<br />
52	<br />
53	You can also get commissions of a specified time period. To do so use the 'timeframe' attribute. Here are the available values:
54	<ul>
55	<li>timeframe=<strong>"yesterday"</strong> - for commissions of yesterday</li>
56	<li>timeframe=<strong>"week"</strong> - for last week</li>
57	<li>timeframe=<strong>"month"</strong> - for last month</li>
58	<li>timeframe=<strong>"30"</strong> - for last 30 days</li>
59	<li>timeframe=<strong>"year"</strong> - for this year</li>
60	<li>timeframe=<strong>"lastyear"</strong> - for last year</li>
61	</ul>
62	<br />Example of getting affiliate's commission balance of last week:
63	<br />[affiliate item="unpaidCommissions" timeframe="week"]
64	</div>
65
66	<h3>Widgets</h3>
67	<div>
68	As a widget, you can use Top Affiliates widget created by this plugin. The widget works for all site visitors, not only to the logged ones. With the Top Affiliates widget you can show the best performing affiliates and their details.
69	<br /> If you want to set it up navigate to <strong>Appearance> Widgets</strong> section and add the <strong>Top Affiliates</strong> widget. When added, you can configure the number of affiliates who should be included in the result, set a value to be used for ordering and you can also define the template of the result.
70	<br /> You can use these variables:
71	<br />
72	<strong>{$firstname}</strong>
73	<br />
74	<strong>{$lastname}</strong>
75	<br />
76	<strong>{$userid}</strong>
77	<br />
78	<strong>{$parentuserid}</strong>
79	<br />
80	<strong>{$clicksAll}</strong>
81	<br />
82	<strong>{$salesCount}</strong>
83	<br />
84	<strong>{$commissions}</strong>
85	</div>
86	</div>
87	<!-- END: main -->