Title: WP_oEmbed_Controller::get_proxy_item
Published: June 15, 2017
Last modified: August 20, 2026

---

# WP_oEmbed_Controller::get_proxy_item( WP_REST_Request $request ): object|󠀁[WP_Error](https://developer.wordpress.org/reference/classes/wp_error/)󠁿

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#description)
    - [See also](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#see-also)
 * [Parameters](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#source)
 * [Hooks](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#hooks)
 * [Related](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#changelog)

Callback for the proxy API endpoint.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#description)󠁿

Returns the JSON object for the proxied item.

### 󠀁[See also](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#see-also)󠁿

 * [WP_oEmbed::get_html()](https://developer.wordpress.org/reference/classes/WP_oEmbed/get_html/)

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#parameters)󠁿

 `$request`[WP_REST_Request](https://developer.wordpress.org/reference/classes/wp_rest_request/)
required

Full data about the request.

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#return)󠁿

 object|[WP_Error](https://developer.wordpress.org/reference/classes/wp_error/) 
oEmbed response data or [WP_Error](https://developer.wordpress.org/reference/classes/wp_error/)
on failure.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#source)󠁿

    ```php
    public function get_proxy_item( $request ) {
    	global $wp_embed, $wp_scripts;

    	$args = $request->get_params();

    	// Serve oEmbed data from cache if set.
    	unset( $args['_wpnonce'] );
    	$cache_key = 'oembed_' . md5( serialize( $args ) );
    	$data      = get_transient( $cache_key );
    	if ( ! empty( $data ) ) {
    		return $data;
    	}

    	$url = $request['url'];
    	unset( $args['url'] );

    	// Copy maxwidth/maxheight to width/height since WP_oEmbed::fetch() uses these arg names.
    	if ( isset( $args['maxwidth'] ) ) {
    		$args['width'] = $args['maxwidth'];
    	}
    	if ( isset( $args['maxheight'] ) ) {
    		$args['height'] = $args['maxheight'];
    	}

    	// Short-circuit process for URLs belonging to the current site.
    	$data = get_oembed_response_data_for_url( $url, $args );

    	if ( $data ) {
    		return $data;
    	}

    	$data = _wp_oembed_get_object()->get_data( $url, $args );

    	if ( false === $data ) {
    		// Try using a classic embed, instead.
    		/* @var WP_Embed $wp_embed */
    		$html = $wp_embed->get_embed_handler_html( $args, $url );

    		if ( $html ) {
    			// Check if any scripts were enqueued by the shortcode, and include them in the response.
    			$enqueued_scripts = array();

    			foreach ( $wp_scripts->queue as $script ) {
    				$enqueued_scripts[] = $wp_scripts->registered[ $script ]->src;
    			}

    			return (object) array(
    				'provider_name' => __( 'Embed Handler' ),
    				'html'          => $html,
    				'scripts'       => $enqueued_scripts,
    			);
    		}

    		return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );
    	}

    	/** This filter is documented in wp-includes/class-wp-oembed.php */
    	$data->html = apply_filters( 'oembed_result', _wp_oembed_get_object()->data2html( (object) $data, $url ), $url, $args );

    	/**
    	 * Filters the oEmbed TTL value (time to live).
    	 *
    	 * Similar to the 'oembed_ttl' filter, but for the REST API
    	 * oEmbed proxy endpoint.
    	 *
    	 * @since 4.8.0
    	 *
    	 * @param int    $time    Time to live (in seconds).
    	 * @param string $url     The attempted embed URL.
    	 * @param array  $args    An array of embed request arguments.
    	 */
    	$ttl = apply_filters( 'rest_oembed_ttl', DAY_IN_SECONDS, $url, $args );

    	set_transient( $cache_key, $data, $ttl );

    	return $data;
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/class-wp-oembed-controller.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/class-wp-oembed-controller.php#L169)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/class-wp-oembed-controller.php#L169-L245)

## 󠀁[Hooks](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#hooks)󠁿

 [apply_filters( ‘oembed_result’, string|false $data, string $url, string|array $args )](https://developer.wordpress.org/reference/hooks/oembed_result/)

Filters the HTML returned by the oEmbed provider.

 [apply_filters( ‘rest_oembed_ttl’, int $time, string $url, array $args )](https://developer.wordpress.org/reference/hooks/rest_oembed_ttl/)

Filters the oEmbed TTL value (time to live).

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#related)󠁿

| Uses | Description | 
| [WP_Embed::get_embed_handler_html()](https://developer.wordpress.org/reference/classes/wp_embed/get_embed_handler_html/)`wp-includes/class-wp-embed.php` |

Returns embed HTML for a given URL from embed handlers.

  | 
| [get_oembed_response_data_for_url()](https://developer.wordpress.org/reference/functions/get_oembed_response_data_for_url/)`wp-includes/embed.php` |

Retrieves the oEmbed response data for a given URL.

  | 
| [get_status_header_desc()](https://developer.wordpress.org/reference/functions/get_status_header_desc/)`wp-includes/functions.php` |

Retrieves the description for the HTTP status.

  | 
| [_wp_oembed_get_object()](https://developer.wordpress.org/reference/functions/_wp_oembed_get_object/)`wp-includes/embed.php` |

Returns the initialized [WP_oEmbed](https://developer.wordpress.org/reference/classes/wp_oembed/) object.

  | 
| [get_transient()](https://developer.wordpress.org/reference/functions/get_transient/)`wp-includes/option.php` |

Retrieves the value of a transient.

  | 
| [set_transient()](https://developer.wordpress.org/reference/functions/set_transient/)`wp-includes/option.php` |

Sets/updates the value of a transient.

  | 
| [__()](https://developer.wordpress.org/reference/functions/__/)`wp-includes/l10n.php` |

Retrieves the translation of $text.

  | 
| [apply_filters()](https://developer.wordpress.org/reference/functions/apply_filters/)`wp-includes/plugin.php` |

Calls the callback functions that have been added to a filter hook.

  | 
| [WP_Error::__construct()](https://developer.wordpress.org/reference/classes/wp_error/__construct/)`wp-includes/class-wp-error.php` |

Initializes the error.

  |

[Show 4 more](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#)

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_oembed_controller/get_proxy_item/?output_format=md#changelog)󠁿

| Version | Description | 
| [4.8.0](https://developer.wordpress.org/reference/since/4.8.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_oembed_controller%2Fget_proxy_item%2F)
before being able to contribute a note or feedback.