WordPress.org

Make WordPress Core

Changeset 39223


Ignore:
Timestamp:
11/14/2016 04:41:40 PM (5 years ago)
Author:
joehoyle
Message:

REST API: Make all collection params filterable.

For developers wanting to add their own registered collection parameters, they can now use the rest_$type_collection_params filter. This brings consistency with the already existing rest_$post_type_collection_params.

Fixes #38710.
Props jnylen0.

Location:
trunk/src/wp-includes/rest-api/endpoints
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

    r39196 r39223  
    13901390        );
    13911391
    1392         return $query_params;
     1392        /**
     1393         * Filter collection parameters for the comments controller.
     1394         *
     1395         * This filter registers the collection parameter, but does not map the
     1396         * collection parameter to an internal WP_Comment_Query parameter. Use the
     1397         * `rest_comment_query` filter to set WP_Comment_Query parameters.
     1398         *
     1399         * @since 4.7.0
     1400         *
     1401         * @param $params JSON Schema-formatted collection parameters.
     1402         */
     1403        return apply_filters( 'rest_comment_collection_params', $query_params );
    13931404    }
    13941405
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

    r39192 r39223  
    960960        );
    961961
    962         return $query_params;
     962        /**
     963         * Filter collection parameters for the terms controller.
     964         *
     965         * The dynamic part of the filter `$this->taxonomy` refers to the taxonomy
     966         * slug for the controller.
     967         *
     968         * This filter registers the collection parameter, but does not map the
     969         * collection parameter to an internal WP_Term_Query parameter.  Use the
     970         * `rest_{$this->taxonomy}_query` filter to set WP_Term_Query parameters.
     971         *
     972         * @since 4.7.0
     973         *
     974         * @param $params JSON Schema-formatted collection parameters.
     975         * @param WP_Taxonomy $taxonomy_obj Taxonomy object.
     976         */
     977        return apply_filters( 'rest_{$this->taxonomy}_collection_params', $query_params, $taxonomy );
    963978    }
    964979
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

    r39219 r39223  
    12991299        );
    13001300
    1301         return $query_params;
     1301        /**
     1302         * Filter collection parameters for the users controller.
     1303         *
     1304         * This filter registers the collection parameter, but does not map the
     1305         * collection parameter to an internal WP_User_Query parameter.  Use the
     1306         * `rest_user_query` filter to set WP_User_Query arguments.
     1307         *
     1308         * @since 4.7.0
     1309         *
     1310         * @param $params JSON Schema-formatted collection parameters.
     1311         */
     1312        return apply_filters( 'rest_user_collection_params', $query_params );
    13021313    }
    13031314}
Note: See TracChangeset for help on using the changeset viewer.