Context Navigation

Back to Ticket #6749

Ticket #6749: 6749-2.suggestions.patch

File 6749-2.suggestions.patch, 29.5 KB (added by imath, 4 years ago)

src/bp-groups/bp-groups-functions.php

diff --git src/bp-groups/bp-groups-functions.php src/bp-groups/bp-groups-functions.php
index 3a4062df8..b23780ae4 100644

  function groups_get_group( $group_id ) {
+ *
  * @since 10.0.0
+ *
+ * @param string|int $field (Required) The field to retrieve the group. id | ID | slug.
+ * @param string|int $value (Required) A value for $field. A group ID or slug.
+ * @return BP_Groups_Group|false BP_Groups_Group object on success, false on failure.
+ * @param string     $field (Required) The field to use to retrieve the group.
+ *                          Possible values are `'id'` or `'slug'`.
+ * @param string|int $value (Required) A value for the $field. A Group ID or slug.
+ * @return BP_Groups_Group|false The Group object if found, false otherwise.
  */
 function bp_get_group_by( $field, $value ) {
         $group_id = $value;
-…
+ function bp_get_group_by( $field, $value ) {
+}
 /**
+ * Retrieve a group, defaults to the current group in loop at BP_Groups_Template.
+ * Retrieve a Group.
+ *
+ * When used into the context of a Groups loop built by the `BP_Groups_Template` class, it defaults to the
+ * Group being iterated on.
+ *
  * @since 10.0.0
+ *
  * @param int|string|BP_Groups_Group $group (Optional) Group identifier.
  *                                          Default: current group in loop.
  * @return BP_Groups_Group|false BP_Groups_Group object on success, false on failure.
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
+ * @return BP_Groups_Group|false                  The Group object if found, false otherwise.
  */
 function bp_get_group( $group = false ) {
         global $groups_template;

src/bp-groups/bp-groups-template.php

diff --git src/bp-groups/bp-groups-template.php src/bp-groups/bp-groups-template.php
index 0ca2afbcb..58b0bc539 100644

		function bp_the_group() {
560	560	* @since 1.0.0
561	561	* @since 10.0.0 Updated to use `bp_get_group` and added the `$user_id` parameter.
562	562	*
563		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
564		* ~~Default: current group in loop~~.
565		* @param int $user_id ID of the User.
566		* ~~Default: current logged in user~~.
567		* @return bool
	563	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	564	* Default: false.
	565	* @param int $user_id ID of the User.
	566	* Default: current logged in user ID.
	567	* @return bool True if the Group is accessible to the user. False otherwise.
568	568	*/
569	569	function bp_group_is_visible( $group = false, $user_id = 0 ) {
570	570	$group = bp_get_group( $group );
…	…	function bp_group_is_visible( $group = false, $user_id = 0 ) {
585	585	*
586	586	* @since 1.0.0
587	587	*
588		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
589		* ~~Default: current group in loop~~.
	588	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	589	* Default: false.
590	590	*/
591	591	function bp_group_id( $group = false ) {
592	592	echo bp_get_group_id( $group );
…	…	function bp_group_id( $group = false ) {
595	595	* Get the ID of the group.
596	596	*
597	597	* @since 1.0.0
598		* @since 10.0.0 Updated to use `bp_get_group`
	598	* @since 10.0.0 Updated to use `bp_get_group`.
599	599	*
600		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
601		* Default: ~~current group in loop~~.
	600	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	601	* Default: false.
602	602	* @return int
603	603	*/
604	604	function bp_get_group_id( $group = false ) {
…	…	function bp_group_class( $classes = array() ) {
706	706	*
707	707	* @since 1.0.0
708	708	*
709		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
710		* ~~Default: current group in loop~~.
	709	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	710	* Default: false.
711	711	*/
712	712	function bp_group_name( $group = false ) {
713	713	echo bp_get_group_name( $group );
…	…	function bp_group_name( $group = false ) {
718	718	* @since 1.0.0
719	719	* @since 10.0.0 Updated to use `bp_get_group`
720	720	*
721		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
722		* Default: current group in loop.
	721	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	722	* Default: current group in loop.
723	723	* @return string
724	724	*/
725	725	function bp_get_group_name( $group = false ) {
…	…	function bp_group_name( $group = false ) {
746	746	*
747	747	* @since 1.0.0
748	748	*
749		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
750		* ~~Default: current group in loop~~.
	749	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	750	* Default: false.
751	751	*/
752	752	function bp_group_type( $group = false ) {
753	753	echo bp_get_group_type( $group );
…	…	function bp_group_type( $group = false ) {
758	758	* @since 1.0.0
759	759	* @since 10.0.0 Updated to use `bp_get_group`
760	760	*
761		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
762		* ~~Default: current group in loop~~.
	761	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	762	* Default: false.
763	763	* @return string
764	764	*/
765	765	function bp_get_group_type( $group = false ) {
…	…	function bp_group_type( $group = false ) {
796	796	*
797	797	* @since 1.1.0
798	798	*
799		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
800		* ~~Default: current group in loop~~.
	799	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	800	* Default: false.
801	801	*/
802	802	function bp_group_status( $group = false ) {
803	803	echo bp_get_group_status( $group );
…	…	function bp_group_status( $group = false ) {
808	808	* @since 1.1.0
809	809	* @since 10.0.0 Updated to use `bp_get_group`
810	810	*
811		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
812		* ~~Default: current group in loop~~.
	811	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	812	* Default: false.
813	813	* @return string
814	814	*/
815	815	function bp_get_group_status( $group = false ) {
…	…	function bp_group_status( $group = false ) {
840	840	* @param array\|string $args {
841	841	* See {@link bp_get_group_avatar()} for description of arguments.
842	842	* }
843		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
844		* ~~Default: current group in loop~~.
	843	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	844	* Default: false.
845	845	*/
846	846	function bp_group_avatar( $args = '', $group = false ) {
847	847	echo bp_get_group_avatar( $args, $group );
…	…	function bp_group_avatar( $args = '', $group = false ) {
854	854	*
855	855	* @see bp_core_fetch_avatar() For a description of arguments and return values.
856	856	*
857		* @param array\|string $args {
	857	* @param array\|string $args {
858	858	* Arguments are listed here with an explanation of their defaults.
859	859	* For more information about the arguments, see {@link bp_core_fetch_avatar()}.
860	860	*
…	…	function bp_group_avatar( $args = '', $group = false ) {
863	863	* @type int\|bool $height Default: false.
864	864	* @type string $class Default: 'avatar'.
865	865	* @type bool $no_grav Default: false.
866		* @type bool $html Default: ~~fals~~e.
	866	* @type bool $html Default: true.
867	867	* @type string\|bool $id Passed to `$css_id` parameter. Default: false.
868	868	* @type string $alt Default: 'Group logo of [group name]'.
869	869	* }
870		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
871		* ~~Default: current group in loop~~.
872		* @return string\|bool ~~Group avatar string~~ or false if avatar uploads is disabled.
	870	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	871	* Default: false.
	872	* @return string\|bool HTML output for the Group Avatar. or false if avatar uploads is disabled.
873	873	*/
874	874	function bp_get_group_avatar( $args = '', $group = false ) {
875	875	$group = bp_get_group( $group );
…	…	function bp_group_avatar( $args = '', $group = false ) {
892	892	'height' => false,
893	893	'class' => 'avatar',
894	894	'no_grav' => false,
895		'html' => ~~fals~~e,
	895	'html' => true,
896	896	'id' => false,
897	897	// translators: %1$s is the name of the group.
898	898	'alt' => sprintf( __( 'Group logo of %1$s', 'buddypress' ), $group->name ),
…	…	function bp_group_avatar( $args = '', $group = false ) {
943	943	*
944	944	* @since 1.0.0
945	945	*
946		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
947		* ~~Default: current group in loop~~.
	946	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	947	* Default: false.
948	948	*/
949	949	function bp_group_avatar_thumb( $group = false ) {
950	950	echo bp_get_group_avatar_thumb( $group );
…	…	function bp_group_avatar_thumb( $group = false ) {
954	954	*
955	955	* @since 1.0.0
956	956	*
957		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
958		* ~~Default: current group in loop~~.
959		* @return string
	957	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	958	* Default: false.
	959	* @return string HTML output for the Group Avatar.
960	960	*/
961	961	function bp_get_group_avatar_thumb( $group = false ) {
962	962	return bp_get_group_avatar(
…	…	function bp_group_avatar_thumb( $group = false ) {
973	973	*
974	974	* @since 1.0.0
975	975	*
976		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
977		* ~~Default: current group in loop~~.
	976	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	977	* Default: false.
978	978	*/
979	979	function bp_group_avatar_mini( $group = false ) {
980	980	echo bp_get_group_avatar_mini( $group );
…	…	function bp_group_avatar_mini( $group = false ) {
984	984	*
985	985	* @since 1.0.0
986	986	*
987		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
988		* ~~Default: current group in loop~~.
989		* @return string
	987	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	988	* Default: false.
	989	* @return string HTML output for the Group Avatar.
990	990	*/
991	991	function bp_get_group_avatar_mini( $group = false ) {
992	992	return bp_get_group_avatar(
…	…	function bp_group_avatar_mini( $group = false ) {
1005	1005	*
1006	1006	* @since 10.0.0
1007	1007	*
1008		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1009		* ~~Default: current group in loop~~.
1010		* @param string $type Optional. The type of the avatar ('full' or 'thumb').
1011		* Default 'full'.
	1008	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1009	* Default: false.
	1010	* @param string $type Optional. The type of the avatar ('full' or 'thumb').
	1011	* Default 'full'.
1012	1012	*/
1013	1013	function bp_group_avatar_url( $group = false, $type = 'full' ) {
1014	1014	echo bp_get_group_avatar_url( $group, $type );
…	…	function bp_group_avatar_url( $group = false, $type = 'full' ) {
1019	1019	* @since 5.0.0
1020	1020	* @since 10.0.0 Updated to use `bp_get_group_avatar`
1021	1021	*
1022		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1023		* ~~Default: current group in loop~~.
1024		* @param string $type Optional. The type of the avatar ('full' or 'thumb').
1025		* Default 'full'.
	1022	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1023	* Default: false.
	1024	* @param string $type Optional. The type of the avatar ('full' or 'thumb').
	1025	* Default 'full'.
1026	1026	* @return string
1027	1027	*/
1028	1028	function bp_get_group_avatar_url( $group = false, $type = 'full' ) {
…	…	function bp_group_use_cover_image_header() {
1048	1048	* @since 5.0.0
1049	1049	* @since 10.0.0 Updated to use `bp_get_group`
1050	1050	*
1051		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1052		* ~~Default: current group in loop~~.
1053		* @return string The cover image URL or empty string if not found.
	1051	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1052	* Default: false.
	1053	* @return string The cover image URL or empty string if not found.
1054	1054	*/
1055	1055	function bp_get_group_cover_url( $group = false ) {
1056	1056	$group = bp_get_group( $group );
…	…	function bp_get_group_cover_url( $group = false ) {
1080	1080	* @since 1.0.0
1081	1081	* @since 2.7.0 Added `$args` as a parameter.
1082	1082	*
1083		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1084		* ~~Default: current group in loop~~.
1085		* @param array\|string $args Optional. {@see bp_get_group_last_active()}.
	1083	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1084	* Default: false.
	1085	* @param array\|string $args Optional. {@see bp_get_group_last_active()}.
1086	1086	*/
1087	1087	function bp_group_last_active( $group = false, $args = array() ) {
1088	1088	echo bp_get_group_last_active( $group, $args );
…	…	function bp_group_last_active( $group = false, $args = array() ) {
1094	1094	* @since 2.7.0 Added `$args` as a parameter.
1095	1095	* @since 10.0.0 Updated to use `bp_get_group`
1096	1096	*
1097		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1098		* ~~Default: current group in loop~~.
	1097	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1098	* Default: false.
1099	1099	* @param array\|string $args {
1100	1100	* Array of optional parameters.
1101	1101	*
…	…	function bp_group_last_active( $group = false, $args = array() ) {
1148	1148	*
1149	1149	* @since 1.0.0
1150	1150	*
1151		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1152		* ~~Default: current group in loop~~.
	1151	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1152	* Default: false.
1153	1153	*/
1154	1154	function bp_group_permalink( $group = false ) {
1155	1155	echo bp_get_group_permalink( $group );
…	…	function bp_group_permalink( $group = false ) {
1160	1160	* @since 1.0.0
1161	1161	* @since 10.0.0 Updated to use `bp_get_group`
1162	1162	*
1163		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1164		* ~~Default: current group in loop~~.
	1163	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1164	* Default: false.
1165	1165	* @return string
1166	1166	*/
1167	1167	function bp_get_group_permalink( $group = false ) {
…	…	function bp_group_permalink( $group = false ) {
1188	1188	*
1189	1189	* @since 2.9.0
1190	1190	*
1191		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1192		* ~~Default: current group in loop~~.
	1191	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1192	* Default: false.
1193	1193	*/
1194	1194	function bp_group_link( $group = false ) {
1195	1195	echo bp_get_group_link( $group );
…	…	function bp_group_link( $group = false ) {
1200	1200	* @since 2.9.0
1201	1201	* @since 10.0.0 Updated to use `bp_get_group`
1202	1202	*
1203		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1204		* ~~Default: current group in loop~~.
	1203	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1204	* Default: false.
1205	1205	* @return string
1206	1206	*/
1207	1207	function bp_get_group_link( $group = false ) {
…	…	function bp_group_link( $group = false ) {
1234	1234	*
1235	1235	* @since 1.0.0
1236	1236	*
1237		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1238		* ~~Default: current group in loop~~.
	1237	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1238	* Default: false.
1239	1239	*/
1240	1240	function bp_group_admin_permalink( $group = false ) {
1241	1241	echo bp_get_group_admin_permalink( $group );
…	…	function bp_group_admin_permalink( $group = false ) {
1246	1246	* @since 1.0.0
1247	1247	* @since 10.0.0 Updated to use `bp_get_group`
1248	1248	*
1249		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1250		* ~~Default: current group in loop~~.
	1249	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1250	* Default: false.
1251	1251	* @return string
1252	1252	*/
1253	1253	function bp_get_group_admin_permalink( $group = false ) {
…	…	function bp_group_admin_permalink( $group = false ) {
1274	1274	*
1275	1275	* @since 1.0.0
1276	1276	*
1277		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1278		* ~~Default: current group in loop~~.
	1277	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1278	* Default: false.
1279	1279	*/
1280	1280	function bp_group_slug( $group = false ) {
1281	1281	echo bp_get_group_slug( $group );
…	…	function bp_group_slug( $group = false ) {
1286	1286	* @since 1.0.0
1287	1287	* @since 10.0.0 Updated to use `bp_get_group`
1288	1288	*
1289		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1290		* ~~Default: current group in loop~~.
	1289	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1290	* Default: false.
1291	1291	* @return string
1292	1292	*/
1293	1293	function bp_get_group_slug( $group = false ) {
…	…	function bp_group_slug( $group = false ) {
1314	1314	*
1315	1315	* @since 1.0.0
1316	1316	*
1317		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1318		* ~~Default: current group in loop~~.
	1317	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1318	* Default: false.
1319	1319	*/
1320	1320	function bp_group_description( $group = false ) {
1321	1321	echo bp_get_group_description( $group );
…	…	function bp_group_description( $group = false ) {
1326	1326	* @since 1.0.0
1327	1327	* @since 10.0.0 Updated to use `bp_get_group`
1328	1328	*
1329		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1330		* ~~Default: current group in loop~~.
	1329	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1330	* Default: false.
1331	1331	* @return string
1332	1332	*/
1333	1333	function bp_get_group_description( $group = false ) {
…	…	function bp_group_description( $group = false ) {
1354	1354	*
1355	1355	* @since 1.0.0
1356	1356	*
1357		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1358		* ~~Default: current group in loop~~.
	1357	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1358	* Default: false.
1359	1359	*/
1360	1360	function bp_group_description_editable( $group = false ) {
1361	1361	echo bp_get_group_description_editable( $group );
…	…	function bp_group_description_editable( $group = false ) {
1370	1370	* @since 1.0.0
1371	1371	* @since 10.0.0 Updated to use `bp_get_group`
1372	1372	*
1373		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1374		* ~~Default: current group in loop~~.
	1373	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1374	* Default: false.
1375	1375	* @return string
1376	1376	*/
1377	1377	function bp_get_group_description_editable( $group = false ) {
…	…	function bp_group_description_editable( $group = false ) {
1401	1401	*
1402	1402	* @since 1.0.0
1403	1403	*
1404		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1405		* ~~Default: current group in loop~~.
1406		* @param int ~~$length Optional.~~ Length of returned string, including ellipsis.
1407		* Default: 225.
	1404	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1405	* Default:false.
	1406	* @param int $length (Optional) Length of returned string, including ellipsis.
	1407	* Default: 225.
1408	1408	*/
1409	1409	function bp_group_description_excerpt( $group = false, $length = 225 ) {
1410	1410	echo bp_get_group_description_excerpt( $group, $length );
…	…	function bp_group_description_excerpt( $group = false, $length = 225 ) {
1415	1415	* @since 1.0.0
1416	1416	* @since 10.0.0 Updated to use `bp_get_group`
1417	1417	*
1418		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1419		* ~~Default: current group in loop~~.
1420		* @param int ~~$length Optional.~~ Length of returned string, including ellipsis.
1421		* Default: 225.
	1418	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1419	* Default: false.
	1420	* @param int $length (Optional) Length of returned string, including ellipsis.
	1421	* Default: 225.
1422	1422	* @return string
1423	1423	*/
1424	1424	function bp_get_group_description_excerpt( $group = false, $length = 225 ) {
…	…	function bp_group_description_excerpt( $group = false, $length = 225 ) {
1445	1445	* @since 1.0.0
1446	1446	* @since 2.7.0 Added `$args` as a parameter.
1447	1447	*
1448		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1449		* ~~Default: current group in loop~~.
1450		* @param array\|string $args {@see bp_get_group_date_created()}.
	1448	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1449	* Default: false.
	1450	* @param array\|string $args {@see bp_get_group_date_created()}.
1451	1451	*/
1452	1452	function bp_group_date_created( $group = false, $args = array() ) {
1453	1453	echo bp_get_group_date_created( $group, $args );
…	…	function bp_group_date_created( $group = false, $args = array() ) {
1459	1459	* @since 2.7.0 Added `$args` as a parameter.
1460	1460	* @since 10.0.0 Updated to use `bp_get_group`
1461	1461	*
1462		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1463		* ~~Default: current group in loop~~.
1464		* @param array\|string $args {
	1462	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1463	* Default: false.
	1464	* @param array\|string $args {
1465	1465	* Array of optional parameters.
1466	1466	*
1467	1467	* @type bool $relative Optional. If true, returns relative created date. eg. active 5 months ago.
…	…	function bp_group_date_created( $group = false, $args = array() ) {
1505	1505	*
1506	1506	* @since 1.7.0
1507	1507	*
1508		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1509		* ~~Default: current group in loop~~.
	1508	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1509	* Default: false.
1510	1510	*/
1511	1511	function bp_group_creator_username( $group = false ) {
1512	1512	echo bp_get_group_creator_username( $group );
…	…	function bp_group_creator_username( $group = false ) {
1517	1517	* @since 1.7.0
1518	1518	* @since 10.0.0 Updated to use `bp_get_group`
1519	1519	*
1520		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1521		* ~~Default: current group in loop~~.
	1520	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1521	* Default: false.
1522	1522	* @return string
1523	1523	*/
1524	1524	function bp_get_group_creator_username( $group = false ) {
…	…	function bp_group_creator_username( $group = false ) {
1545	1545	*
1546	1546	* @since 1.7.0
1547	1547	*
1548		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1549		* ~~Default: current group in loop~~.
	1548	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1549	* Default: false.
1550	1550	*/
1551	1551	function bp_group_creator_id( $group = false ) {
1552	1552	echo bp_get_group_creator_id( $group );
…	…	function bp_group_creator_id( $group = false ) {
1557	1557	* @since 1.7.0
1558	1558	* @since 10.0.0 Updated to use `bp_get_group`
1559	1559	*
1560		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1561		* ~~Default: current group in loop~~.
	1560	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1561	* Default: false.
1562	1562	* @return int
1563	1563	*/
1564	1564	function bp_get_group_creator_id( $group = false ) {
…	…	function bp_group_creator_id( $group = false ) {
1585	1585	*
1586	1586	* @since 1.7.0
1587	1587	*
1588		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1589		* ~~Default: current group in loop~~.
	1588	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1589	* Default: false.
1590	1590	*/
1591	1591	function bp_group_creator_permalink( $group = false ) {
1592	1592	echo bp_get_group_creator_permalink( $group );
…	…	function bp_group_creator_permalink( $group = false ) {
1597	1597	* @since 1.7.0
1598	1598	* @since 10.0.0 Updated to use `bp_get_group`
1599	1599	*
1600		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1601		* ~~Default: current group in loop~~.
	1600	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1601	* Default: false.
1602	1602	* @return string
1603	1603	*/
1604	1604	function bp_get_group_creator_permalink( $group = false ) {
…	…	function bp_group_creator_permalink( $group = false ) {
1626	1626	* @since 1.7.0
1627	1627	* @since 10.0.0 Updated to use `bp_get_group`
1628	1628	*
1629		* @param ~~int\|string\|BP_Groups_Group $group (Optional) Group identifier~~.
1630		* ~~Default: current group in loop~~.
1631		* @param int $user_id ID of the user.
1632		* Default: current logged in user.
	1629	* @param false\|int\|string\|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
	1630	* Default: false.
	1631	* @param int $user_id ID of the user.
	1632	* Default: current logged in user.
1633	1633	* @return bool
1634	1634	*/
1635	1635	function bp_is_group_creator( $group = false, $user_id = 0 ) {

Trac UI Preferences

Download in other formats:

Original Format

BuddyPress.org

Context Navigation

Ticket #6749: 6749-2.suggestions.patch

src/bp-groups/bp-groups-functions.php

src/bp-groups/bp-groups-template.php

Download in other formats: