REST API: Introduce baby API to the world.
Baby API was born at 2.8KLOC on October 8th at 2:30 UTC. API has lots
of growing to do, so wish it the best of luck.
Thanks to everyone who helped along the way:
Props rmccue, rachelbaker, danielbachhuber, joehoyle, drewapicture,
adamsilverstein, netweb, tlovett1, shelob9, kadamwhite, pento,
westonruter, nikv, tobych, redsweater, alecuf, pollyplummer, hurtige,
bpetty, oso96_2000, ericlewis, wonderboymusic, joshkadis, mordauk,
jdgrimes, johnbillion, jeremyfelt, thiago-negri, jdolan, pkevan,
iseulde, thenbrent, maxcutler, kwight, markoheijnen, phh, natewr,
jjeaton, shprink, mattheu, quasel, jmusal, codebykat, hubdotcom,
tapsboy, QWp6t, pushred, jaredcobb, justinsainton, japh, matrixik,
jorbin, frozzare, codfish, michael-arestad, kellbot, ironpaperweight,
simonlampen, alisspers, eliorivero, davidbhayes, JohnDittmar, dimadin,
traversal, cmmarslender, Toddses, kokarn, welcher, and ericpedia.
Fixes #33982.
Built from https://develop.svn.wordpress.org/trunk@34928
git-svn-id: http://core.svn.wordpress.org/trunk@34893 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-08 04:31:25 +02:00
< ? php
/**
* REST API functions .
*
* @ package WordPress
* @ subpackage REST_API
2015-11-20 08:24:30 +01:00
* @ since 4.4 . 0
REST API: Introduce baby API to the world.
Baby API was born at 2.8KLOC on October 8th at 2:30 UTC. API has lots
of growing to do, so wish it the best of luck.
Thanks to everyone who helped along the way:
Props rmccue, rachelbaker, danielbachhuber, joehoyle, drewapicture,
adamsilverstein, netweb, tlovett1, shelob9, kadamwhite, pento,
westonruter, nikv, tobych, redsweater, alecuf, pollyplummer, hurtige,
bpetty, oso96_2000, ericlewis, wonderboymusic, joshkadis, mordauk,
jdgrimes, johnbillion, jeremyfelt, thiago-negri, jdolan, pkevan,
iseulde, thenbrent, maxcutler, kwight, markoheijnen, phh, natewr,
jjeaton, shprink, mattheu, quasel, jmusal, codebykat, hubdotcom,
tapsboy, QWp6t, pushred, jaredcobb, justinsainton, japh, matrixik,
jorbin, frozzare, codfish, michael-arestad, kellbot, ironpaperweight,
simonlampen, alisspers, eliorivero, davidbhayes, JohnDittmar, dimadin,
traversal, cmmarslender, Toddses, kokarn, welcher, and ericpedia.
Fixes #33982.
Built from https://develop.svn.wordpress.org/trunk@34928
git-svn-id: http://core.svn.wordpress.org/trunk@34893 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-08 04:31:25 +02:00
*/
/**
* Version number for our API .
*
* @ var string
*/
define ( 'REST_API_VERSION' , '2.0' );
2015-11-20 08:24:30 +01:00
/**
* Registers a REST API route .
*
2019-01-11 19:19:49 +01:00
* Note : Do not use before the { @ see 'rest_api_init' } hook .
*
2015-11-20 08:24:30 +01:00
* @ since 4.4 . 0
2019-01-11 19:19:49 +01:00
* @ since 5.1 . 0 Added a _doing_it_wrong () notice when not called on or after the rest_api_init hook .
2015-11-20 08:24:30 +01:00
*
* @ param string $namespace The first URL segment after core prefix . Should be unique to your package / plugin .
* @ param string $route The base URL for route you are adding .
* @ param array $args Optional . Either an array of options for the endpoint , or an array of arrays for
* multiple methods . Default empty array .
* @ param bool $override Optional . If the route already exists , should we override it ? True overrides ,
* false merges ( with newer overriding if duplicate keys exist ) . Default false .
* @ return bool True on success , false on error .
*/
function register_rest_route ( $namespace , $route , $args = array (), $override = false ) {
if ( empty ( $namespace ) ) {
/*
* Non - namespaced routes are not allowed , with the exception of the main
* and namespace indexes . If you really need to register a
* non - namespaced route , call `WP_REST_Server::register_route` directly .
*/
2015-12-07 23:40:27 +01:00
_doing_it_wrong ( 'register_rest_route' , __ ( 'Routes must be namespaced with plugin or theme name and version.' ), '4.4.0' );
2015-11-20 08:24:30 +01:00
return false ;
2017-12-01 00:11:00 +01:00
} elseif ( empty ( $route ) ) {
2015-12-07 23:40:27 +01:00
_doing_it_wrong ( 'register_rest_route' , __ ( 'Route must be specified.' ), '4.4.0' );
2015-11-20 08:24:30 +01:00
return false ;
}
2020-05-22 22:48:08 +02:00
$clean_namespace = trim ( $namespace , '/' );
if ( $clean_namespace !== $namespace ) {
_doing_it_wrong ( __FUNCTION__ , __ ( 'Namespace must not start or end with a slash.' ), '5.4.2' );
}
2019-01-11 19:19:49 +01:00
if ( ! did_action ( 'rest_api_init' ) ) {
2019-01-26 13:29:54 +01:00
_doing_it_wrong (
'register_rest_route' ,
sprintf (
/* translators: %s: rest_api_init */
__ ( 'REST API routes must be registered on the %s action.' ),
'<code>rest_api_init</code>'
),
'5.1.0'
);
2019-01-11 19:19:49 +01:00
}
2017-01-26 14:39:41 +01:00
if ( isset ( $args [ 'args' ] ) ) {
$common_args = $args [ 'args' ];
unset ( $args [ 'args' ] );
} else {
$common_args = array ();
}
2015-11-20 08:24:30 +01:00
if ( isset ( $args [ 'callback' ] ) ) {
// Upgrade a single set to multiple.
$args = array ( $args );
}
$defaults = array (
2017-12-01 00:11:00 +01:00
'methods' => 'GET' ,
'callback' => null ,
'args' => array (),
2015-11-20 08:24:30 +01:00
);
2020-01-29 01:45:18 +01:00
2015-11-20 08:24:30 +01:00
foreach ( $args as $key => & $arg_group ) {
2017-01-26 14:39:41 +01:00
if ( ! is_numeric ( $key ) ) {
2015-11-20 08:24:30 +01:00
// Route option, skip here.
continue ;
}
2017-12-01 00:11:00 +01:00
$arg_group = array_merge ( $defaults , $arg_group );
2017-01-26 14:39:41 +01:00
$arg_group [ 'args' ] = array_merge ( $common_args , $arg_group [ 'args' ] );
2015-11-20 08:24:30 +01:00
}
2020-05-22 22:48:08 +02:00
$full_route = '/' . $clean_namespace . '/' . trim ( $route , '/' );
rest_get_server () -> register_route ( $clean_namespace , $full_route , $args , $override );
2015-11-20 08:24:30 +01:00
return true ;
}
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
/**
* Registers a new field on an existing WordPress object type .
*
* @ since 4.7 . 0
*
* @ global array $wp_rest_additional_fields Holds registered fields , organized
* by object type .
*
* @ param string | array $object_type Object ( s ) the field is being registered
* to , " post " | " term " | " comment " etc .
* @ param string $attribute The attribute name .
* @ param array $args {
* Optional . An array of arguments used to handle the registered field .
*
2019-08-15 22:04:55 +02:00
* @ type callable | null $get_callback Optional . The callback function used to retrieve the field value . Default is
* 'null' , the field will not be returned in the response . The function will
* be passed the prepared object data .
* @ type callable | null $update_callback Optional . The callback function used to set and update the field value . Default
* is 'null' , the value cannot be set or updated . The function will be passed
* the model object , like WP_Post .
* @ type array | null $schema Optional . The callback function used to create the schema for this field .
* Default is 'null' , no schema entry will be returned .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
* }
*/
function register_rest_field ( $object_type , $attribute , $args = array () ) {
$defaults = array (
'get_callback' => null ,
'update_callback' => null ,
'schema' => null ,
);
$args = wp_parse_args ( $args , $defaults );
global $wp_rest_additional_fields ;
$object_types = ( array ) $object_type ;
foreach ( $object_types as $object_type ) {
$wp_rest_additional_fields [ $object_type ][ $attribute ] = $args ;
}
}
2015-11-20 08:24:30 +01:00
/**
* Registers rewrite rules for the API .
*
* @ since 4.4 . 0
*
* @ see rest_api_register_rewrites ()
* @ global WP $wp Current WordPress environment instance .
*/
function rest_api_init () {
rest_api_register_rewrites ();
global $wp ;
$wp -> add_query_var ( 'rest_route' );
}
/**
* Adds REST rewrite rules .
*
* @ since 4.4 . 0
*
* @ see add_rewrite_rule ()
2019-08-04 03:19:56 +02:00
* @ global WP_Rewrite $wp_rewrite WordPress rewrite component .
2015-11-20 08:24:30 +01:00
*/
function rest_api_register_rewrites () {
2016-10-14 21:30:29 +02:00
global $wp_rewrite ;
2017-12-01 00:11:00 +01:00
add_rewrite_rule ( '^' . rest_get_url_prefix () . '/?$' , 'index.php?rest_route=/' , 'top' );
add_rewrite_rule ( '^' . rest_get_url_prefix () . '/(.*)?' , 'index.php?rest_route=/$matches[1]' , 'top' );
add_rewrite_rule ( '^' . $wp_rewrite -> index . '/' . rest_get_url_prefix () . '/?$' , 'index.php?rest_route=/' , 'top' );
add_rewrite_rule ( '^' . $wp_rewrite -> index . '/' . rest_get_url_prefix () . '/(.*)?' , 'index.php?rest_route=/$matches[1]' , 'top' );
2015-11-20 08:24:30 +01:00
}
/**
* Registers the default REST API filters .
*
* Attached to the { @ see 'rest_api_init' } action
* to make testing and disabling these filters easier .
*
* @ since 4.4 . 0
*/
function rest_api_default_filters () {
2020-06-24 01:04:07 +02:00
if ( defined ( 'REST_REQUEST' ) && REST_REQUEST ) {
// Deprecated reporting.
add_action ( 'deprecated_function_run' , 'rest_handle_deprecated_function' , 10 , 3 );
add_filter ( 'deprecated_function_trigger_error' , '__return_false' );
add_action ( 'deprecated_argument_run' , 'rest_handle_deprecated_argument' , 10 , 3 );
add_filter ( 'deprecated_argument_trigger_error' , '__return_false' );
}
2015-11-20 08:24:30 +01:00
// Default serving.
add_filter ( 'rest_pre_serve_request' , 'rest_send_cors_headers' );
add_filter ( 'rest_post_dispatch' , 'rest_send_allow_header' , 10 , 3 );
2017-10-04 20:46:38 +02:00
add_filter ( 'rest_post_dispatch' , 'rest_filter_response_fields' , 10 , 3 );
2015-11-20 08:24:30 +01:00
add_filter ( 'rest_pre_dispatch' , 'rest_handle_options_request' , 10 , 3 );
}
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
/**
* Registers default REST API routes .
*
* @ since 4.7 . 0
*/
function create_initial_rest_routes () {
foreach ( get_post_types ( array ( 'show_in_rest' => true ), 'objects' ) as $post_type ) {
2019-09-23 22:25:57 +02:00
$controller = $post_type -> get_rest_controller ();
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
2019-09-23 22:25:57 +02:00
if ( ! $controller ) {
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
continue ;
}
$controller -> register_routes ();
if ( post_type_supports ( $post_type -> name , 'revisions' ) ) {
$revisions_controller = new WP_REST_Revisions_Controller ( $post_type -> name );
$revisions_controller -> register_routes ();
}
REST API: Introduce Autosaves controller and endpoint.
- Adds `WP_REST_Autosaves_Controller` which extends `WP_REST_Revisions_Controller`.
- Autosaves endpoint is registered for all post types except attachment because even post types without revisions enabled are expected to autosave.
- Because setting the `DOING_AUTOSAVE` constant pollutes the test suite, autosaves tests are run last. We may want to improve upon this later.
Also, use a truly impossibly high number in User Controller tests. The number `100`, (or `7777` in `trunk`), could be valid in certain test run configurations. The `REST_TESTS_IMPOSSIBLY_HIGH_NUMBER` constant is impossibly high for this very reason.
Finally, Skip Autosaves controller test for multisite. There's a PHP 5.2 edge case where paths calculated differently, possibly caused by differing version of PHPUnit.
Props adamsilverstein, aduth, azaozz, danielbachhuber, rmccue, danielbachhuber.
Merges [43767], [43768], [43769] to trunk.
See #45132, #45131.
Fixes #45128, #43316.
Built from https://develop.svn.wordpress.org/trunk@44126
git-svn-id: http://core.svn.wordpress.org/trunk@43956 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-12-13 23:42:38 +01:00
if ( 'attachment' !== $post_type -> name ) {
$autosaves_controller = new WP_REST_Autosaves_Controller ( $post_type -> name );
$autosaves_controller -> register_routes ();
}
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
// Post types.
$controller = new WP_REST_Post_Types_Controller ;
$controller -> register_routes ();
// Post statuses.
$controller = new WP_REST_Post_Statuses_Controller ;
$controller -> register_routes ();
// Taxonomies.
$controller = new WP_REST_Taxonomies_Controller ;
$controller -> register_routes ();
// Terms.
foreach ( get_taxonomies ( array ( 'show_in_rest' => true ), 'object' ) as $taxonomy ) {
$class = ! empty ( $taxonomy -> rest_controller_class ) ? $taxonomy -> rest_controller_class : 'WP_REST_Terms_Controller' ;
if ( ! class_exists ( $class ) ) {
continue ;
}
$controller = new $class ( $taxonomy -> name );
if ( ! is_subclass_of ( $controller , 'WP_REST_Controller' ) ) {
continue ;
}
$controller -> register_routes ();
}
// Users.
$controller = new WP_REST_Users_Controller ;
$controller -> register_routes ();
// Comments.
$controller = new WP_REST_Comments_Controller ;
$controller -> register_routes ();
2018-12-13 10:38:25 +01:00
/**
* Filters the search handlers to use in the REST search controller .
*
* @ since 5.0 . 0
*
* @ param array $search_handlers List of search handlers to use in the controller . Each search
* handler instance must extend the `WP_REST_Search_Handler` class .
* Default is only a handler for posts .
*/
$search_handlers = apply_filters ( 'wp_rest_search_handlers' , array ( new WP_REST_Post_Search_Handler () ) );
$controller = new WP_REST_Search_Controller ( $search_handlers );
$controller -> register_routes ();
2018-12-14 03:35:38 +01:00
// Block Renderer.
$controller = new WP_REST_Block_Renderer_Controller ;
$controller -> register_routes ();
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
// Settings.
$controller = new WP_REST_Settings_Controller ;
$controller -> register_routes ();
2018-12-12 04:33:24 +01:00
// Themes.
$controller = new WP_REST_Themes_Controller ;
$controller -> register_routes ();
2018-12-14 03:35:38 +01:00
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
2015-11-20 08:24:30 +01:00
/**
* Loads the REST API .
*
* @ since 4.4 . 0
*
2019-08-04 03:28:55 +02:00
* @ global WP $wp Current WordPress environment instance .
2015-11-20 08:24:30 +01:00
*/
function rest_api_loaded () {
if ( empty ( $GLOBALS [ 'wp' ] -> query_vars [ 'rest_route' ] ) ) {
return ;
}
/**
* Whether this is a REST Request .
*
* @ since 4.4 . 0
* @ var bool
*/
define ( 'REST_REQUEST' , true );
2016-02-16 02:12:26 +01:00
// Initialize the server.
$server = rest_get_server ();
2015-11-20 08:24:30 +01:00
// Fire off the request.
2017-01-17 06:40:40 +01:00
$route = untrailingslashit ( $GLOBALS [ 'wp' ] -> query_vars [ 'rest_route' ] );
if ( empty ( $route ) ) {
$route = '/' ;
}
$server -> serve_request ( $route );
2015-11-20 08:24:30 +01:00
// We're done.
die ();
}
/**
* Retrieves the URL prefix for any API resource .
*
* @ since 4.4 . 0
*
* @ return string Prefix .
*/
function rest_get_url_prefix () {
/**
2016-05-22 20:50:28 +02:00
* Filters the REST URL prefix .
2015-11-20 08:24:30 +01:00
*
* @ since 4.4 . 0
*
* @ param string $prefix URL prefix . Default 'wp-json' .
*/
return apply_filters ( 'rest_url_prefix' , 'wp-json' );
}
/**
* Retrieves the URL to a REST endpoint on a site .
*
* Note : The returned URL is NOT escaped .
*
* @ since 4.4 . 0
*
* @ todo Check if this is even necessary
2019-08-04 03:19:56 +02:00
* @ global WP_Rewrite $wp_rewrite WordPress rewrite component .
2015-11-20 08:24:30 +01:00
*
* @ param int $blog_id Optional . Blog ID . Default of null returns URL for current blog .
* @ param string $path Optional . REST route . Default '/' .
* @ param string $scheme Optional . Sanitization scheme . Default 'rest' .
* @ return string Full URL to the endpoint .
*/
function get_rest_url ( $blog_id = null , $path = '/' , $scheme = 'rest' ) {
if ( empty ( $path ) ) {
$path = '/' ;
}
2017-11-28 08:10:46 +01:00
$path = '/' . ltrim ( $path , '/' );
2015-11-20 08:24:30 +01:00
if ( is_multisite () && get_blog_option ( $blog_id , 'permalink_structure' ) || get_option ( 'permalink_structure' ) ) {
2016-10-14 21:30:29 +02:00
global $wp_rewrite ;
if ( $wp_rewrite -> using_index_permalinks () ) {
$url = get_home_url ( $blog_id , $wp_rewrite -> index . '/' . rest_get_url_prefix (), $scheme );
} else {
$url = get_home_url ( $blog_id , rest_get_url_prefix (), $scheme );
}
2017-11-28 08:10:46 +01:00
$url .= $path ;
2015-11-20 08:24:30 +01:00
} else {
$url = trailingslashit ( get_home_url ( $blog_id , '' , $scheme ) );
2020-01-29 01:45:18 +01:00
// nginx only allows HTTP/1.0 methods when redirecting from / to /index.php.
2017-07-25 02:50:43 +02:00
// To work around this, we manually add index.php to the URL, avoiding the redirect.
if ( 'index.php' !== substr ( $url , 9 ) ) {
$url .= 'index.php' ;
}
2015-11-20 08:24:30 +01:00
$url = add_query_arg ( 'rest_route' , $path , $url );
}
2019-08-08 22:20:55 +02:00
if ( is_ssl () && isset ( $_SERVER [ 'SERVER_NAME' ] ) ) {
2015-11-20 08:24:30 +01:00
// If the current host is the same as the REST URL host, force the REST URL scheme to HTTPS.
2020-02-09 17:55:09 +01:00
if ( parse_url ( get_home_url ( $blog_id ), PHP_URL_HOST ) === $_SERVER [ 'SERVER_NAME' ] ) {
2015-11-20 08:24:30 +01:00
$url = set_url_scheme ( $url , 'https' );
}
}
2017-05-25 20:02:41 +02:00
if ( is_admin () && force_ssl_admin () ) {
2020-01-29 01:45:18 +01:00
/*
* In this situation the home URL may be http : , and `is_ssl()` may be false ,
* but the admin is served over https : ( one way or another ), so REST API usage
* will be blocked by browsers unless it is also served over HTTPS .
*/
2017-05-25 20:02:41 +02:00
$url = set_url_scheme ( $url , 'https' );
}
2015-11-20 08:24:30 +01:00
/**
2016-05-22 20:50:28 +02:00
* Filters the REST URL .
2015-11-20 08:24:30 +01:00
*
2016-05-23 21:02:28 +02:00
* Use this filter to adjust the url returned by the get_rest_url () function .
2015-11-20 08:24:30 +01:00
*
* @ since 4.4 . 0
*
* @ param string $url REST URL .
* @ param string $path REST route .
* @ param int $blog_id Blog ID .
* @ param string $scheme Sanitization scheme .
*/
return apply_filters ( 'rest_url' , $url , $path , $blog_id , $scheme );
}
/**
* Retrieves the URL to a REST endpoint .
*
* Note : The returned URL is NOT escaped .
*
* @ since 4.4 . 0
*
* @ param string $path Optional . REST route . Default empty .
2019-09-22 21:15:57 +02:00
* @ param string $scheme Optional . Sanitization scheme . Default 'rest' .
2015-11-20 08:24:30 +01:00
* @ return string Full URL to the endpoint .
*/
2019-09-22 21:15:57 +02:00
function rest_url ( $path = '' , $scheme = 'rest' ) {
2015-11-20 08:24:30 +01:00
return get_rest_url ( null , $path , $scheme );
}
/**
* Do a REST request .
*
* Used primarily to route internal requests through WP_REST_Server .
*
* @ since 4.4 . 0
*
* @ param WP_REST_Request | string $request Request .
* @ return WP_REST_Response REST response .
*/
function rest_do_request ( $request ) {
$request = rest_ensure_request ( $request );
2016-02-16 02:12:26 +01:00
return rest_get_server () -> dispatch ( $request );
}
/**
2016-03-10 19:49:26 +01:00
* Retrieves the current REST server instance .
2016-02-16 02:12:26 +01:00
*
* Instantiates a new instance if none exists already .
*
* @ since 4.5 . 0
*
* @ global WP_REST_Server $wp_rest_server REST server instance .
*
2016-03-10 19:49:26 +01:00
* @ return WP_REST_Server REST server instance .
2016-02-16 02:12:26 +01:00
*/
function rest_get_server () {
/* @var WP_REST_Server $wp_rest_server */
global $wp_rest_server ;
if ( empty ( $wp_rest_server ) ) {
/**
2016-05-22 20:50:28 +02:00
* Filters the REST Server Class .
2016-02-16 02:12:26 +01:00
*
* This filter allows you to adjust the server class used by the API , using a
* different class to handle requests .
*
* @ since 4.4 . 0
*
* @ param string $class_name The name of the server class . Default 'WP_REST_Server' .
*/
$wp_rest_server_class = apply_filters ( 'wp_rest_server_class' , 'WP_REST_Server' );
2017-12-01 00:11:00 +01:00
$wp_rest_server = new $wp_rest_server_class ;
2016-02-16 02:12:26 +01:00
/**
* Fires when preparing to serve an API request .
*
* Endpoint objects should be created and register their hooks on this action rather
* than another action to ensure they ' re only loaded when needed .
*
* @ since 4.4 . 0
*
* @ param WP_REST_Server $wp_rest_server Server object .
*/
do_action ( 'rest_api_init' , $wp_rest_server );
}
return $wp_rest_server ;
2015-11-20 08:24:30 +01:00
}
/**
* Ensures request arguments are a request object ( for consistency ) .
*
* @ since 4.4 . 0
2019-09-12 23:47:57 +02:00
* @ since 5.3 . 0 Accept string argument for the request path .
2015-11-20 08:24:30 +01:00
*
2019-09-12 23:47:57 +02:00
* @ param array | string | WP_REST_Request $request Request to check .
2015-11-20 08:24:30 +01:00
* @ return WP_REST_Request REST request instance .
*/
function rest_ensure_request ( $request ) {
if ( $request instanceof WP_REST_Request ) {
return $request ;
}
2019-09-12 23:47:57 +02:00
if ( is_string ( $request ) ) {
return new WP_REST_Request ( 'GET' , $request );
}
2015-11-20 08:24:30 +01:00
return new WP_REST_Request ( 'GET' , '' , $request );
}
/**
* Ensures a REST response is a response object ( for consistency ) .
*
2020-05-23 16:36:09 +02:00
* This implements WP_REST_Response , allowing usage of `set_status` / `header` / etc
2015-11-20 08:24:30 +01:00
* without needing to double - check the object . Will also allow WP_Error to indicate error
* responses , so users should immediately check for this value .
*
* @ since 4.4 . 0
*
2020-05-23 16:36:09 +02:00
* @ param WP_REST_Response | WP_Error | WP_HTTP_Response | mixed $response Response to check .
* @ return WP_REST_Response | WP_Error If response generated an error , WP_Error , if response
* is already an instance , WP_REST_Response , otherwise
* returns a new WP_REST_Response instance .
2015-11-20 08:24:30 +01:00
*/
function rest_ensure_response ( $response ) {
if ( is_wp_error ( $response ) ) {
return $response ;
}
2020-05-23 16:36:09 +02:00
if ( $response instanceof WP_REST_Response ) {
2015-11-20 08:24:30 +01:00
return $response ;
}
2020-05-23 16:36:09 +02:00
// While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide
// all the required methods used in WP_REST_Server::dispatch().
if ( $response instanceof WP_HTTP_Response ) {
return new WP_REST_Response (
$response -> get_data (),
$response -> get_status (),
$response -> get_headers ()
);
}
2015-11-20 08:24:30 +01:00
return new WP_REST_Response ( $response );
}
/**
* Handles _deprecated_function () errors .
*
* @ since 4.4 . 0
*
2015-12-09 22:26:29 +01:00
* @ param string $function The function that was called .
* @ param string $replacement The function that should have been called .
2015-11-20 08:24:30 +01:00
* @ param string $version Version .
*/
function rest_handle_deprecated_function ( $function , $replacement , $version ) {
2017-05-18 19:49:42 +02:00
if ( ! WP_DEBUG || headers_sent () ) {
return ;
}
2015-11-20 08:24:30 +01:00
if ( ! empty ( $replacement ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Function name, 2: WordPress version number, 3: New function name. */
2015-11-20 08:24:30 +01:00
$string = sprintf ( __ ( '%1$s (since %2$s; use %3$s instead)' ), $function , $version , $replacement );
} else {
2019-09-03 02:41:05 +02:00
/* translators: 1: Function name, 2: WordPress version number. */
2015-11-20 08:24:30 +01:00
$string = sprintf ( __ ( '%1$s (since %2$s; no alternative available)' ), $function , $version );
}
header ( sprintf ( 'X-WP-DeprecatedFunction: %s' , $string ) );
}
/**
* Handles _deprecated_argument () errors .
*
* @ since 4.4 . 0
*
2015-12-09 22:26:29 +01:00
* @ param string $function The function that was called .
* @ param string $message A message regarding the change .
2015-11-20 08:24:30 +01:00
* @ param string $version Version .
*/
2015-12-09 22:26:29 +01:00
function rest_handle_deprecated_argument ( $function , $message , $version ) {
2017-05-18 19:49:42 +02:00
if ( ! WP_DEBUG || headers_sent () ) {
return ;
}
2015-12-09 22:26:29 +01:00
if ( ! empty ( $message ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Function name, 2: WordPress version number, 3: Error message. */
2015-12-09 22:26:29 +01:00
$string = sprintf ( __ ( '%1$s (since %2$s; %3$s)' ), $function , $version , $message );
2015-11-20 08:24:30 +01:00
} else {
2019-09-03 02:41:05 +02:00
/* translators: 1: Function name, 2: WordPress version number. */
2015-11-20 08:24:30 +01:00
$string = sprintf ( __ ( '%1$s (since %2$s; no alternative available)' ), $function , $version );
}
header ( sprintf ( 'X-WP-DeprecatedParam: %s' , $string ) );
}
/**
* Sends Cross - Origin Resource Sharing headers with API requests .
*
* @ since 4.4 . 0
*
* @ param mixed $value Response data .
* @ return mixed Response data .
*/
function rest_send_cors_headers ( $value ) {
$origin = get_http_origin ();
if ( $origin ) {
2020-01-29 01:45:18 +01:00
// Requests from file:// and data: URLs send "Origin: null".
2017-05-10 06:22:43 +02:00
if ( 'null' !== $origin ) {
$origin = esc_url_raw ( $origin );
}
header ( 'Access-Control-Allow-Origin: ' . $origin );
2016-10-31 01:19:30 +01:00
header ( 'Access-Control-Allow-Methods: OPTIONS, GET, POST, PUT, PATCH, DELETE' );
2015-11-20 08:24:30 +01:00
header ( 'Access-Control-Allow-Credentials: true' );
2019-10-15 17:47:03 +02:00
header ( 'Vary: Origin' , false );
2019-10-14 18:25:04 +02:00
} elseif ( ! headers_sent () && 'GET' === $_SERVER [ 'REQUEST_METHOD' ] && ! is_user_logged_in () ) {
2019-10-15 17:47:03 +02:00
header ( 'Vary: Origin' , false );
2015-11-20 08:24:30 +01:00
}
return $value ;
}
/**
* Handles OPTIONS requests for the server .
*
* This is handled outside of the server code , as it doesn ' t obey normal route
* mapping .
*
* @ since 4.4 . 0
*
* @ param mixed $response Current response , either response or `null` to indicate pass - through .
* @ param WP_REST_Server $handler ResponseHandler instance ( usually WP_REST_Server ) .
* @ param WP_REST_Request $request The request that was used to make current response .
* @ return WP_REST_Response Modified response , either response or `null` to indicate pass - through .
*/
function rest_handle_options_request ( $response , $handler , $request ) {
if ( ! empty ( $response ) || $request -> get_method () !== 'OPTIONS' ) {
return $response ;
}
$response = new WP_REST_Response ();
2017-12-01 00:11:00 +01:00
$data = array ();
2015-11-20 08:24:30 +01:00
foreach ( $handler -> get_routes () as $route => $endpoints ) {
2019-03-19 04:22:51 +01:00
$match = preg_match ( '@^' . $route . '$@i' , $request -> get_route (), $matches );
2015-11-20 08:24:30 +01:00
if ( ! $match ) {
continue ;
}
2019-03-19 04:22:51 +01:00
$args = array ();
foreach ( $matches as $param => $value ) {
if ( ! is_int ( $param ) ) {
$args [ $param ] = $value ;
}
}
foreach ( $endpoints as $endpoint ) {
2020-01-29 01:45:18 +01:00
// Remove the redundant preg_match() argument.
2019-03-19 04:22:51 +01:00
unset ( $args [ 0 ] );
$request -> set_url_params ( $args );
$request -> set_attributes ( $endpoint );
}
2015-11-20 08:24:30 +01:00
$data = $handler -> get_data_for_route ( $route , $endpoints , 'help' );
2016-03-03 10:55:26 +01:00
$response -> set_matched_route ( $route );
2015-11-20 08:24:30 +01:00
break ;
}
$response -> set_data ( $data );
return $response ;
}
/**
* Sends the " Allow " header to state all methods that can be sent to the current route .
*
* @ since 4.4 . 0
*
* @ param WP_REST_Response $response Current response being served .
* @ param WP_REST_Server $server ResponseHandler instance ( usually WP_REST_Server ) .
* @ param WP_REST_Request $request The request that was used to make current response .
* @ return WP_REST_Response Response to be served , with " Allow " header if route has allowed methods .
*/
function rest_send_allow_header ( $response , $server , $request ) {
$matched_route = $response -> get_matched_route ();
if ( ! $matched_route ) {
return $response ;
}
$routes = $server -> get_routes ();
$allowed_methods = array ();
// Get the allowed methods across the routes.
foreach ( $routes [ $matched_route ] as $_handler ) {
foreach ( $_handler [ 'methods' ] as $handler_method => $value ) {
if ( ! empty ( $_handler [ 'permission_callback' ] ) ) {
$permission = call_user_func ( $_handler [ 'permission_callback' ], $request );
$allowed_methods [ $handler_method ] = true === $permission ;
} else {
$allowed_methods [ $handler_method ] = true ;
}
}
}
// Strip out all the methods that are not allowed (false values).
$allowed_methods = array_filter ( $allowed_methods );
if ( $allowed_methods ) {
$response -> header ( 'Allow' , implode ( ', ' , array_map ( 'strtoupper' , array_keys ( $allowed_methods ) ) ) );
}
return $response ;
}
2019-09-19 16:05:55 +02:00
/**
* Recursively computes the intersection of arrays using keys for comparison .
*
2020-06-20 13:18:09 +02:00
* @ since 5.3 . 0
*
2020-06-20 14:58:10 +02:00
* @ param array $array1 The array with master keys to check .
* @ param array $array2 An array to compare keys against .
2020-06-20 13:18:09 +02:00
* @ return array An associative array containing all the entries of array1 which have keys
* that are present in all arguments .
2019-09-19 16:05:55 +02:00
*/
function _rest_array_intersect_key_recursive ( $array1 , $array2 ) {
$array1 = array_intersect_key ( $array1 , $array2 );
foreach ( $array1 as $key => $value ) {
if ( is_array ( $value ) && is_array ( $array2 [ $key ] ) ) {
$array1 [ $key ] = _rest_array_intersect_key_recursive ( $value , $array2 [ $key ] );
}
}
return $array1 ;
}
2017-10-04 20:46:38 +02:00
/**
* Filter the API response to include only a white - listed set of response object fields .
*
* @ since 4.8 . 0
*
* @ param WP_REST_Response $response Current response being served .
* @ param WP_REST_Server $server ResponseHandler instance ( usually WP_REST_Server ) .
* @ param WP_REST_Request $request The request that was used to make current response .
* @ return WP_REST_Response Response to be served , trimmed down to contain a subset of fields .
*/
function rest_filter_response_fields ( $response , $server , $request ) {
if ( ! isset ( $request [ '_fields' ] ) || $response -> is_error () ) {
return $response ;
}
$data = $response -> get_data ();
2019-01-10 22:06:49 +01:00
$fields = wp_parse_list ( $request [ '_fields' ] );
2017-10-04 20:46:38 +02:00
if ( 0 === count ( $fields ) ) {
return $response ;
}
// Trim off outside whitespace from the comma delimited list.
$fields = array_map ( 'trim' , $fields );
2019-09-19 16:05:55 +02:00
// Create nested array of accepted field hierarchy.
$fields_as_keyed = array ();
foreach ( $fields as $field ) {
$parts = explode ( '.' , $field );
$ref = & $fields_as_keyed ;
while ( count ( $parts ) > 1 ) {
2019-10-10 19:18:03 +02:00
$next = array_shift ( $parts );
if ( isset ( $ref [ $next ] ) && true === $ref [ $next ] ) {
// Skip any sub-properties if their parent prop is already marked for inclusion.
break 2 ;
}
$ref [ $next ] = isset ( $ref [ $next ] ) ? $ref [ $next ] : array ();
2019-09-19 16:05:55 +02:00
$ref = & $ref [ $next ];
}
$last = array_shift ( $parts );
$ref [ $last ] = true ;
}
2017-10-04 20:46:38 +02:00
if ( wp_is_numeric_array ( $data ) ) {
$new_data = array ();
foreach ( $data as $item ) {
2019-09-19 16:05:55 +02:00
$new_data [] = _rest_array_intersect_key_recursive ( $item , $fields_as_keyed );
2017-10-04 20:46:38 +02:00
}
} else {
2019-09-19 16:05:55 +02:00
$new_data = _rest_array_intersect_key_recursive ( $data , $fields_as_keyed );
2017-10-04 20:46:38 +02:00
}
$response -> set_data ( $new_data );
return $response ;
}
2019-09-19 16:05:55 +02:00
/**
* Given an array of fields to include in a response , some of which may be
* `nested.fields` , determine whether the provided field should be included
* in the response body .
*
* If a parent field is passed in , the presence of any nested field within
* that parent will cause the method to return `true` . For example " title "
* will return true if any of `title` , `title.raw` or `title.rendered` is
* provided .
*
* @ since 5.3 . 0
*
* @ param string $field A field to test for inclusion in the response body .
* @ param array $fields An array of string fields supported by the endpoint .
* @ return bool Whether to include the field or not .
*/
function rest_is_field_included ( $field , $fields ) {
if ( in_array ( $field , $fields , true ) ) {
return true ;
}
2020-01-29 01:45:18 +01:00
2019-09-19 16:05:55 +02:00
foreach ( $fields as $accepted_field ) {
// Check to see if $field is the parent of any item in $fields.
// A field "parent" should be accepted if "parent.child" is accepted.
if ( strpos ( $accepted_field , " $field . " ) === 0 ) {
return true ;
}
2020-01-29 01:45:18 +01:00
// Conversely, if "parent" is accepted, all "parent.child" fields
// should also be accepted.
2019-09-19 16:05:55 +02:00
if ( strpos ( $field , " $accepted_field . " ) === 0 ) {
return true ;
}
}
2020-01-29 01:45:18 +01:00
2019-09-19 16:05:55 +02:00
return false ;
}
2015-11-20 08:24:30 +01:00
/**
* Adds the REST API URL to the WP RSD endpoint .
*
* @ since 4.4 . 0
*
* @ see get_rest_url ()
*/
function rest_output_rsd () {
$api_root = get_rest_url ();
if ( empty ( $api_root ) ) {
return ;
}
?>
< api name = " WP-API " blogID = " 1 " preferred = " false " apiLink = " <?php echo esc_url( $api_root ); ?> " />
< ? php
}
/**
* Outputs the REST API link tag into page header .
*
* @ since 4.4 . 0
*
* @ see get_rest_url ()
*/
function rest_output_link_wp_head () {
$api_root = get_rest_url ();
if ( empty ( $api_root ) ) {
return ;
}
echo " <link rel='https://api.w.org/' href=' " . esc_url ( $api_root ) . " ' /> \n " ;
}
/**
* Sends a Link header for the REST API .
*
* @ since 4.4 . 0
*/
function rest_output_link_header () {
if ( headers_sent () ) {
return ;
}
$api_root = get_rest_url ();
if ( empty ( $api_root ) ) {
return ;
}
header ( 'Link: <' . esc_url_raw ( $api_root ) . '>; rel="https://api.w.org/"' , false );
}
/**
* Checks for errors when using cookie - based authentication .
*
* WordPress ' built - in cookie authentication is always active
* for logged in users . However , the API has to check nonces
* for each request to ensure users are not vulnerable to CSRF .
*
* @ since 4.4 . 0
*
2016-06-29 05:02:07 +02:00
* @ global mixed $wp_rest_auth_cookie
2015-11-20 08:24:30 +01:00
*
2016-06-29 05:02:07 +02:00
* @ param WP_Error | mixed $result Error from another authentication handler ,
2019-11-11 03:43:03 +01:00
* null if we should handle it , or another value if not .
2015-11-20 08:24:30 +01:00
* @ return WP_Error | mixed | bool WP_Error if the cookie is invalid , the $result , otherwise true .
*/
function rest_cookie_check_errors ( $result ) {
if ( ! empty ( $result ) ) {
return $result ;
}
2017-08-10 03:38:43 +02:00
global $wp_rest_auth_cookie ;
2015-11-20 08:24:30 +01:00
/*
* Is cookie authentication being used ? ( If we get an auth
* error , but we ' re still logged in , another authentication
* must have been used ) .
*/
if ( true !== $wp_rest_auth_cookie && is_user_logged_in () ) {
return $result ;
}
// Determine if there is a nonce.
$nonce = null ;
if ( isset ( $_REQUEST [ '_wpnonce' ] ) ) {
$nonce = $_REQUEST [ '_wpnonce' ];
} elseif ( isset ( $_SERVER [ 'HTTP_X_WP_NONCE' ] ) ) {
$nonce = $_SERVER [ 'HTTP_X_WP_NONCE' ];
}
if ( null === $nonce ) {
// No nonce at all, so act as if it's an unauthenticated request.
wp_set_current_user ( 0 );
return true ;
}
// Check the nonce.
$result = wp_verify_nonce ( $nonce , 'wp_rest' );
if ( ! $result ) {
return new WP_Error ( 'rest_cookie_invalid_nonce' , __ ( 'Cookie nonce is invalid' ), array ( 'status' => 403 ) );
}
2016-06-29 05:02:07 +02:00
// Send a refreshed nonce in header.
2017-08-10 03:38:43 +02:00
rest_get_server () -> send_header ( 'X-WP-Nonce' , wp_create_nonce ( 'wp_rest' ) );
2016-06-29 05:02:07 +02:00
2015-11-20 08:24:30 +01:00
return true ;
}
/**
* Collects cookie authentication status .
*
* Collects errors from wp_validate_auth_cookie for use by rest_cookie_check_errors .
*
* @ since 4.4 . 0
*
* @ see current_action ()
* @ global mixed $wp_rest_auth_cookie
*/
function rest_cookie_collect_status () {
global $wp_rest_auth_cookie ;
$status_type = current_action ();
if ( 'auth_cookie_valid' !== $status_type ) {
$wp_rest_auth_cookie = substr ( $status_type , 12 );
return ;
}
$wp_rest_auth_cookie = true ;
}
/**
2015-12-25 21:41:26 +01:00
* Parses an RFC3339 time into a Unix timestamp .
2015-11-20 08:24:30 +01:00
*
* @ since 4.4 . 0
*
* @ param string $date RFC3339 timestamp .
* @ param bool $force_utc Optional . Whether to force UTC timezone instead of using
* the timestamp ' s timezone . Default false .
2015-12-25 21:41:26 +01:00
* @ return int Unix timestamp .
2015-11-20 08:24:30 +01:00
*/
function rest_parse_date ( $date , $force_utc = false ) {
if ( $force_utc ) {
$date = preg_replace ( '/[+-]\d+:?\d+$/' , '+00:00' , $date );
}
$regex = '#^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}(?::\d{2})?)?$#' ;
if ( ! preg_match ( $regex , $date , $matches ) ) {
return false ;
}
return strtotime ( $date );
}
2020-03-12 03:42:08 +01:00
/**
* Parses a 3 or 6 digit hex color ( with #).
*
* @ since 5.4 . 0
*
* @ param string $color 3 or 6 digit hex color ( with #).
* @ return string | false
*/
function rest_parse_hex_color ( $color ) {
$regex = '|^#([A-Fa-f0-9]{3}){1,2}$|' ;
if ( ! preg_match ( $regex , $color , $matches ) ) {
return false ;
}
return $color ;
}
2015-11-20 08:24:30 +01:00
/**
2017-02-21 19:18:45 +01:00
* Parses a date into both its local and UTC equivalent , in MySQL datetime format .
2015-11-20 08:24:30 +01:00
*
* @ since 4.4 . 0
*
* @ see rest_parse_date ()
*
2017-02-21 19:18:45 +01:00
* @ param string $date RFC3339 timestamp .
* @ param bool $is_utc Whether the provided date should be interpreted as UTC . Default false .
2015-11-20 08:24:30 +01:00
* @ return array | null Local and UTC datetime strings , in MySQL datetime format ( Y - m - d H : i : s ),
* null on failure .
*/
2017-02-21 19:18:45 +01:00
function rest_get_date_with_gmt ( $date , $is_utc = false ) {
2020-01-29 01:45:18 +01:00
/*
* Whether or not the original date actually has a timezone string
* changes the way we need to do timezone conversion .
* Store this info before parsing the date , and use it later .
*/
2017-02-21 19:18:45 +01:00
$has_timezone = preg_match ( '#(Z|[+-]\d{2}(:\d{2})?)$#' , $date );
$date = rest_parse_date ( $date );
REST API: Introduce baby API to the world.
Baby API was born at 2.8KLOC on October 8th at 2:30 UTC. API has lots
of growing to do, so wish it the best of luck.
Thanks to everyone who helped along the way:
Props rmccue, rachelbaker, danielbachhuber, joehoyle, drewapicture,
adamsilverstein, netweb, tlovett1, shelob9, kadamwhite, pento,
westonruter, nikv, tobych, redsweater, alecuf, pollyplummer, hurtige,
bpetty, oso96_2000, ericlewis, wonderboymusic, joshkadis, mordauk,
jdgrimes, johnbillion, jeremyfelt, thiago-negri, jdolan, pkevan,
iseulde, thenbrent, maxcutler, kwight, markoheijnen, phh, natewr,
jjeaton, shprink, mattheu, quasel, jmusal, codebykat, hubdotcom,
tapsboy, QWp6t, pushred, jaredcobb, justinsainton, japh, matrixik,
jorbin, frozzare, codfish, michael-arestad, kellbot, ironpaperweight,
simonlampen, alisspers, eliorivero, davidbhayes, JohnDittmar, dimadin,
traversal, cmmarslender, Toddses, kokarn, welcher, and ericpedia.
Fixes #33982.
Built from https://develop.svn.wordpress.org/trunk@34928
git-svn-id: http://core.svn.wordpress.org/trunk@34893 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-08 04:31:25 +02:00
2015-11-20 08:24:30 +01:00
if ( empty ( $date ) ) {
return null ;
}
REST API: Introduce baby API to the world.
Baby API was born at 2.8KLOC on October 8th at 2:30 UTC. API has lots
of growing to do, so wish it the best of luck.
Thanks to everyone who helped along the way:
Props rmccue, rachelbaker, danielbachhuber, joehoyle, drewapicture,
adamsilverstein, netweb, tlovett1, shelob9, kadamwhite, pento,
westonruter, nikv, tobych, redsweater, alecuf, pollyplummer, hurtige,
bpetty, oso96_2000, ericlewis, wonderboymusic, joshkadis, mordauk,
jdgrimes, johnbillion, jeremyfelt, thiago-negri, jdolan, pkevan,
iseulde, thenbrent, maxcutler, kwight, markoheijnen, phh, natewr,
jjeaton, shprink, mattheu, quasel, jmusal, codebykat, hubdotcom,
tapsboy, QWp6t, pushred, jaredcobb, justinsainton, japh, matrixik,
jorbin, frozzare, codfish, michael-arestad, kellbot, ironpaperweight,
simonlampen, alisspers, eliorivero, davidbhayes, JohnDittmar, dimadin,
traversal, cmmarslender, Toddses, kokarn, welcher, and ericpedia.
Fixes #33982.
Built from https://develop.svn.wordpress.org/trunk@34928
git-svn-id: http://core.svn.wordpress.org/trunk@34893 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-08 04:31:25 +02:00
2020-01-29 01:45:18 +01:00
/*
* At this point $date could either be a local date ( if we were passed
* a * local * date without a timezone offset ) or a UTC date ( otherwise ) .
* Timezone conversion needs to be handled differently between these two cases .
*/
2017-02-21 19:18:45 +01:00
if ( ! $is_utc && ! $has_timezone ) {
2019-05-26 02:12:54 +02:00
$local = gmdate ( 'Y-m-d H:i:s' , $date );
2017-12-01 00:11:00 +01:00
$utc = get_gmt_from_date ( $local );
2017-02-21 19:18:45 +01:00
} else {
2019-05-26 02:12:54 +02:00
$utc = gmdate ( 'Y-m-d H:i:s' , $date );
2017-02-21 19:18:45 +01:00
$local = get_date_from_gmt ( $utc );
}
REST API: Introduce baby API to the world.
Baby API was born at 2.8KLOC on October 8th at 2:30 UTC. API has lots
of growing to do, so wish it the best of luck.
Thanks to everyone who helped along the way:
Props rmccue, rachelbaker, danielbachhuber, joehoyle, drewapicture,
adamsilverstein, netweb, tlovett1, shelob9, kadamwhite, pento,
westonruter, nikv, tobych, redsweater, alecuf, pollyplummer, hurtige,
bpetty, oso96_2000, ericlewis, wonderboymusic, joshkadis, mordauk,
jdgrimes, johnbillion, jeremyfelt, thiago-negri, jdolan, pkevan,
iseulde, thenbrent, maxcutler, kwight, markoheijnen, phh, natewr,
jjeaton, shprink, mattheu, quasel, jmusal, codebykat, hubdotcom,
tapsboy, QWp6t, pushred, jaredcobb, justinsainton, japh, matrixik,
jorbin, frozzare, codfish, michael-arestad, kellbot, ironpaperweight,
simonlampen, alisspers, eliorivero, davidbhayes, JohnDittmar, dimadin,
traversal, cmmarslender, Toddses, kokarn, welcher, and ericpedia.
Fixes #33982.
Built from https://develop.svn.wordpress.org/trunk@34928
git-svn-id: http://core.svn.wordpress.org/trunk@34893 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-08 04:31:25 +02:00
2015-11-20 08:24:30 +01:00
return array ( $local , $utc );
}
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
/**
* Returns a contextual HTTP error code for authorization failure .
*
* @ since 4.7 . 0
*
* @ return integer 401 if the user is not logged in , 403 if the user is logged in .
*/
function rest_authorization_required_code () {
return is_user_logged_in () ? 403 : 401 ;
}
/**
* Validate a request argument based on details registered to the route .
*
* @ since 4.7 . 0
*
2020-06-20 14:58:10 +02:00
* @ param mixed $value
* @ param WP_REST_Request $request
* @ param string $param
2019-11-11 03:43:03 +01:00
* @ return true | WP_Error
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*/
function rest_validate_request_arg ( $value , $request , $param ) {
$attributes = $request -> get_attributes ();
if ( ! isset ( $attributes [ 'args' ][ $param ] ) || ! is_array ( $attributes [ 'args' ][ $param ] ) ) {
return true ;
}
$args = $attributes [ 'args' ][ $param ];
2016-10-31 02:48:41 +01:00
return rest_validate_value_from_schema ( $value , $args , $param );
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
/**
* Sanitize a request argument based on details registered to the route .
*
* @ since 4.7 . 0
*
2020-06-20 14:58:10 +02:00
* @ param mixed $value
* @ param WP_REST_Request $request
* @ param string $param
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
* @ return mixed
*/
function rest_sanitize_request_arg ( $value , $request , $param ) {
$attributes = $request -> get_attributes ();
if ( ! isset ( $attributes [ 'args' ][ $param ] ) || ! is_array ( $attributes [ 'args' ][ $param ] ) ) {
return $value ;
}
$args = $attributes [ 'args' ][ $param ];
2016-12-01 03:12:41 +01:00
return rest_sanitize_value_from_schema ( $value , $args );
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
/**
* Parse a request argument based on details registered to the route .
*
* Runs a validation check and sanitizes the value , primarily to be used via
* the `sanitize_callback` arguments in the endpoint args registration .
*
* @ since 4.7 . 0
*
2020-06-20 14:58:10 +02:00
* @ param mixed $value
* @ param WP_REST_Request $request
* @ param string $param
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
* @ return mixed
*/
function rest_parse_request_arg ( $value , $request , $param ) {
$is_valid = rest_validate_request_arg ( $value , $request , $param );
if ( is_wp_error ( $is_valid ) ) {
return $is_valid ;
}
$value = rest_sanitize_request_arg ( $value , $request , $param );
return $value ;
}
/**
2016-11-18 20:33:31 +01:00
* Determines if an IP address is valid .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*
2016-11-18 20:33:31 +01:00
* Handles both IPv4 and IPv6 addresses .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*
* @ since 4.7 . 0
*
2020-06-20 14:58:10 +02:00
* @ param string $ip IP address .
2016-11-18 20:33:31 +01:00
* @ return string | false The valid IP address , otherwise false .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*/
2016-11-18 20:33:31 +01:00
function rest_is_ip_address ( $ip ) {
$ipv4_pattern = '/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/' ;
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
2016-11-18 20:33:31 +01:00
if ( ! preg_match ( $ipv4_pattern , $ip ) && ! Requests_IPv6 :: check_ipv6 ( $ip ) ) {
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
return false ;
}
2016-11-18 20:33:31 +01:00
return $ip ;
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
/**
* Changes a boolean - like value into the proper boolean value .
*
* @ since 4.7 . 0
*
* @ param bool | string | int $value The value being evaluated .
* @ return boolean Returns the proper associated boolean value .
*/
function rest_sanitize_boolean ( $value ) {
// String values are translated to `true`; make sure 'false' is false.
2017-12-01 00:11:00 +01:00
if ( is_string ( $value ) ) {
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
$value = strtolower ( $value );
if ( in_array ( $value , array ( 'false' , '0' ), true ) ) {
$value = false ;
}
}
// Everything else will map nicely to boolean.
2018-12-11 23:30:24 +01:00
return ( bool ) $value ;
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
/**
* Determines if a given value is boolean - like .
*
* @ since 4.7 . 0
*
* @ param bool | string $maybe_bool The value being evaluated .
* @ return boolean True if a boolean , otherwise false .
*/
function rest_is_boolean ( $maybe_bool ) {
if ( is_bool ( $maybe_bool ) ) {
return true ;
}
if ( is_string ( $maybe_bool ) ) {
$maybe_bool = strtolower ( $maybe_bool );
$valid_boolean_values = array (
'false' ,
'true' ,
'0' ,
'1' ,
);
return in_array ( $maybe_bool , $valid_boolean_values , true );
}
if ( is_int ( $maybe_bool ) ) {
return in_array ( $maybe_bool , array ( 0 , 1 ), true );
}
return false ;
}
/**
REST API: Allow `rest_get_avatar_urls()` to accept full user, post, or comment objects, rather than just an email address, to provide better flexibility for alternative avatar data.
Since the function uses `get_avatar_url()` internally, which already supports it, this should not have any backward compatibility concerns.
Props donmhico, dshanske, pputzer, joehoyle, TimothyBlynJacobs.
Fixes #40030.
Built from https://develop.svn.wordpress.org/trunk@45632
git-svn-id: http://core.svn.wordpress.org/trunk@45443 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-14 16:35:56 +02:00
* Retrieves the avatar urls in various sizes .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*
* @ since 4.7 . 0
*
* @ see get_avatar_url ()
*
REST API: Allow `rest_get_avatar_urls()` to accept full user, post, or comment objects, rather than just an email address, to provide better flexibility for alternative avatar data.
Since the function uses `get_avatar_url()` internally, which already supports it, this should not have any backward compatibility concerns.
Props donmhico, dshanske, pputzer, joehoyle, TimothyBlynJacobs.
Fixes #40030.
Built from https://develop.svn.wordpress.org/trunk@45632
git-svn-id: http://core.svn.wordpress.org/trunk@45443 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-14 16:35:56 +02:00
* @ param mixed $id_or_email The Gravatar to retrieve a URL for . Accepts a user_id , gravatar md5 hash ,
* user email , WP_User object , WP_Post object , or WP_Comment object .
2019-11-05 22:23:02 +01:00
* @ return array Avatar URLs keyed by size . Each value can be a URL string or boolean false .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*/
REST API: Allow `rest_get_avatar_urls()` to accept full user, post, or comment objects, rather than just an email address, to provide better flexibility for alternative avatar data.
Since the function uses `get_avatar_url()` internally, which already supports it, this should not have any backward compatibility concerns.
Props donmhico, dshanske, pputzer, joehoyle, TimothyBlynJacobs.
Fixes #40030.
Built from https://develop.svn.wordpress.org/trunk@45632
git-svn-id: http://core.svn.wordpress.org/trunk@45443 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-14 16:35:56 +02:00
function rest_get_avatar_urls ( $id_or_email ) {
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
$avatar_sizes = rest_get_avatar_sizes ();
$urls = array ();
foreach ( $avatar_sizes as $size ) {
REST API: Allow `rest_get_avatar_urls()` to accept full user, post, or comment objects, rather than just an email address, to provide better flexibility for alternative avatar data.
Since the function uses `get_avatar_url()` internally, which already supports it, this should not have any backward compatibility concerns.
Props donmhico, dshanske, pputzer, joehoyle, TimothyBlynJacobs.
Fixes #40030.
Built from https://develop.svn.wordpress.org/trunk@45632
git-svn-id: http://core.svn.wordpress.org/trunk@45443 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-14 16:35:56 +02:00
$urls [ $size ] = get_avatar_url ( $id_or_email , array ( 'size' => $size ) );
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
}
return $urls ;
}
/**
* Retrieves the pixel sizes for avatars .
*
* @ since 4.7 . 0
*
2019-11-05 22:23:02 +01:00
* @ return int [] List of pixel sizes for avatars . Default `[ 24, 48, 96 ]` .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*/
function rest_get_avatar_sizes () {
/**
2017-02-06 03:58:40 +01:00
* Filters the REST avatar sizes .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
*
* Use this filter to adjust the array of sizes returned by the
* `rest_get_avatar_sizes` function .
*
* @ since 4.4 . 0
*
2019-11-05 22:23:02 +01:00
* @ param int [] $sizes An array of int values that are the pixel sizes for avatars .
REST API: Introduce the Content API endpoints.
REST API endpoints for your WordPress content. These endpoints provide machine-readable external access to your WordPress site with a clear, standards-driven interface, allowing new and innovative apps for interacting with your site. These endpoints support all of the following:
- Posts: Read and write access to all post data, for all types of post-based data, including pages and media.
- Comments: Read and write access to all comment data. This includes pingbacks and trackbacks.
- Terms: Read and write access to all term data.
- Users: Read and write access to all user data. This includes public access to some data for post authors.
- Meta: Read and write access to metadata for posts, comments, terms, and users, on an opt-in basis from plugins.
- Settings: Read and write access to settings, on an opt-in basis from plugins and core. This enables API management of key site content values that are technically stored in options, such as site title and byline.
Love your REST API, WordPress! The infrastructure says, "Let's do lunch!" but the content API endpoints say, "You're paying!"
Props rmccue, rachelbaker, danielbachhuber, joehoyle, adamsilverstein, afurculita, ahmadawais, airesvsg, alisspers, antisilent, apokalyptik, artoliukkonen, attitude, boonebgorges, bradyvercher, brianhogg, caseypatrickdriscoll, chopinbach, chredd, christianesperar, chrisvanpatten, claudiolabarbera, claudiosmweb, cmmarslender, codebykat, coderkevin, codfish, codonnell822, daggerhart, danielpunkass, davidbhayes, delphinus, desrosj, dimadin, dotancohen, DrewAPicture, Dudo1985, duncanjbrown, eherman24, eivhyl, eliorivero, elyobo, en-alis, ericandrewlewis, ericpedia, evansobkowicz, fjarrett, frozzare, georgestephanis, greatislander, guavaworks, hideokamoto, hkdobrev, hubdotcom, hurtige, iandunn, ircrash, ironpaperweight, iseulde, Japh, jaredcobb, JDGrimes, jdolan, jdoubleu, jeremyfelt, jimt, jjeaton, jmusal, jnylen0, johanmynhardt, johnbillion, jonathanbardo, jorbin, joshkadis, JPry, jshreve, jtsternberg, JustinSainton, kacperszurek, kadamwhite, kalenjohnson, kellbot, kjbenk, kokarn, krogsgard, kuchenundkakao, kuldipem, kwight, lgedeon, lukepettway, mantismamita, markoheijnen, matrixik, mattheu, mauteri, maxcutler, mayukojpn, michael-arestad, miyauchi, mjbanks, modemlooper, mrbobbybryant, NateWr, nathanrice, netweb, NikV, nullvariable, oskosk, oso96_2000, oxymoron, pcfreak30, pento, peterwilsoncc, Pezzab, phh, pippinsplugins, pjgalbraith, pkevan, pollyplummer, pushred, quasel, QWp6t, schlessera, schrapel, Shelob9, shprink, simonlampen, Soean, solal, tapsboy, tfrommen, tharsheblows, thenbrent, tierra, tlovett1, tnegri, tobych, Toddses, toro_unit, traversal, vanillalounge, vishalkakadiya, wanecek, web2style, webbgaraget, websupporter, westonruter, whyisjake, wonderboymusic, wpsmith, xknown, zyphonic.
Fixes #38373.
Built from https://develop.svn.wordpress.org/trunk@38832
git-svn-id: http://core.svn.wordpress.org/trunk@38775 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-20 04:55:32 +02:00
* Default `[ 24, 48, 96 ]` .
*/
return apply_filters ( 'rest_avatar_sizes' , array ( 24 , 48 , 96 ) );
}
2016-10-31 02:48:41 +01:00
/**
* Validate a value based on a schema .
*
2016-12-27 10:21:44 +01:00
* @ since 4.7 . 0
2020-05-16 21:33:09 +02:00
* @ since 4.9 . 0 Support the " object " type .
* @ since 5.2 . 0 Support validating " additionalProperties " against a schema .
* @ since 5.3 . 0 Support multiple types .
* @ since 5.4 . 0 Convert an empty string to an empty object .
* @ since 5.5 . 0 Add the " uuid " and " hex-color " formats .
* Support the " minLength " , " maxLength " and " pattern " keywords for strings .
2020-05-16 21:56:09 +02:00
* Validate required properties .
2020-06-08 00:42:13 +02:00
* Support the " minItems " and " maxItems " keywords for arrays .
2016-12-27 10:21:44 +01:00
*
2016-10-31 02:48:41 +01:00
* @ param mixed $value The value to validate .
* @ param array $args Schema array to use for validation .
* @ param string $param The parameter name , used in error messages .
* @ return true | WP_Error
*/
function rest_validate_value_from_schema ( $value , $args , $param = '' ) {
2019-09-23 19:25:57 +02:00
if ( is_array ( $args [ 'type' ] ) ) {
foreach ( $args [ 'type' ] as $type ) {
$type_args = $args ;
$type_args [ 'type' ] = $type ;
if ( true === rest_validate_value_from_schema ( $value , $type_args , $param ) ) {
return true ;
}
}
/* translators: 1: Parameter, 2: List of types. */
2020-01-20 15:44:06 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , implode ( ',' , $args [ 'type' ] ) ) );
2019-09-23 19:25:57 +02:00
}
2016-10-31 02:48:41 +01:00
if ( 'array' === $args [ 'type' ] ) {
2019-01-10 22:06:49 +01:00
if ( ! is_null ( $value ) ) {
$value = wp_parse_list ( $value );
2016-10-31 02:48:41 +01:00
}
2020-01-29 01:45:18 +01:00
2016-11-14 17:36:33 +01:00
if ( ! wp_is_numeric_array ( $value ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Type name. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , 'array' ) );
2016-11-14 17:36:33 +01:00
}
2020-01-29 01:45:18 +01:00
2016-10-31 02:48:41 +01:00
foreach ( $value as $index => $v ) {
$is_valid = rest_validate_value_from_schema ( $v , $args [ 'items' ], $param . '[' . $index . ']' );
if ( is_wp_error ( $is_valid ) ) {
return $is_valid ;
}
}
2020-06-08 00:42:13 +02:00
if ( isset ( $args [ 'minItems' ] ) && count ( $value ) < $args [ 'minItems' ] ) {
/* translators: 1: Parameter, 2: number. */
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must contain at least %2$s items.' ), $param , number_format_i18n ( $args [ 'minItems' ] ) ) );
}
if ( isset ( $args [ 'maxItems' ] ) && count ( $value ) > $args [ 'maxItems' ] ) {
/* translators: 1: Parameter, 2: number. */
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must contain at most %2$s items.' ), $param , number_format_i18n ( $args [ 'maxItems' ] ) ) );
}
2016-10-31 02:48:41 +01:00
}
2017-10-04 10:27:47 +02:00
if ( 'object' === $args [ 'type' ] ) {
2020-02-25 16:34:07 +01:00
if ( '' === $value ) {
$value = array ();
}
2017-10-04 10:27:47 +02:00
if ( $value instanceof stdClass ) {
$value = ( array ) $value ;
}
2019-08-15 19:17:55 +02:00
if ( $value instanceof JsonSerializable ) {
$value = $value -> jsonSerialize ();
}
2017-10-04 10:27:47 +02:00
if ( ! is_array ( $value ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Type name. */
2017-10-04 10:27:47 +02:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , 'object' ) );
}
2020-05-16 20:44:09 +02:00
if ( isset ( $args [ 'required' ] ) && is_array ( $args [ 'required' ] ) ) { // schema version 4
foreach ( $args [ 'required' ] as $name ) {
if ( ! array_key_exists ( $name , $value ) ) {
/* translators: 1: Property of an object, 2: Parameter. */
return new WP_Error ( 'rest_property_required' , sprintf ( __ ( '%1$s is a required property of %2$s.' ), $name , $param ) );
}
}
} elseif ( isset ( $args [ 'properties' ] ) ) { // schema version 3
foreach ( $args [ 'properties' ] as $name => $property ) {
if ( isset ( $property [ 'required' ] ) && true === $property [ 'required' ] && ! array_key_exists ( $name , $value ) ) {
/* translators: 1: Property of an object, 2: Parameter. */
return new WP_Error ( 'rest_property_required' , sprintf ( __ ( '%1$s is a required property of %2$s.' ), $name , $param ) );
}
}
}
2017-10-04 10:27:47 +02:00
foreach ( $value as $property => $v ) {
2017-10-24 23:05:49 +02:00
if ( isset ( $args [ 'properties' ][ $property ] ) ) {
$is_valid = rest_validate_value_from_schema ( $v , $args [ 'properties' ][ $property ], $param . '[' . $property . ']' );
if ( is_wp_error ( $is_valid ) ) {
return $is_valid ;
}
2019-08-15 19:17:55 +02:00
} elseif ( isset ( $args [ 'additionalProperties' ] ) ) {
if ( false === $args [ 'additionalProperties' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: %s: Property of an object. */
2019-08-15 19:17:55 +02:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not a valid property of Object.' ), $property ) );
}
if ( is_array ( $args [ 'additionalProperties' ] ) ) {
$is_valid = rest_validate_value_from_schema ( $v , $args [ 'additionalProperties' ], $param . '[' . $property . ']' );
if ( is_wp_error ( $is_valid ) ) {
return $is_valid ;
}
}
2017-10-04 10:27:47 +02:00
}
}
}
2019-09-23 19:25:57 +02:00
if ( 'null' === $args [ 'type' ] ) {
if ( null !== $value ) {
/* translators: 1: Parameter, 2: Type name. */
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , 'null' ) );
}
return true ;
}
2016-10-31 02:48:41 +01:00
if ( ! empty ( $args [ 'enum' ] ) ) {
if ( ! in_array ( $value , $args [ 'enum' ], true ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: List of valid values. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not one of %2$s.' ), $param , implode ( ', ' , $args [ 'enum' ] ) ) );
2016-10-31 02:48:41 +01:00
}
}
2020-04-05 05:02:11 +02:00
if ( in_array ( $args [ 'type' ], array ( 'integer' , 'number' ), true ) && ! is_numeric ( $value ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Type name. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , $args [ 'type' ] ) );
2016-10-31 02:48:41 +01:00
}
if ( 'integer' === $args [ 'type' ] && round ( floatval ( $value ) ) !== floatval ( $value ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Type name. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , 'integer' ) );
2016-10-31 02:48:41 +01:00
}
if ( 'boolean' === $args [ 'type' ] && ! rest_is_boolean ( $value ) ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Type name. */
2019-09-13 05:06:55 +02:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , 'boolean' ) );
2016-10-31 02:48:41 +01:00
}
2020-04-27 04:29:07 +02:00
if ( 'string' === $args [ 'type' ] ) {
if ( ! is_string ( $value ) ) {
/* translators: 1: Parameter, 2: Type name. */
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s is not of type %2$s.' ), $param , 'string' ) );
}
if ( isset ( $args [ 'minLength' ] ) && mb_strlen ( $value ) < $args [ 'minLength' ] ) {
return new WP_Error (
'rest_invalid_param' ,
sprintf (
/* translators: 1: Parameter, 2: Number of characters. */
_n ( '%1$s must be at least %2$s character long.' , '%1$s must be at least %2$s characters long.' , $args [ 'minLength' ] ),
$param ,
number_format_i18n ( $args [ 'minLength' ] )
)
);
}
if ( isset ( $args [ 'maxLength' ] ) && mb_strlen ( $value ) > $args [ 'maxLength' ] ) {
return new WP_Error (
'rest_invalid_param' ,
sprintf (
/* translators: 1: Parameter, 2: Number of characters. */
_n ( '%1$s must be at most %2$s character long.' , '%1$s must be at most %2$s characters long.' , $args [ 'maxLength' ] ),
$param ,
number_format_i18n ( $args [ 'maxLength' ] )
)
);
}
2020-05-16 21:03:08 +02:00
if ( isset ( $args [ 'pattern' ] ) ) {
$pattern = str_replace ( '#' , '\\#' , $args [ 'pattern' ] );
if ( ! preg_match ( '#' . $pattern . '#u' , $value ) ) {
/* translators: 1: Parameter, 2: Pattern. */
return new WP_Error ( 'rest_invalid_pattern' , sprintf ( __ ( '%1$s does not match pattern %2$s.' ), $param , $args [ 'pattern' ] ) );
}
}
2016-10-31 02:48:41 +01:00
}
if ( isset ( $args [ 'format' ] ) ) {
switch ( $args [ 'format' ] ) {
2020-03-12 03:42:08 +01:00
case 'hex-color' :
if ( ! rest_parse_hex_color ( $value ) ) {
return new WP_Error ( 'rest_invalid_hex_color' , __ ( 'Invalid hex color.' ) );
}
break ;
2017-12-01 00:11:00 +01:00
case 'date-time' :
2016-10-31 02:48:41 +01:00
if ( ! rest_parse_date ( $value ) ) {
2016-11-17 16:53:33 +01:00
return new WP_Error ( 'rest_invalid_date' , __ ( 'Invalid date.' ) );
2016-10-31 02:48:41 +01:00
}
break ;
2017-12-01 00:11:00 +01:00
case 'email' :
2017-05-14 06:20:43 +02:00
if ( ! is_email ( $value ) ) {
2016-11-17 16:53:33 +01:00
return new WP_Error ( 'rest_invalid_email' , __ ( 'Invalid email address.' ) );
2016-10-31 02:48:41 +01:00
}
break ;
2017-12-01 00:11:00 +01:00
case 'ip' :
2016-10-31 02:48:41 +01:00
if ( ! rest_is_ip_address ( $value ) ) {
2019-09-03 02:41:05 +02:00
/* translators: %s: IP address. */
2019-09-13 05:06:55 +02:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%s is not a valid IP address.' ), $param ) );
2016-10-31 02:48:41 +01:00
}
break ;
2020-05-03 21:20:09 +02:00
case 'uuid' :
if ( ! wp_is_uuid ( $value ) ) {
/* translators: %s is the name of a JSON field expecting a valid uuid. */
return new WP_Error ( 'rest_invalid_uuid' , sprintf ( __ ( '%s is not a valid UUID.' ), $param ) );
}
break ;
2016-10-31 02:48:41 +01:00
}
}
if ( in_array ( $args [ 'type' ], array ( 'number' , 'integer' ), true ) && ( isset ( $args [ 'minimum' ] ) || isset ( $args [ 'maximum' ] ) ) ) {
if ( isset ( $args [ 'minimum' ] ) && ! isset ( $args [ 'maximum' ] ) ) {
if ( ! empty ( $args [ 'exclusiveMinimum' ] ) && $value <= $args [ 'minimum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Minimum number. */
2017-01-13 05:38:40 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be greater than %2$d' ), $param , $args [ 'minimum' ] ) );
2016-10-31 02:48:41 +01:00
} elseif ( empty ( $args [ 'exclusiveMinimum' ] ) && $value < $args [ 'minimum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Minimum number. */
2017-01-13 05:38:40 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be greater than or equal to %2$d' ), $param , $args [ 'minimum' ] ) );
2016-10-31 02:48:41 +01:00
}
} elseif ( isset ( $args [ 'maximum' ] ) && ! isset ( $args [ 'minimum' ] ) ) {
if ( ! empty ( $args [ 'exclusiveMaximum' ] ) && $value >= $args [ 'maximum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Maximum number. */
2017-01-13 05:38:40 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be less than %2$d' ), $param , $args [ 'maximum' ] ) );
2016-10-31 02:48:41 +01:00
} elseif ( empty ( $args [ 'exclusiveMaximum' ] ) && $value > $args [ 'maximum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Maximum number. */
2017-01-13 05:38:40 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be less than or equal to %2$d' ), $param , $args [ 'maximum' ] ) );
2016-10-31 02:48:41 +01:00
}
} elseif ( isset ( $args [ 'maximum' ] ) && isset ( $args [ 'minimum' ] ) ) {
if ( ! empty ( $args [ 'exclusiveMinimum' ] ) && ! empty ( $args [ 'exclusiveMaximum' ] ) ) {
if ( $value >= $args [ 'maximum' ] || $value <= $args [ 'minimum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Minimum number, 3: Maximum number. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be between %2$d (exclusive) and %3$d (exclusive)' ), $param , $args [ 'minimum' ], $args [ 'maximum' ] ) );
2016-10-31 02:48:41 +01:00
}
} elseif ( empty ( $args [ 'exclusiveMinimum' ] ) && ! empty ( $args [ 'exclusiveMaximum' ] ) ) {
if ( $value >= $args [ 'maximum' ] || $value < $args [ 'minimum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Minimum number, 3: Maximum number. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be between %2$d (inclusive) and %3$d (exclusive)' ), $param , $args [ 'minimum' ], $args [ 'maximum' ] ) );
2016-10-31 02:48:41 +01:00
}
} elseif ( ! empty ( $args [ 'exclusiveMinimum' ] ) && empty ( $args [ 'exclusiveMaximum' ] ) ) {
if ( $value > $args [ 'maximum' ] || $value <= $args [ 'minimum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Minimum number, 3: Maximum number. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be between %2$d (exclusive) and %3$d (inclusive)' ), $param , $args [ 'minimum' ], $args [ 'maximum' ] ) );
2016-10-31 02:48:41 +01:00
}
} elseif ( empty ( $args [ 'exclusiveMinimum' ] ) && empty ( $args [ 'exclusiveMaximum' ] ) ) {
if ( $value > $args [ 'maximum' ] || $value < $args [ 'minimum' ] ) {
2019-09-03 02:41:05 +02:00
/* translators: 1: Parameter, 2: Minimum number, 3: Maximum number. */
2016-11-15 06:39:32 +01:00
return new WP_Error ( 'rest_invalid_param' , sprintf ( __ ( '%1$s must be between %2$d (inclusive) and %3$d (inclusive)' ), $param , $args [ 'minimum' ], $args [ 'maximum' ] ) );
2016-10-31 02:48:41 +01:00
}
}
}
}
return true ;
}
/**
* Sanitize a value based on a schema .
*
2016-12-27 10:21:44 +01:00
* @ since 4.7 . 0
*
2016-10-31 02:48:41 +01:00
* @ param mixed $value The value to sanitize .
* @ param array $args Schema array to use for sanitization .
* @ return true | WP_Error
*/
function rest_sanitize_value_from_schema ( $value , $args ) {
2019-09-23 19:25:57 +02:00
if ( is_array ( $args [ 'type' ] ) ) {
2020-01-29 01:45:18 +01:00
// Determine which type the value was validated against,
// and use that type when performing sanitization.
2019-09-23 19:25:57 +02:00
$validated_type = '' ;
foreach ( $args [ 'type' ] as $type ) {
$type_args = $args ;
$type_args [ 'type' ] = $type ;
if ( ! is_wp_error ( rest_validate_value_from_schema ( $value , $type_args ) ) ) {
$validated_type = $type ;
break ;
}
}
if ( ! $validated_type ) {
return null ;
}
$args [ 'type' ] = $validated_type ;
}
2016-10-31 02:48:41 +01:00
if ( 'array' === $args [ 'type' ] ) {
if ( empty ( $args [ 'items' ] ) ) {
return ( array ) $value ;
}
2020-01-29 01:45:18 +01:00
2019-01-10 22:06:49 +01:00
$value = wp_parse_list ( $value );
2016-10-31 02:48:41 +01:00
foreach ( $value as $index => $v ) {
$value [ $index ] = rest_sanitize_value_from_schema ( $v , $args [ 'items' ] );
}
2020-01-29 01:45:18 +01:00
// Normalize to numeric array so nothing unexpected is in the keys.
2016-11-14 17:36:33 +01:00
$value = array_values ( $value );
2016-10-31 02:48:41 +01:00
return $value ;
}
2017-10-04 10:27:47 +02:00
if ( 'object' === $args [ 'type' ] ) {
if ( $value instanceof stdClass ) {
$value = ( array ) $value ;
}
2019-08-15 19:17:55 +02:00
if ( $value instanceof JsonSerializable ) {
$value = $value -> jsonSerialize ();
}
2017-10-04 10:27:47 +02:00
if ( ! is_array ( $value ) ) {
return array ();
}
foreach ( $value as $property => $v ) {
2017-10-24 23:05:49 +02:00
if ( isset ( $args [ 'properties' ][ $property ] ) ) {
$value [ $property ] = rest_sanitize_value_from_schema ( $v , $args [ 'properties' ][ $property ] );
2019-08-15 19:17:55 +02:00
} elseif ( isset ( $args [ 'additionalProperties' ] ) ) {
if ( false === $args [ 'additionalProperties' ] ) {
unset ( $value [ $property ] );
} elseif ( is_array ( $args [ 'additionalProperties' ] ) ) {
$value [ $property ] = rest_sanitize_value_from_schema ( $v , $args [ 'additionalProperties' ] );
}
2017-10-04 10:27:47 +02:00
}
}
return $value ;
}
2019-09-23 19:25:57 +02:00
if ( 'null' === $args [ 'type' ] ) {
return null ;
}
2016-10-31 02:48:41 +01:00
if ( 'integer' === $args [ 'type' ] ) {
return ( int ) $value ;
}
if ( 'number' === $args [ 'type' ] ) {
return ( float ) $value ;
}
if ( 'boolean' === $args [ 'type' ] ) {
return rest_sanitize_boolean ( $value );
}
if ( isset ( $args [ 'format' ] ) ) {
switch ( $args [ 'format' ] ) {
2020-03-12 03:42:08 +01:00
case 'hex-color' :
return ( string ) sanitize_hex_color ( $value );
2017-12-01 00:11:00 +01:00
case 'date-time' :
2016-10-31 02:48:41 +01:00
return sanitize_text_field ( $value );
2017-12-01 00:11:00 +01:00
case 'email' :
2020-01-29 01:45:18 +01:00
// sanitize_email() validates, which would be unexpected.
2016-10-31 02:48:41 +01:00
return sanitize_text_field ( $value );
2017-12-01 00:11:00 +01:00
case 'uri' :
2016-10-31 02:48:41 +01:00
return esc_url_raw ( $value );
2017-12-01 00:11:00 +01:00
case 'ip' :
2016-10-31 02:48:41 +01:00
return sanitize_text_field ( $value );
2020-05-03 21:20:09 +02:00
case 'uuid' :
return sanitize_text_field ( $value );
2016-10-31 02:48:41 +01:00
}
}
2016-11-14 17:36:33 +01:00
if ( 'string' === $args [ 'type' ] ) {
return strval ( $value );
}
2016-10-31 02:48:41 +01:00
return $value ;
}
2018-12-13 23:25:49 +01:00
/**
* Append result of internal request to REST API for purpose of preloading data to be attached to a page .
* Expected to be called in the context of `array_reduce` .
*
* @ since 5.0 . 0
*
2020-06-20 14:58:10 +02:00
* @ param array $memo Reduce accumulator .
* @ param string $path REST API path to preload .
* @ return array Modified reduce accumulator .
2018-12-13 23:25:49 +01:00
*/
function rest_preload_api_request ( $memo , $path ) {
2020-01-29 01:45:18 +01:00
// array_reduce() doesn't support passing an array in PHP 5.2,
// so we need to make sure we start with one.
2018-12-13 23:25:49 +01:00
if ( ! is_array ( $memo ) ) {
$memo = array ();
}
if ( empty ( $path ) ) {
return $memo ;
}
2018-12-14 07:02:52 +01:00
$method = 'GET' ;
if ( is_array ( $path ) && 2 === count ( $path ) ) {
$method = end ( $path );
$path = reset ( $path );
if ( ! in_array ( $method , array ( 'GET' , 'OPTIONS' ), true ) ) {
$method = 'GET' ;
}
}
2018-12-13 23:25:49 +01:00
$path_parts = parse_url ( $path );
if ( false === $path_parts ) {
return $memo ;
}
2018-12-14 07:02:52 +01:00
$request = new WP_REST_Request ( $method , $path_parts [ 'path' ] );
2018-12-13 23:25:49 +01:00
if ( ! empty ( $path_parts [ 'query' ] ) ) {
parse_str ( $path_parts [ 'query' ], $query_params );
$request -> set_query_params ( $query_params );
}
$response = rest_do_request ( $request );
if ( 200 === $response -> status ) {
$server = rest_get_server ();
$data = ( array ) $response -> get_data ();
2019-06-26 20:07:54 +02:00
$links = $server :: get_compact_response_links ( $response );
2018-12-13 23:25:49 +01:00
if ( ! empty ( $links ) ) {
$data [ '_links' ] = $links ;
}
2018-12-14 07:02:52 +01:00
if ( 'OPTIONS' === $method ) {
$response = rest_send_allow_header ( $response , $server , $request );
$memo [ $method ][ $path ] = array (
'body' => $data ,
'headers' => $response -> headers ,
);
} else {
$memo [ $path ] = array (
'body' => $data ,
'headers' => $response -> headers ,
);
}
2018-12-13 23:25:49 +01:00
}
return $memo ;
}
2020-02-09 21:54:05 +01:00
/**
* Parses the " _embed " parameter into the list of resources to embed .
*
* @ since 5.4 . 0
*
* @ param string | array $embed Raw " _embed " parameter value .
* @ return true | string [] Either true to embed all embeds , or a list of relations to embed .
*/
function rest_parse_embed_param ( $embed ) {
if ( ! $embed || 'true' === $embed || '1' === $embed ) {
return true ;
}
$rels = wp_parse_list ( $embed );
if ( ! $rels ) {
return true ;
}
return $rels ;
}
2020-05-04 04:46:05 +02:00
/**
* Filters the response to remove any fields not available in the given context .
*
* @ since 5.5 . 0
*
* @ param array | object $data The response data to modify .
* @ param array $schema The schema for the endpoint used to filter the response .
* @ param string $context The requested context .
* @ return array | object The filtered response data .
*/
function rest_filter_response_by_context ( $data , $schema , $context ) {
if ( ! is_array ( $data ) && ! is_object ( $data ) ) {
return $data ;
}
if ( isset ( $schema [ 'type' ] ) ) {
$type = $schema [ 'type' ];
} elseif ( isset ( $schema [ 'properties' ] ) ) {
$type = 'object' ; // Back compat if a developer accidentally omitted the type.
} else {
return $data ;
}
foreach ( $data as $key => $value ) {
$check = array ();
if ( 'array' === $type || ( is_array ( $type ) && in_array ( 'array' , $type , true ) ) ) {
$check = isset ( $schema [ 'items' ] ) ? $schema [ 'items' ] : array ();
} elseif ( 'object' === $type || ( is_array ( $type ) && in_array ( 'object' , $type , true ) ) ) {
if ( isset ( $schema [ 'properties' ][ $key ] ) ) {
$check = $schema [ 'properties' ][ $key ];
} elseif ( isset ( $schema [ 'additionalProperties' ] ) && is_array ( $schema [ 'additionalProperties' ] ) ) {
$check = $schema [ 'additionalProperties' ];
}
}
if ( ! isset ( $check [ 'context' ] ) ) {
continue ;
}
if ( ! in_array ( $context , $check [ 'context' ], true ) ) {
if ( is_object ( $data ) ) {
unset ( $data -> $key );
} else {
unset ( $data [ $key ] );
}
} elseif ( is_array ( $value ) || is_object ( $value ) ) {
$new_value = rest_filter_response_by_context ( $value , $check , $context );
if ( is_object ( $data ) ) {
$data -> $key = $new_value ;
} else {
$data [ $key ] = $new_value ;
}
}
}
return $data ;
}