Changeset 13619

Timestamp:

10/24/2023 03:47:44 AM (15 months ago)

Author:

imath

Message:

Improve inline doc for Members & Groups get_path_chunks() functions

• bp_members_get_path_chunks() & bp_groups_get_path_chunks(): clearly inform these functions goal is to return customized slugs.
• Add missing inline comment for the bp_groups_get_path_chunks() $context parameter.

See #8923

Location:

trunk/src

Files:

• bp-groups/bp-groups-functions.php (modified) (1 diff)
• bp-members/bp-members-functions.php (modified) (2 diffs)

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

@@ -4026 +4026 @@
 
 /**
- * Get single group's path chunks using an array of URL slugs.
+ * Get single Groups item customized path chunks using an array of BP URL default slugs.
  *
  * @since 12.0.0
  *
- * @param array $chunks An array of URL slugs.
- * @return array An array of BP Rewrites URL arguments.
+ * @param array $chunks   An array of BP URL default slugs.
+ * @param string $context Whether to get chunks for the 'read', 'create' or 'manage' contexts.
+ * @return array An associative array containing group's customized path chunks.
  */
 function bp_groups_get_path_chunks( $chunks = array(), $context = 'read' ) {

trunk/src/bp-members/bp-members-functions.php

@@ -140 +140 @@
 
 /**
- * Get single member's path chunks using an array of URL slugs.
+ * Get single Members item customized path chunks using an array of BP URL default slugs.
  *
  * @since 12.0.0
  *
- * @param array $chunks An array of URL slugs.
- * @return array An array of BP Rewrites URL arguments.
+ * @param array $chunks An array of BP URL default slugs.
+ * @return array An associative array containing member's customized path chunks.
  */
 function bp_members_get_path_chunks( $chunks = array() ) {
@@ -184 +184 @@
 
 /**
- * Return the Mmbers single item's URL.
+ * Return the Members single item's URL.
  *
  * @since 12.0.0