bbp-private-groups / includes / programmers_help.php

programmers_help.php in Private groups trunk, at includes/programmers_help.php

58 lines 1.7 KB

Raw Download Zip

1	<?php
2
3
4
5	function rpg_programmers_help () {
6	?>
7	<table class="form-table">
8
9
10
11	<tr valign="top">
12	<th colspan="2">
13
14	<h4><?php _e ('Programmers help' , 'bbp-private-groups' ) ; ?> </h4>
15
16
17
18	<p><?php _e ('Database : ', 'bbp-private-groups') ; ?></p>
19
20	<p><?php _e ('Users are set in usermeta meta_key \'private_group\' and groups are named \'group1\', \'group2\' etc. and seperated by \'\' so an entry might be \'group1group3\' ' , 'bbp-private-groups') ; ?></p>
21
22	<p><?php _e ('Groups for forums are set in postmeta against \'_private_group\' with an entry per group ' , 'bbp-private-groups') ; ?></p>
23
24	<p><?php _e ('Group names are set in options under \'rpg_groups\' ' , 'bbp-private-groups') ; ?></p>
25
26
27
28	</td></tr>
29
30	<tr valign="top">
31	<th colspan="2">
32
33	<h3><?php _e ('Add and remove users from groups' , 'bbp-private-groups' ) ; ?> </h3>
34
35	<p><?php _e ('Included in this plugin is a class to allow programmers to interact with this plugin and add or remove users from groups' , 'bbp-private-groups') ; ?></p>
36
37
38	<p><?php _e('example use:', 'bbp-private-groups') ; ?></p>
39
40	<p><?php _e('$user_id = 1191 ;', 'bbp-private-groups') ; ?></p>
41	<p><?php _e('$group = \'group2\' ;', 'bbp-private-groups') ; ?></p>
42	<p><?php _e('$bbp_private_groups_adds = new rpg_Bbp_Private_Groups_Adds( $user_id , $group );', 'bbp-private-groups') ; ?></p>
43	<p><?php _e('then', 'bbp-private-groups') ; ?></p>
44	<p><?php _e('$bbp_private_groups_adds->add() ;', 'bbp-private-groups') ; ?></p>
45	<p><?php _e('or', 'bbp-private-groups') ; ?></p>
46	<p><?php _e('$bbp_private_groups_adds->remove() ;', 'bbp-private-groups') ; ?></p>
47
48
49
50	</tr>
51
52
53	</table>
54	</div><!--end sf-wrap-->
55	</div><!--end wrap-->
56	<?php
57	}
58	?>