web-dev-qa-db-fra.com

Obtenez tous les tags non seulement les 10 premiers avec wp api 2.0

si je le fais, /wp-json/wp/v2/tags, je ne peux obtenir que les 10 premiers, et il semble que l'ajout de per_page=0 ne fonctionne plus pour obtenir réellement toutes les balises.

Tout le monde sait comment obtenir réellement toutes les balises avec wp-api 2.0 ?

databasetagsapiwp-apirest-api
2
Ezeewei

Si nous regardons la méthode WP_REST_Controller::get_collection_params(), nous pouvons voir le minimum est 1 et le maximum est 100:

'per_page' => array(
    'description'        => __( 'Maximum number of items to be returned in result set.' ),
    'type'               => 'integer',
    'default'            => 10,
    'minimum'            => 1,
    'maximum'            => 100,
    'sanitize_callback'  => 'absint',
    'validate_callback'  => 'rest_validate_request_arg',
),

Si nous vérifions le fichier CHANGELOG.md, nous trouvons ceci:

- Enforces minimum 1 and maximum 100 values for `per_page` parameter.

(props @danielbachhuber,
[#2209](https://github.com/WP-API/WP-API/pull/2209))

Nous voyons ici que cela est lié à la question # 1609 where @rmccue comment est:

Vous devriez pouvoir filtrer rest_endpoints et changer la valeur maximale à cet endroit. Cela devrait être potentiellement plus facile, mais idéalement, vous ne devriez pas changer cela.

Le filtre rest_endpoints est appliqué dans la méthode WP_REST_Server::get_routes():

/**
 * Filters the array of available endpoints.
 *
 * @since 4.4.0
 *
 * @param array $endpoints The available endpoints. An array of matching regex patterns,
 *                         each mapped to an array of callbacks for the endpoint. 
 *                         These take the format
 *                         `'/path/regex' => array( $callback, $bitmask )` or
 *                         `'/path/regex' => array( array( $callback, $bitmask ).
 */
 $endpoints = apply_filters( 'rest_endpoints', $this->endpoints );

A titre d'exemple, nous pourrions essayer:

/**
 * Change the maximum of per_page for /wp/v2/tags/ from 100 to 120
 */
add_filter( 'rest_endpoints', function( $endpoints )
{
    if( isset( $endpoints['/wp/v2/tags'][0]['args']['per_page']['maximum'] ) )
        $endpoints['/wp/v2/tags'][0]['args']['per_page']['maximum'] = 120;

    return $endpoints;  
} );

Une autre approche pourrait être d'utiliser le filtre rest_post_tag_query:

/**
 * Fix the per_page to 120 for the post tags query of get_terms()
 */
add_filter( 'rest_post_tag_query', function( $args, $request )
{
    $args['number'] = 120;
    return $args;
}, 10, 2 );

où vous voudrez peut-être adapter cela à vos besoins.

Notez que cette restriction par défaut sur per_page pourrait "protéger" votre serveur, même en cas de charge élevée, si votre installation comporte un grand nombre de termes.

4
birgire