Changeset 13446 for trunk/src/bp-core/deprecated/12.0.php

Timestamp:

04/04/2023 01:06:03 AM (19 months ago)

Author:

imath

Message:

Use the BP Rewrites API to generate single Groups item links

• Introduce the bp_groups_get_path_chunks() function to build BP Rewrites arguments using a regular array.
• Improve bp_members_get_path_chunks() so that it avoids looking for a custom slug when the chunk is a numeric value.
• Introduce the bp_get_group_manage_url() function to build Group's front-end Admin URLs using BP Rewrites.
• Deprecate bp_group_admin_permalink() & bp_get_group_admin_permalink() in favor of bp_group_manage_url() & bp_get_group_manage_url().
• Replace all remaining usage of bp_get_group_permalink() in favor of bp_get_group_url() or bp_get_group_manage_url().

Props r-a-y, johnjamesjacoby, boonebgorges

Closes ​https://github.com/buddypress/buddypress/pull/81
See #4954

File:

• trunk/src/bp-core/deprecated/12.0.php (modified) (1 diff)

trunk/src/bp-core/deprecated/12.0.php

@@ -297 +297 @@
     _deprecated_function( __FUNCTION__, '12.0.0', 'bp_displayed_user_url()' );
     bp_displayed_user_url();
+}
+
+/**
+ * Output the permalink for the group.
+ *
+ * @since 1.0.0
+ * @deprecated 12.0.0
+ *
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
+ */
+function bp_group_permalink( $group = false ) {
+    _deprecated_function( __FUNCTION__, '12.0.0', 'bp_group_url' );
+    bp_group_url( $group );
+}
+/**
+ * Return the permalink for the group.
+ *
+ * @since 1.0.0
+ * @since 10.0.0 Updated to use `bp_get_group`.
+ * @deprecated 12.0.0
+ *
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
+ * @return string
+ */
+function bp_get_group_permalink( $group = false ) {
+    $url = bp_get_group_url( $group );
+
+    /**
+     * Filters the permalink for the group.
+     *
+     * @since 1.0.0
+     * @since 2.5.0 Added the `$group` parameter.
+     * @deprecated 12.0.0
+     *
+     * @param string          $url   Permalink for the group.
+     * @param BP_Groups_Group $group The group object.
+     */
+    return apply_filters_deprecated( 'bp_get_group_permalink', array( $url, $group ), '12.0.0', 'bp_get_group_url' );
+}
+
+/**
+ * Output the permalink for the admin section of the group.
+ *
+ * @since 1.0.0
+ * @deprecated 12.0.0
+ *
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
+ */
+function bp_group_admin_permalink( $group = false ) {
+    _deprecated_function( __FUNCTION__, '12.0.0', 'bp_group_manage_url' );
+    bp_group_manage_url( $group );
+}
+
+/**
+ * Return the permalink for the admin section of the group.
+ *
+ * @since 1.0.0
+ * @since 10.0.0 Updated to use `bp_get_group`.
+ * @deprecated 12.0.0
+ *
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
+ * @return string
+ */
+function bp_get_group_admin_permalink( $group = false ) {
+    _deprecated_function( __FUNCTION__, '12.0.0', 'bp_get_group_manage_url' );
+    $permalink = bp_get_group_manage_url( $group );
+
+    /**
+     * Filters the permalink for the admin section of the group.
+     *
+     * @since 1.0.0
+     * @since 2.5.0 Added the `$group` parameter.
+     * @deprecated 12.0.0
+     *
+     * @param string          $permalink Permalink for the admin section of the group.
+     * @param BP_Groups_Group $group     The group object.
+     */
+    return apply_filters_deprecated( 'bp_get_group_admin_permalink', array( $permalink, $group ), '12.0.0', 'bp_get_group_manage_url' );
 }