Changeset 10830 for trunk/src/bp-core/bp-core-template.php

Timestamp:

05/31/2016 06:32:24 AM (8 years ago)

Author:

r-a-y

Message:

In bp_create_excerpt(), introduce 'strip_tags' and 'remove_links' as arguments.

This will help to craft better plain-text excerpts.

To be used in activity embed excerpts. See #6772.

File:

• trunk/src/bp-core/bp-core-template.php (modified) (5 diffs)

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

@@ -784 +784 @@
  * http://book.cakephp.org/view/1469/Text#truncate-1625
  *
- * ### Options:
- *
- * - `ending` Will be used as Ending and appended to the trimmed string.
- * - `exact` If false, $text will not be cut mid-word.
- * - `html` If true, HTML tags would be handled correctly.
- * - `filter_shortcodes` If true, shortcodes will be stripped before truncating.
- *
  * @since 1.0.0
+ * @since 2.6.0 Added 'strip_tags' and 'remove_links' as $options args.
  *
  * @param string $text   String to truncate.
@@ -806 +800 @@
  *     @type bool   $filter_shortcodes If true, shortcodes will be stripped.
  *                                     Default: true.
+ *     @type bool   $strip_tags        If true, HTML tags will be stripped. Default: false.
+ *                                     Only applicable if $html is set to false.
+ *     @type bool   $remove_links      If true, URLs will be stripped. Default: false.
+ *                                     Only applicable if $html is set to false.
  * }
  * @return string Trimmed string.
@@ -818 +816 @@
         'exact'             => false,
         'html'              => true,
-        'filter_shortcodes' => $filter_shortcodes_default
+        'filter_shortcodes' => $filter_shortcodes_default,
+        'strip_tags'        => false,
+        'remove_links'      => false,
     ), 'create_excerpt' );
 
@@ -904 +904 @@
         }
     } else {
+        // Strip HTML tags if necessary.
+        if ( ! empty( $r['strip_tags'] ) ) {
+            $text = strip_tags( $text );
+        }
+
+        // Remove links if necessary.
+        if ( ! empty( $r['remove_links'] ) ) {
+            $text = preg_replace( '#^\s*(https?://[^\s"]+)\s*$#im', '', $text );
+        }
+
         if ( mb_strlen( $text ) <= $length ) {
-            return $text;
+            /**
+             * Filters the final generated excerpt.
+             *
+             * @since 1.1.0
+             *
+             * @param string $truncate      Generated excerpt.
+             * @param string $original_text Original text provided.
+             * @param int    $length        Length of returned string, including ellipsis.
+             * @param array  $options       Array of HTML attributes and options.
+             */
+            return apply_filters( 'bp_create_excerpt', $text, $original_text, $length, $options );
         } else {
             $truncate = mb_substr( $text, 0, $length - mb_strlen( $ending ) );
@@ -986 +1006 @@
     }
 
-    /**
-     * Filters the final generated excerpt.
-     *
-     * @since 1.1.0
-     *
-     * @param string $truncate      Generated excerpt.
-     * @param string $original_text Original text provided.
-     * @param int    $length        Length of returned string, including ellipsis.
-     * @param array  $options       Array of HTML attributes and options.
-     */
+    /** This filter is documented in /bp-core/bp-core-template.php */
     return apply_filters( 'bp_create_excerpt', $truncate, $original_text, $length, $options );
 }