{"id":1253,"date":"2019-06-29T11:49:16","date_gmt":"2019-06-29T14:49:16","guid":{"rendered":"https:\/\/felipeelia.com.br\/?p=1253"},"modified":"2019-07-04T19:52:48","modified_gmt":"2019-07-04T22:52:48","slug":"wordpress-rest-api-enable-random-order-of-posts-list","status":"publish","type":"post","link":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/","title":{"rendered":"WordPress REST API: Enable Random Order of Posts List"},"content":{"rendered":"\n

Some time ago, after announcing the WordPress 5.1 first beta on the WordPress Brasil Facebook group, a user asked when we’d have the option to random order the posts on WordPress REST API<\/a>. I explained that core doesn’t need to allow it because it could be done through a custom code.<\/p>\n\n\n\n

The code below uses the filter<\/a> rest_{$this->post_type}_collection_params<\/code> to include rand<\/code> as an entry of the array which enumerates the possible values for ordination. This filter is used in the end of the get_collection_params<\/code> method, inside the WP_REST_Posts_Controller<\/code> class, as you can see here<\/a>. The {$this->post_type}<\/code> filter part is variable and in the code I used it to change the posts<\/em> list.<\/p>\n\n\n\n

In order to apply the random order, you only have to call \/wp-json\/wp\/v2\/posts?orderby=rand<\/code>. If you’re using some cache solution, the final result can be affected.<\/p>\n\n\n\n

<?php\n\/**\n * Plugin Name: REST API - Post list randomize\n * Description: Randomize the content list in REST API passing `orderby=rand` as parameter.\n * Version:     1.0.0\n * Author:      Felipe Elia | Codeable\n * Author URI:  https:\/\/codeable.io\/developers\/felipe-elia?ref=qGTOJ\n *\/\n\n\/**\n * Add `rand` as an option for orderby param in REST API.\n * Hook to `rest_{$this->post_type}_collection_params` filter.\n *\n * @param array $query_params Accepted parameters.\n * @return array\n *\/\nfunction add_rand_orderby_rest_post_collection_params( $query_params ) {\n\t$query_params['orderby']['enum'][] = 'rand';\n\treturn $query_params;\n}\nadd_filter( 'rest_post_collection_params', 'add_rand_orderby_rest_post_collection_params' );<\/code><\/pre>\n\n\n\n

You only have to save the code as a PHP file and put it into the plugins directory. The code is also available as a gist<\/a>.<\/p>\n\n\n\n


\n\n\n\n

If you have any trouble deploying this code or with anything related to WordPress, give a look at my\u00a0Codeable Profile<\/a>\u00a0and click on that\u00a0Hire button<\/a>!<\/p>\n","protected":false},"excerpt":{"rendered":"

A simple plugin to enable random order of the posts list on WordPress REST API<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","footnotes":""},"categories":[91],"tags":[102],"yoast_head":"\nWordPress REST API: Enable Random Order of Posts List | Felipe Elia<\/title>\n<meta name=\"description\" content=\"A simple plugin to enable random order of the posts list on WordPress REST API\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\" \/>\n<meta property=\"og:locale\" content=\"pt_BR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"WordPress REST API: Enable Random Order of Posts List | Felipe Elia\" \/>\n<meta property=\"og:description\" content=\"A simple plugin to enable random order of the posts list on WordPress REST API\" \/>\n<meta property=\"og:url\" content=\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\" \/>\n<meta property=\"og:site_name\" content=\"Felipe Elia\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/felipe.elia\" \/>\n<meta property=\"article:author\" content=\"https:\/\/www.facebook.com\/felipe.elia\" \/>\n<meta property=\"article:published_time\" content=\"2019-06-29T14:49:16+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2019-07-04T22:52:48+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/felipeelia.dev\/wp-content\/uploads\/2017\/09\/query-posts.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"630\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Felipe Elia\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@https:\/\/twitter.com\/felipe_elia\" \/>\n<meta name=\"twitter:site\" content=\"@felipe_elia\" \/>\n<meta name=\"twitter:label1\" content=\"Escrito por\" \/>\n\t<meta name=\"twitter:data1\" content=\"Felipe Elia\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. tempo de leitura\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\"},\"author\":{\"name\":\"Felipe Elia\",\"@id\":\"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292\"},\"headline\":\"WordPress REST API: Enable Random Order of Posts List\",\"datePublished\":\"2019-06-29T14:49:16+00:00\",\"dateModified\":\"2019-07-04T22:52:48+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\"},\"wordCount\":192,\"commentCount\":8,\"publisher\":{\"@id\":\"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292\"},\"keywords\":[\"REST API\"],\"articleSection\":[\"WordPress\"],\"inLanguage\":\"pt-BR\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\",\"url\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\",\"name\":\"WordPress REST API: Enable Random Order of Posts List | Felipe Elia\",\"isPartOf\":{\"@id\":\"https:\/\/felipeelia.com.br\/#website\"},\"datePublished\":\"2019-06-29T14:49:16+00:00\",\"dateModified\":\"2019-07-04T22:52:48+00:00\",\"description\":\"A simple plugin to enable random order of the posts list on WordPress REST API\",\"breadcrumb\":{\"@id\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#breadcrumb\"},\"inLanguage\":\"pt-BR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"In\u00edcio\",\"item\":\"https:\/\/felipeelia.dev\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"WordPress REST API: Enable Random Order of Posts List\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/felipeelia.com.br\/#website\",\"url\":\"https:\/\/felipeelia.com.br\/\",\"name\":\"Felipe Elia\",\"description\":\"Programa\u00e7\u00e3o com WordPress de um jeito f\u00e1cil, do b\u00e1sico ao avan\u00e7ado\",\"publisher\":{\"@id\":\"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/felipeelia.com.br\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"pt-BR\"},{\"@type\":[\"Person\",\"Organization\"],\"@id\":\"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292\",\"name\":\"Felipe Elia\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"pt-BR\",\"@id\":\"https:\/\/felipeelia.com.br\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/felipeelia.dev\/wp-content\/uploads\/2023\/06\/avatar-400x400-1.jpg\",\"contentUrl\":\"https:\/\/felipeelia.dev\/wp-content\/uploads\/2023\/06\/avatar-400x400-1.jpg\",\"width\":400,\"height\":400,\"caption\":\"Felipe Elia\"},\"logo\":{\"@id\":\"https:\/\/felipeelia.com.br\/#\/schema\/person\/image\/\"},\"description\":\"Associate Director of Platform Engineering na 10up, WordPress Core Contributor, Global Polyglots Mentor na comunidade internacional do WordPress e Locale Manager na comunidade WordPress Brasil.\",\"sameAs\":[\"https:\/\/www.facebook.com\/felipe.elia\",\"https:\/\/www.instagram.com\/felipe.elia\/\",\"https:\/\/www.linkedin.com\/in\/felipeelia\/\",\"https:\/\/twitter.com\/https:\/\/twitter.com\/felipe_elia\",\"https:\/\/www.youtube.com\/channel\/UCD_26rOE3ClALcZreTkyIoQ\"],\"url\":\"https:\/\/felipeelia.com.br\/author\/admin\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"WordPress REST API: Enable Random Order of Posts List | Felipe Elia","description":"A simple plugin to enable random order of the posts list on WordPress REST API","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/","og_locale":"pt_BR","og_type":"article","og_title":"WordPress REST API: Enable Random Order of Posts List | Felipe Elia","og_description":"A simple plugin to enable random order of the posts list on WordPress REST API","og_url":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/","og_site_name":"Felipe Elia","article_publisher":"https:\/\/www.facebook.com\/felipe.elia","article_author":"https:\/\/www.facebook.com\/felipe.elia","article_published_time":"2019-06-29T14:49:16+00:00","article_modified_time":"2019-07-04T22:52:48+00:00","og_image":[{"width":"1200","height":"630","url":"https:\/\/felipeelia.dev\/wp-content\/uploads\/2017\/09\/query-posts.jpg","type":"image\/jpeg"}],"author":"Felipe Elia","twitter_card":"summary_large_image","twitter_creator":"@https:\/\/twitter.com\/felipe_elia","twitter_site":"@felipe_elia","twitter_misc":{"Escrito por":"Felipe Elia","Est. tempo de leitura":"2 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#article","isPartOf":{"@id":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/"},"author":{"name":"Felipe Elia","@id":"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292"},"headline":"WordPress REST API: Enable Random Order of Posts List","datePublished":"2019-06-29T14:49:16+00:00","dateModified":"2019-07-04T22:52:48+00:00","mainEntityOfPage":{"@id":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/"},"wordCount":192,"commentCount":8,"publisher":{"@id":"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292"},"keywords":["REST API"],"articleSection":["WordPress"],"inLanguage":"pt-BR","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/","url":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/","name":"WordPress REST API: Enable Random Order of Posts List | Felipe Elia","isPartOf":{"@id":"https:\/\/felipeelia.com.br\/#website"},"datePublished":"2019-06-29T14:49:16+00:00","dateModified":"2019-07-04T22:52:48+00:00","description":"A simple plugin to enable random order of the posts list on WordPress REST API","breadcrumb":{"@id":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#breadcrumb"},"inLanguage":"pt-BR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/felipeelia.dev\/wordpress-rest-api-enable-random-order-of-posts-list\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"In\u00edcio","item":"https:\/\/felipeelia.dev\/"},{"@type":"ListItem","position":2,"name":"WordPress REST API: Enable Random Order of Posts List"}]},{"@type":"WebSite","@id":"https:\/\/felipeelia.com.br\/#website","url":"https:\/\/felipeelia.com.br\/","name":"Felipe Elia","description":"Programa\u00e7\u00e3o com WordPress de um jeito f\u00e1cil, do b\u00e1sico ao avan\u00e7ado","publisher":{"@id":"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/felipeelia.com.br\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"pt-BR"},{"@type":["Person","Organization"],"@id":"https:\/\/felipeelia.com.br\/#\/schema\/person\/927a99b6e1cde7fcf9f4f79a1638b292","name":"Felipe Elia","image":{"@type":"ImageObject","inLanguage":"pt-BR","@id":"https:\/\/felipeelia.com.br\/#\/schema\/person\/image\/","url":"https:\/\/felipeelia.dev\/wp-content\/uploads\/2023\/06\/avatar-400x400-1.jpg","contentUrl":"https:\/\/felipeelia.dev\/wp-content\/uploads\/2023\/06\/avatar-400x400-1.jpg","width":400,"height":400,"caption":"Felipe Elia"},"logo":{"@id":"https:\/\/felipeelia.com.br\/#\/schema\/person\/image\/"},"description":"Associate Director of Platform Engineering na 10up, WordPress Core Contributor, Global Polyglots Mentor na comunidade internacional do WordPress e Locale Manager na comunidade WordPress Brasil.","sameAs":["https:\/\/www.facebook.com\/felipe.elia","https:\/\/www.instagram.com\/felipe.elia\/","https:\/\/www.linkedin.com\/in\/felipeelia\/","https:\/\/twitter.com\/https:\/\/twitter.com\/felipe_elia","https:\/\/www.youtube.com\/channel\/UCD_26rOE3ClALcZreTkyIoQ"],"url":"https:\/\/felipeelia.com.br\/author\/admin\/"}]}},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"ocean-thumb-m":false,"ocean-thumb-ml":false,"ocean-thumb-l":false,"yarpp-thumbnail":false},"uagb_author_info":{"display_name":"Felipe Elia","author_link":"https:\/\/felipeelia.com.br\/author\/admin\/"},"uagb_comment_info":8,"uagb_excerpt":"A simple plugin to enable random order of the posts list on WordPress REST API","_links":{"self":[{"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/posts\/1253"}],"collection":[{"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/comments?post=1253"}],"version-history":[{"count":0,"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/posts\/1253\/revisions"}],"wp:attachment":[{"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/media?parent=1253"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/categories?post=1253"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/felipeelia.dev\/wp-json\/wp\/v2\/tags?post=1253"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}