<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][12801] trunk/src: Group Types: improve the `bp_group_type_list()` template tag</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/12801">12801</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12801","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-11-20 17:47:32 +0000 (Fri, 20 Nov 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Group Types: improve the `bp_group_type_list()` template tag
- Make sure to avoid displaying empty links if the Group Types object's `has_directory` property is set to `false`.
- To improve consistency with the Groups directory message informing it is filtered according to a Group Type, use singular Group Type names for the texts used into the list.
- Edit The `$r['label']` argument of the ` bp_get_group_type_list()` function so that it accepts an array containing the plural & singular labels to use according to the Group's number of group types it is assigned to.
- Ensure backward compatibility in case developers are still using a string for this `$r['label']` argument.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8401">#8401</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupstemplatephp">trunk/src/bp-groups/bp-groups-template.php</a></li>
<li><a href="#trunksrcbptemplatesbpnouveaubuddypressgroupssinglecoverimageheaderphp">trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/cover-image-header.php</a></li>
<li><a href="#trunksrcbptemplatesbpnouveaubuddypressgroupssinglegroupheaderphp">trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/group-header.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-template.php 2020-11-20 17:00:59 UTC (rev 12800)
+++ trunk/src/bp-groups/bp-groups-template.php 2020-11-20 17:47:32 UTC (rev 12801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -190,7 +190,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return sprintf( '<a href="%s">%s</a>', esc_url( bp_get_group_type_directory_permalink( $group_type ) ), bp_groups_get_group_type_object( $group_type )->labels['name'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $group_type_object = bp_groups_get_group_type_object( $group_type );
+
+ if ( ! isset( $group_type_object->labels['name'] ) ) {
+ return '';
+ }
+
+ $group_type_text = $group_type_object->labels['name'];
+ if ( isset( $group_type_object->labels['singular_name'] ) && $group_type_object->labels['singular_name'] ) {
+ $group_type_text = $group_type_object->labels['singular_name'];
+ }
+
+ if ( empty( $group_type_object->has_directory ) ) {
+ return esc_html( $group_type_text );
+ }
+
+ return sprintf(
+ '<a href="%s">%s</a>',
+ esc_url( bp_get_group_type_directory_permalink( $group_type ) ),
+ esc_html( $group_type_text )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -206,19 +225,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Return a comma-delimited list of group types.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 The `$r['label']` argument now also accept an array containing the
+ * plural & singular labels to use according to the Group's number of
+ * group types it is assigned to.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $group_id Group ID. Defaults to current group ID if on a group page.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $r {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of parameters. All items are optional.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $parent_element Element to wrap around the list. Defaults to 'p'.
- * @type array $parent_attr Element attributes for parent element. Defaults to
- * array( 'class' => 'bp-group-type-list' ).
- * @type string $label Label to add before the list. Defaults to 'Group Types:'.
- * @type string $label_element Element to wrap around the label. Defaults to 'strong'.
- * @type array $label_attr Element attributes for label element. Defaults to array().
- * @type bool $show_all Whether to show all registered group types. Defaults to 'false'. If
- * 'false', only shows group types with the 'show_in_list' parameter set to
- * true. See bp_groups_register_group_type() for more info.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $parent_element Element to wrap around the list. Defaults to 'p'.
+ * @type array $parent_attr Element attributes for parent element. Defaults to
+ * array( 'class' => 'bp-group-type-list' ).
+ * @type string|array $label Plural and singular labels to add before the list. Defaults to
+ * array( 'plural' => 'Group Types:', 'singular' => 'Group Type:' ).
+ * @type string $label_element Element to wrap around the label. Defaults to 'strong'.
+ * @type array $label_attr Element attributes for label element. Defaults to array().
+ * @type bool $show_all Whether to show all registered group types. Defaults to 'false'. If
+ * 'false', only shows group types with the 'show_in_list' parameter set to
+ * true. See bp_groups_register_group_type() for more info.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,7 +257,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent_attr' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'class' => 'bp-group-type-list',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'label' => __( 'Group Types:', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'label' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'label_element' => 'strong',
</span><span class="cx" style="display: block; padding: 0 10px"> 'label_attr' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_all' => false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -244,6 +267,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'group_type_list'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Should the label be output?
+ $has_label = ! empty( $r['label'] );
+
+ // Ensure backward compatibility in case developers are still using a string.
+ if ( ! is_array( $r['label'] ) ) {
+ $r['label'] = array(
+ 'plural' => __( 'Group Types:', 'buddypress' ),
+ );
+ }
+
+ $labels = wp_parse_args(
+ $r['label'],
+ array(
+ 'plural' => __( 'Group Types:', 'buddypress' ),
+ 'singular' => __( 'Group Type:', 'buddypress' ),
+ )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $retval = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $types = bp_groups_get_group_type( $group_id, false ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -256,12 +297,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $before = $after = $label = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = count( $types );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 1 === $count ) {
+ $label_text = $labels['singular'];
+ } else {
+ $label_text = $labels['plural'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Render parent element.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['parent_element'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $parent_elem = new BP_Core_HTML_Element( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'element' => $r['parent_element'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'attr' => $r['parent_attr']
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'attr' => $r['parent_attr'],
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Set before and after.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -274,13 +322,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $label = new BP_Core_HTML_Element( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'element' => $r['label_element'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'attr' => $r['label_attr'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'inner_html' => esc_html( $r['label'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'inner_html' => esc_html( $label_text ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $label = $label->contents() . ' ';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // No element, just the label.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- $label = esc_html( $r['label'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $has_label ) {
+ $label = esc_html( $label_text );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The list of types.
</span></span></pre></div>
<a id="trunksrcbptemplatesbpnouveaubuddypressgroupssinglecoverimageheaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/cover-image-header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/cover-image-header.php 2020-11-20 17:00:59 UTC (rev 12800)
+++ trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/cover-image-header.php 2020-11-20 17:47:32 UTC (rev 12801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,7 +46,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_group_type_list(
</span><span class="cx" style="display: block; padding: 0 10px"> bp_get_group_id(),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'label' => __( 'Group Types', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'label' => array(
+ 'plural' => __( 'Group Types', 'buddypress' ),
+ 'singular' => __( 'Group Type', 'buddypress' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'list_element' => 'span',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunksrcbptemplatesbpnouveaubuddypressgroupssinglegroupheaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/group-header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/group-header.php 2020-11-20 17:00:59 UTC (rev 12800)
+++ trunk/src/bp-templates/bp-nouveau/buddypress/groups/single/group-header.php 2020-11-20 17:47:32 UTC (rev 12801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,7 +43,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_group_type_list(
</span><span class="cx" style="display: block; padding: 0 10px"> bp_get_group_id(),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'label' => __( 'Group Types', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'label' => array(
+ 'plural' => __( 'Group Types', 'buddypress' ),
+ 'singular' => __( 'Group Type', 'buddypress' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'list_element' => 'span',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre>
</div>
</div>
</body>
</html>