Changeset 13432 for trunk/src/bp-core/bp-core-rewrites.php

Timestamp:

03/01/2023 08:17:11 AM (3 years ago)

Author:

imath

Message:

BP Rewrites: introduce the bp_rewrites_get_url() function

Its role is to build every BuddyPress URL using the BP Rewrites API.

This commit also deprecates softly some key functions like bp_get_root_domain() to let us review (thanks to deprecated notices) all BuddyPress links during 12.0 development cycle and make them use the introduced bp_rewrites_get_url() function or a wrapper of it. Once all replacements achieved, we'll need to fully deprecate:

• bp_get_root_domain()
• bp_root_domain()
• bp_core_get_root_domain()

Slug constants have also been completely deprecated as we will be able to customize every slugs from the future "URL" tab of the BuddyPress settings page.

The $bp->root_domain BuddyPress global has been deprecated in favor of $bp->root_url.

Finally, the Components $rewrite_ids properties are now in place and corresponding rewrite rules are successfully generated.

Props r-a-y, johnjamesjacoby, boonebgorges

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

File:

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

trunk/src/bp-core/bp-core-rewrites.php

@@ -44 +44 @@
     );
 }
+
+/**
+ * Delete rewrite rules, so that they are automatically rebuilt on
+ * the subsequent page load.
+ *
+ * @since 12.0.0
+ */
+function bp_delete_rewrite_rules() {
+    delete_option( 'rewrite_rules' );
+}
+
+/**
+ * Are Pretty URLs active?
+ *
+ * @since 12.0.0
+ *
+ * @return bool True if Pretty URLs are on. False otherwise.
+ */
+function bp_has_pretty_urls() {
+    $has_plain_urls = ! get_option( 'permalink_structure', '' );
+    return ! $has_plain_urls;
+}
+
+/**
+ * Returns the slug to use for the view belonging to the requested component.
+ *
+ * @since 12.0.0
+ *
+ * @param string $component_id The BuddyPress component's ID.
+ * @param string $rewrite_id   The view rewrite ID.
+ * @param string $default_slug The view default slug.
+ * @return string The slug to use for the view belonging to the requested component.
+ */
+function bp_rewrites_get_slug( $component_id = '', $rewrite_id = '', $default_slug = '' ) {
+    $directory_pages = bp_core_get_directory_pages();
+    $slug            = $default_slug;
+
+    if ( ! isset( $directory_pages->{$component_id}->custom_slugs ) || ! $rewrite_id ) {
+        return $slug;
+    }
+
+    $custom_slugs = (array) $directory_pages->{$component_id}->custom_slugs;
+    if ( isset( $custom_slugs[ $rewrite_id ] ) && $custom_slugs[ $rewrite_id ] ) {
+        $slug = $custom_slugs[ $rewrite_id ];
+    }
+
+    return $slug;
+}
+
+/**
+ * Builds a BuddyPress link using the WP Rewrite API.
+ *
+ * @since 12.0.0
+ *
+ * @param array $args {
+ *      Optional. An array of arguments.
+ *
+ *      @type string $component_id                The BuddyPress component ID. Defaults ''.
+ *      @type string $directory_type              Whether it's an object type URL. Defaults ''.
+ *                                                Accepts '' (no object type), 'members' or 'groups'.
+ *      @type string $single_item                 The BuddyPress single item's URL chunk. Defaults ''.
+ *                                                Eg: the member's user nicename for Members or the group's slug for Groups.
+ *      @type string $single_item_component       The BuddyPress single item's component URL chunk. Defaults ''.
+ *                                                Eg: the member's Activity page.
+ *      @type string $single_item_action          The BuddyPress single item's action URL chunk. Defaults ''.
+ *                                                Eg: the member's Activity mentions page.
+ *      @type array $single_item_action_variables The list of BuddyPress single item's action variable URL chunks. Defaults [].
+ * }
+ * @return string The BuddyPress link.
+ */
+function bp_rewrites_get_url( $args = array() ) {
+    $bp   = buddypress();
+    $url = get_home_url( bp_get_root_blog_id() );
+
+    $r = bp_parse_args(
+        $args,
+        array(
+            'component_id'                 => '',
+            'directory_type'               => '',
+            'single_item'                  => '',
+            'single_item_component'        => '',
+            'single_item_action'           => '',
+            'single_item_action_variables' => array(),
+        )
+    );
+
+    if ( $r['component_id'] && isset( $bp->{$r['component_id']}->rewrite_ids ) ) {
+        $component = $bp->{$r['component_id']};
+        unset( $r['component_id'] );
+
+        // Using plain links.
+        if ( ! bp_has_pretty_urls() ) {
+            if ( ! isset( $r['member_register'] ) && ! isset( $r['member_activate'] ) ) {
+                $r['directory'] = 1;
+            }
+
+            $r  = array_filter( $r );
+            $qv = array();
+
+            foreach ( $component->rewrite_ids as $key => $rewrite_id ) {
+                if ( ! isset( $r[ $key ] ) ) {
+                    continue;
+                }
+
+                $qv[ $rewrite_id ] = $r[ $key ];
+            }
+
+            $url = add_query_arg( $qv, $url );
+
+            // Using pretty URLs.
+        } else {
+            if ( ! isset( $component->rewrite_ids['directory'] ) || ! isset( $component->directory_permastruct ) ) {
+                return $url;
+            }
+
+            if ( isset( $r['member_register'] ) ) {
+                $url = str_replace( '%' . $component->rewrite_ids['member_register'] . '%', '', $component->register_permastruct );
+                unset( $r['member_register'] );
+            } elseif ( isset( $r['member_activate'] ) ) {
+                $url = str_replace( '%' . $component->rewrite_ids['member_activate'] . '%', '', $component->activate_permastruct );
+                unset( $r['member_activate'] );
+            } elseif ( isset( $r['create_single_item'] ) ) {
+                $create_slug = 'create';
+                if ( 'groups' === $component->id ) {
+                    $create_slug = bp_rewrites_get_slug( 'groups', 'bp_group_create', 'create' );
+                }
+
+                $url = str_replace( '%' . $component->rewrite_ids['directory'] . '%', $create_slug, $component->directory_permastruct );
+                unset( $r['create_single_item'] );
+            } else {
+                $url = str_replace( '%' . $component->rewrite_ids['directory'] . '%', $r['single_item'], $component->directory_permastruct );
+
+                // Remove the members directory slug when root profiles are on.
+                if ( bp_core_enable_root_profiles() && 'members' === $component->id && isset( $r['single_item'] ) && $r['single_item'] ) {
+                    $url = str_replace( $bp->members->root_slug . '/', '', $url );
+                }
+
+                unset( $r['single_item'] );
+            }
+
+            $r = array_filter( $r );
+
+            if ( isset( $r['directory_type'] ) && $r['directory_type'] ) {
+                if ( 'members' === $component->id ) {
+                    array_unshift( $r, bp_get_members_member_type_base() );
+                } elseif ( 'groups' === $component->id && bp_is_active( 'groups' ) ) {
+                    array_unshift( $r, bp_get_groups_group_type_base() );
+                } else {
+                    unset( $r['directory_type'] );
+                }
+            }
+
+            if ( isset( $r['single_item_action_variables'] ) && $r['single_item_action_variables'] ) {
+                $r['single_item_action_variables'] = join( '/', (array) $r['single_item_action_variables'] );
+            }
+
+            if ( isset( $r['create_single_item_variables'] ) && $r['create_single_item_variables'] ) {
+                $r['create_single_item_variables'] = join( '/', (array) $r['create_single_item_variables'] );
+            }
+
+            $url = get_home_url( bp_get_root_blog_id(), user_trailingslashit( '/' . rtrim( $url, '/' ) . '/' . join( '/', $r ) ) );
+        }
+    }
+
+    /**
+     * Filter here to edit any BudyPress URL.
+     *
+     * @since 12.0.0
+     *
+     * @param string $url The BudyPress URL.
+     * @param array  $r {
+     *      Optional. An array of arguments.
+     *
+     *      @type string $component_id                The BuddyPress component ID. Defaults ''.
+     *      @type string $directory_type              Whether it's an object type URL. Defaults ''.
+     *                                                Accepts '' (no object type), 'members' or 'groups'.
+     *      @type string $single_item                 The BuddyPress single item's URL chunk. Defaults ''.
+     *                                                Eg: the member's user nicename for Members or the group's slug for Groups.
+     *      @type string $single_item_component       The BuddyPress single item's component URL chunk. Defaults ''.
+     *                                                Eg: the member's Activity page.
+     *      @type string $single_item_action          The BuddyPress single item's action URL chunk. Defaults ''.
+     *                                                Eg: the member's Activity mentions page.
+     *      @type array $single_item_action_variables The list of BuddyPress single item's action variable URL chunks. Defaults [].
+     * }
+     */
+    return apply_filters( 'bp_rewrites_get_url', $url, $r );
+}
+
+/**
+ * Gets the BP root site URL, using BP Rewrites.
+ *
+ * @since 12.0.0
+ *
+ * @return string The BP root site URL.
+ */
+function bp_rewrites_get_root_url() {
+    $url = bp_rewrites_get_url( array() );
+
+    /**
+     * Filter here to edit the BP root site URL.
+     *
+     * @since 12.0.0
+     *
+     * @param string $url The BP root site URL.
+     */
+    return apply_filters( 'bp_rewrites_get_root_url', $url );
+}