Changeset 13002 for trunk/src/bp-core/bp-core-template-loader.php

Timestamp:

07/14/2021 04:44:28 PM (5 years ago)

Author:

imath

Message:

Merge the BP Blocks plugin's 'bp/friends' Block

• introduce the bp_get_dynamic_template_part() function which let you use a JavaScript template inside PHP thanks to the bp_core_replace_tokens_in_text() function.
• Adds a new assets/widgets/friends.php JavaScript template to our two template packs.
• Adds a new Core JavaScript file which acts like a parent class to all dynamic widgets front-end scripts (friends, groups, members).
• Add this front-end script to the Friends component.
• Adapt Grunt sass tasks.
• Add the Block JavaScript source files into src/js/bp-friends/js/blocks.
• Add the Block Scss source file into src/bp-friends/sass.
• Generate the development files to ease testing.

Fixes #8521

File:

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

trunk/src/bp-core/bp-core-template-loader.php

@@ -86 +86 @@
 function bp_get_asset_template_part( $slug, $name = null, $args = array() ) {
         return bp_get_template_part( "assets/{$slug}", $name, $args );
+}
+
+/**
+ * Get a dynamic template part.
+ *
+ * @since 9.0.0
+ *
+ * @param string $template     The Template Pack's relative path to the templata.
+ *                             Optional.
+ * @param string $type         Whether to use the template for JavaScript or PHP.
+ *                             Optional. Defaults to `js`.
+ * @param array  $tokens       The data to use to customize the template. Optional.
+ * @param array  $allowed_tags The allowed tags to use. Optional.
+ * @return string HTML/JS output.
+ */
+function bp_get_dynamic_template_part( $template = '', $type = 'js', $tokens = array(), $allowed_tags = array() ) {
+        $template_string = '';
+
+        if ( ! $template ) {
+                return '';
+        }
+
+        // Use the BP Theme Compat API to allow template override.
+        $template_path = bp_locate_template( $template );
+        if ( $template_path ) {
+                $template_string = file_get_contents( $template_path );
+        }
+
+        if ( ! $template_string ) {
+                return '';
+        }
+
+        if ( ! $allowed_tags ) {
+                $allowed_tags = array(
+                        'li'   => array( 'class' => true ),
+                        'div'  => array( 'class' => true ),
+                        'span' => array( 'class' => true ),
+                        'a'    => array(
+                                'href'            => true,
+                                'class'           => true,
+                                'data-bp-tooltip' => true,
+                        ),
+                        'img'  => array(
+                                'src'     => true,
+                                'class'   => true,
+                                'loading' => true,
+                        ),
+                );
+        }
+
+        if ( 'js' !== $type ) {
+                $template_string = wp_kses( $template_string, $allowed_tags );
+
+                return bp_core_replace_tokens_in_text( $template_string, $tokens );
+        }
+
+        return $template_string;
 }