Skip to:
Content

BuddyPress.org

Changeset 13619


Ignore:
Timestamp:
10/24/2023 03:47:44 AM (9 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:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-functions.php

    r13525 r13619  
    40264026
    40274027/**
    4028  * Get single group's path chunks using an array of URL slugs.
     4028 * Get single Groups item customized path chunks using an array of BP URL default slugs.
    40294029 *
    40304030 * @since 12.0.0
    40314031 *
    4032  * @param array $chunks An array of URL slugs.
    4033  * @return array An array of BP Rewrites URL arguments.
     4032 * @param array $chunks   An array of BP URL default slugs.
     4033 * @param string $context Whether to get chunks for the 'read', 'create' or 'manage' contexts.
     4034 * @return array An associative array containing group's customized path chunks.
    40344035 */
    40354036function bp_groups_get_path_chunks( $chunks = array(), $context = 'read' ) {
  • trunk/src/bp-members/bp-members-functions.php

    r13499 r13619  
    140140
    141141/**
    142  * Get single member's path chunks using an array of URL slugs.
     142 * Get single Members item customized path chunks using an array of BP URL default slugs.
    143143 *
    144144 * @since 12.0.0
    145145 *
    146  * @param array $chunks An array of URL slugs.
    147  * @return array An array of BP Rewrites URL arguments.
     146 * @param array $chunks An array of BP URL default slugs.
     147 * @return array An associative array containing member's customized path chunks.
    148148 */
    149149function bp_members_get_path_chunks( $chunks = array() ) {
     
    184184
    185185/**
    186  * Return the Mmbers single item's URL.
     186 * Return the Members single item's URL.
    187187 *
    188188 * @since 12.0.0
Note: See TracChangeset for help on using the changeset viewer.