Changeset 13436 for trunk/src/bp-blogs/bp-blogs-template.php

Timestamp:

03/15/2023 08:16:46 AM (21 months ago)

Author:

imath

Message:

Make more BuddyPress generated links ready for BP Rewrites

• Improve the Members component adding permastructs and custom rewrite

rules for registration and activation pages.

• Improve the Blogs component adding custom rewrite rule to handle the

Blogs create page.

• Make a huge progress about replacing all occurrences of

bp_get_root_domain() (45 replacements were performed).

• Deprecate bp_groups_directory_permalink(),

bp_get_groups_directory_permalink(), bp_blogs_directory_permalink() &
bp_get_blogs_directory_permalink() and replace them with these new
functions: bp_groups_directory_url(), bp_get_groups_directory_url(),
bp_blogs_directory_url() & bp_get_blogs_directory_url().

• Although bp_loggedin_user_domain() & bp_displayed_user_domain()

should also be deprecated, we're leaving them as aliases of the right
functions to use. Plugin authors shouldn't use them to build other links
than member's profile home url.

NB: these deprecations are required because these functions were used
to build BuddyPress URLs concatenating URL chunks. Once the BP Classic
plugin will be built we will adapt the code to remove these deprecation
notices.

Props r-a-y, johnjamesjacoby, boonebgorges

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

File:

• trunk/src/bp-blogs/bp-blogs-template.php (modified) (6 diffs)

trunk/src/bp-blogs/bp-blogs-template.php

@@ -68 +68 @@
 
 /**
- * Output blog directory permalink.
- *
- * @since 1.5.0
- *
- */
-function bp_blogs_directory_permalink() {
-    echo esc_url( bp_get_blogs_directory_permalink() );
-}
-    /**
-     * Return blog directory permalink.
-     *
-     * @since 1.5.0
-     *
-     *
-     * @return string The URL of the Blogs directory.
-     */
-    function bp_get_blogs_directory_permalink() {
-
-        /**
-         * Filters the blog directory permalink.
-         *
-         * @since 1.5.0
-         *
-         * @param string $value Permalink URL for the blog directory.
-         */
-        return apply_filters( 'bp_get_blogs_directory_permalink', trailingslashit( bp_get_root_domain() . '/' . bp_get_blogs_root_slug() ) );
-    }
+ * Output Blogs directory's URL.
+ *
+ * @since 12.0.0
+ */
+function bp_blogs_directory_url() {
+    echo esc_url( bp_get_blogs_directory_url() );
+}
+
+/**
+ * Returns the Blogs directory's URL.
+ *
+ * @since 12.0.0
+ *
+ * @param array $path_chunks {
+ *     An array of arguments. Optional.
+ *
+ *     @type int $create_single_item `1` to get the Blogs create link.
+ * }
+ * @return string The URL built for the BP Rewrites URL parser.
+ */
+function bp_get_blogs_directory_url( $path_chunks = array() ) {
+    $supported_chunks = array_fill_keys( array( 'create_single_item' ), true );
+
+    $path_chunks = bp_parse_args(
+        array_intersect_key( $path_chunks, $supported_chunks ),
+        array(
+            'component_id' => 'blogs'
+        )
+    );
+
+    $url = bp_rewrites_get_url( $path_chunks );
+
+    /**
+     * Filters the Blogs directory's URL.
+     *
+     * @since 12.0.0
+     *
+     * @param string  $url      The Blogs directory's URL.
+     * @param array   $path_chunks {
+     *     An array of arguments. Optional.
+     *
+     *     @type int $create_single_item `1` to get the Blogs create link.
+     * }
+     */
+    return apply_filters( 'bp_get_blogs_directory_url', $url, $path_chunks );
+}
 
 /**
@@ -474 +493 @@
         global $blogs_template;
 
-        if ( empty( $blogs_template->blog->domain ) )
-            $permalink = bp_get_root_domain() . $blogs_template->blog->path;
-        else {
+        if ( ! empty( $blogs_template->blog->domain ) ) {
+            $permalink = get_site_url( $blogs_template->blog->blog_id );
+
+        } else {
             $protocol = 'http://';
-            if ( is_ssl() )
+            if ( is_ssl() ) {
                 $protocol = 'https://';
+            }
 
             $permalink = $protocol . $blogs_template->blog->domain . $blogs_template->blog->path;
@@ -1349 +1370 @@
     }
 
+    $url = bp_get_blogs_directory_url(
+        array(
+            'create_single_item' => 1,
+        )
+    );
+
     /**
      * Filters "Create a Site" links for users viewing their own profiles.
@@ -1354 +1381 @@
      * @since 1.0.0
      *
-     * @param string $value HTML link for creating a site.
-     */
-    echo apply_filters( 'bp_create_blog_link', '<a href="' . trailingslashit( bp_get_blogs_directory_permalink() . 'create' ) . '">' . __( 'Create a Site', 'buddypress' ) . '</a>' );
+     * @param string $url HTML link for creating a site.
+     */
+    echo apply_filters( 'bp_create_blog_link', '<a href="' . $url . '">' . __( 'Create a Site', 'buddypress' ) . '</a>' );
 }
 
@@ -1460 +1487 @@
         }
 
+        $url = bp_get_blogs_directory_url(
+            array(
+                'create_single_item' => 1,
+            )
+        );
+
         $button_args = array(
             'id'         => 'create_blog',
@@ -1465 +1498 @@
             'link_text'  => __( 'Create a Site', 'buddypress' ),
             'link_class' => 'blog-create no-ajax',
-            'link_href'  => trailingslashit( bp_get_blogs_directory_permalink() . 'create' ),
+            'link_href'  => $url,
             'wrapper'    => false,
             'block_self' => false,