Contents

Code Reference Classes BP_REST_Activity_Link_Preview_Endpoint BP_REST_Activity_Link_Preview_Endpoint::get_items()

BP_REST_Activity_Link_Preview_Endpoint::get_items( WP_REST_Request $request )

Retrieve activity link preview.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-activity/classes/class-bp-rest-activity-link-preview-endpoint.php

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
public function get_items( $request ) {
 
    $url = $request->get_param( 'url' );
 
    if ( ! wp_http_validate_url( $url ) ) {
        return new WP_Error(
            'bp_rest_invalid_url',
            __( 'Sorry, URL is not valid.', 'buddyboss' ),
            array(
                'status' => 400,
            )
        );
    }
 
    $retval = array(
        'title'       => '',
        'description' => '',
        'images'      => '',
        'error'       => '',
        'wp_embed'    => '',
    );
 
    // Get URL parsed data.
    $parse_url_data = ( function_exists( 'bp_core_parse_url' ) ? bp_core_parse_url( $url ) : '' );
 
    // If empty data then send error.
    if ( empty( $parse_url_data ) ) {
        return new WP_Error(
            'bp_rest_unknown_error',
            __( 'Sorry! preview is not available right now. Please try again later.', 'buddyboss' ),
            array(
                'status' => 400,
            )
        );
    }
 
    $retval = array_merge( $retval, $parse_url_data );
 
    $retval   = $this->add_additional_fields_to_object( $retval, $request );
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after the activity link preview is fetched via the REST API.
     *
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request  $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_activity_link_preview_get_items', $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-functions.php: bp_core_parse_url()

Parse url and get data about URL.
bp-activity/classes/class-bp-rest-activity-link-preview-endpoint.php: bp_rest_activity_link_preview_get_items

Fires after the activity link preview is fetched via the REST API.

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.