Contents

Code Reference Classes BP_Media_Extractor BP_Media_Extractor::extract()

BP_Media_Extractor::extract( string|WP_Post $richtext, int $what_to_extract = self::ALL, array $extra_args = array() )

Extract media from text.

Description

Parameters

$richtext

(Required) Content to parse.

$what_to_extract

(Optional) Media type to extract (optional).

Default value: self::ALL

$extra_args

(Optional) Bespoke data for a particular extractor (optional).

Default value: array()

Return

(array)

  • 'has'
    (array) Extracted media counts. {
  • 'audio'
    (int)
  • 'embeds'
    (int)
  • 'images'
    (int)
  • 'links'
    (int)
  • 'mentions'
    (int)
  • 'shortcodes'
    (int)
  • 'video'
    (int)
  • 'audio'
    (array) Extracted audio. { Array of extracted media.
  • 'source'
    (string) Media source. Either "html" or "shortcodes".
  • 'url'
    (string) Link to audio.
  • 'embeds'
    (array) Extracted oEmbeds. { Array of extracted media.
  • 'url'
    (string) oEmbed link.
  • 'images'
    (array) Extracted images. { Array of extracted media.
  • 'gallery_id'
    (int) Gallery ID. Optional, not always set.
  • 'height'
    (int) Width of image. If unknown, set to 0.
  • 'source'
    (string) Media source. Either "html" or "galleries".
  • 'url'
    (string) Link to image.
  • 'width'
    (int) Width of image. If unknown, set to 0.
  • 'links'
    (array) Extracted URLs. { Array of extracted media.
  • 'url'
    (string) Link.
  • 'mentions'
    (array) Extracted mentions. { Array of extracted media.
  • 'name'
    (string) @mention.
  • 'user_id'
    (string) User ID. Optional, only set if Activity component enabled.
  • 'shortcodes'
    (array) Extracted shortcodes. { Array of extracted media.
  • 'attributes'
    (array) Key/value pairs of the shortcodes attributes (if any).
  • 'content'
    (string) Text wrapped by the shortcode.
  • 'type'
    (string) Shortcode type.
  • 'original'
    (string) The entire shortcode.
  • 'videos'
    (array) Extracted video. { Array of extracted media.
  • 'source'
    (string) Media source. Currently only "shortcodes".
  • 'url'
    (string) Link to audio.

    • Source

    File: bp-core/classes/class-bp-media-extractor.php

    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    public function extract( $richtext, $what_to_extract = self::ALL, $extra_args = array() ) {
        $media = array();
     
        // Support passing a WordPress Post for the $richtext parameter.
        if ( is_a( $richtext, 'WP_Post' ) ) {
            $extra_args['post'] = $richtext;
            $richtext           = $extra_args['post']->post_content;
        }
     
        $plaintext = $this->strip_markup( $richtext );
     
     
        // Extract links.
        if ( self::LINKS & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_links( $richtext, $plaintext, $extra_args ) );
        }
     
        // Extract mentions.
        if ( self::MENTIONS & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_mentions( $richtext, $plaintext, $extra_args ) );
        }
     
        // Extract images.
        if ( self::IMAGES & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_images( $richtext, $plaintext, $extra_args ) );
        }
     
        // Extract shortcodes.
        if ( self::SHORTCODES & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_shortcodes( $richtext, $plaintext, $extra_args ) );
        }
     
        // Extract oEmbeds.
        if ( self::EMBEDS & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_embeds( $richtext, $plaintext, $extra_args ) );
        }
     
        // Extract audio.
        if ( self::AUDIO & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_audio( $richtext, $plaintext, $extra_args ) );
        }
     
        // Extract video.
        if ( self::VIDEOS & $what_to_extract ) {
            $media = array_merge_recursive( $media, $this->extract_video( $richtext, $plaintext, $extra_args ) );
        }
     
        /**
         * Filters media extracted from text.
         *
         * @since BuddyPress 2.3.0
         *
         * @param array  $media           Extracted media. See {@link BP_Media_Extractor::extract()} for format.
         * @param string $richtext        Content to parse.
         * @param int    $what_to_extract Media type to extract.
         * @param array  $extra_args      Bespoke data for a particular extractor.
         * @param string $plaintext       Copy of $richtext without any markup.
         */
        return apply_filters( 'bp_media_extractor_extract', $media, $richtext, $what_to_extract, $extra_args, $plaintext );
    }

    Expand full source code Collapse full source code

    Changelog

    Changelog
    Version Description
    BuddyPress 2.3.0 Introduced.

    Uses

    Uses
    Uses Description
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::strip_markup()

    Sanitize and format raw content to prepare for content extraction.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_images()

    Extract images from <img src> tags, [galleries], and featured images from a Post.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_shortcodes()

    Extract shortcodes from text.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_embeds()

    Extract any URL, matching a registered oEmbed endpoint, from text.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_audio()

    Extract [audio] shortcodes and <a href="*.mp3"> tags, from text.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_video()

    Extract [video] shortcodes from text.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_links()

    Extract <a href> tags from text.
    bp-core/classes/class-bp-media-extractor.php: BP_Media_Extractor::extract_mentions()

    Extract @mentions tags from text.
    bp-core/classes/class-bp-media-extractor.php: bp_media_extractor_extract

    Filters media extracted from text.
    Show 4 more uses Hide more uses

    Questions?

    We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.