WP_REST_Response::remove_link( string $rel, string $href = null )

Removes a link from the response.


Description Description


Parameters Parameters

$rel

(string) (Required) Link relation. Either an IANA registered type, or an absolute URL.

$href

(string) (Optional) Only remove links for the relation matching the given href.

Default value: null


Top ↑

Source Source

File: wp-includes/rest-api/class-wp-rest-response.php

	public function remove_link( $rel, $href = null ) {
		if ( ! isset( $this->links[ $rel ] ) ) {
			return;
		}

		if ( $href ) {
			$this->links[ $rel ] = wp_list_filter( $this->links[ $rel ], array( 'href' => $href ), 'NOT' );
		} else {
			$this->links[ $rel ] = array();
		}

		if ( ! $this->links[ $rel ] ) {
			unset( $this->links[ $rel ] );
		}
	}

Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.