urlencode_deep( mixed $value ): mixed

Navigates through an array, object, or scalar, and encodes the values to be used in a URL.

Contents

Parameters

$value mixed Required
The array or string to be encoded.

Top ↑

Return

mixed The encoded value.

Top ↑

Source

File: wp-includes/formatting.php. View all references 

function urlencode_deep( $value ) {
	return map_deep( $value, 'urlencode' );
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
map_deep() wp-includes/formatting.php

Maps a function to all non-iterable elements of an array or an object.

Top ↑

Used By

Used By
Used By Description
WP_REST_Search_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

Retrieves a collection of search results.
WP_REST_Users_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Retrieves all users.
WP_REST_Revisions_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Gets a collection of revisions.
WP_REST_Terms_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Retrieves terms associated with a taxonomy.
WP_REST_Posts_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Retrieves a collection of posts.
WP_REST_Comments_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Retrieves a list of comment items.
paginate_links() wp-includes/general-template.php

Retrieves paginated links for archive post pages.
add_query_arg() wp-includes/functions.php

Retrieves a modified URL query string.
Show 3 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.2.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Razon Komar Pal —

    Here is an example for string:

    echo urlencode_deep( 'foo bar' );

// Output will be: foo+bar

    Here is an example for array:

    $data = urlencode_deep( array( 'foo' => 'bar long text', 'key1' => 'value1' ) );

// Output will be for $data: array( 'foo' => 'bar+long+text', 'key1' => 'value1' )

    Here is a use case for multi word string as url parameter:

    echo add_query_arg( 'key', urlencode_deep( 'long value' ), 'http://example.com/' );

// Output will be: http://example.com/?key=long+value

    Here is a use case for an array multi word string as url parameter:

    $params = array( 
    'key1' => 'value1 long text',
    'key2' => 'value2',
);

echo add_query_arg(
    urlencode_deep( $params ),
    'http://example.com/?'
);

// Output will be: http://example.com/?key1=value1+long+text&key2=value2

    It’s making spaces between word, if string has space:

    echo add_query_arg( 'key', 'long value', 'http://example.com/' );

// Output will be: http://example.com/?key=long value

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