| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924 |
- <?php
- /**
- * Register WP REST API endpoints for Jetpack.
- *
- * @author Automattic
- */
- /**
- * Disable direct access.
- */
- if ( ! defined( 'ABSPATH' ) ) {
- exit;
- }
- // Load WP_Error for error messages.
- require_once ABSPATH . '/wp-includes/class-wp-error.php';
- // Register endpoints when WP REST API is initialized.
- add_action( 'rest_api_init', array( 'Jetpack_Core_Json_Api_Endpoints', 'register_endpoints' ) );
- /**
- * Class Jetpack_Core_Json_Api_Endpoints
- *
- * @since 4.3.0
- */
- class Jetpack_Core_Json_Api_Endpoints {
- /**
- * @var string Generic error message when user is not allowed to perform an action.
- */
- public static $user_permissions_error_msg;
- /**
- * @var array Roles that can access Stats once they're granted access.
- */
- public static $stats_roles;
- /**
- * Declare the Jetpack REST API endpoints.
- *
- * @since 4.3.0
- */
- public static function register_endpoints() {
- // Load API endpoint base classes
- require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
- // Load API endpoints
- require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
- require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-site-endpoints.php';
- require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-widgets-endpoints.php';
- self::$user_permissions_error_msg = esc_html__(
- 'You do not have the correct user permissions to perform this action.
- Please contact your site admin if you think this is a mistake.',
- 'jetpack'
- );
- self::$stats_roles = array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' );
- Jetpack::load_xml_rpc_client();
- $ixr_client = new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) );
- $core_api_endpoint = new Jetpack_Core_API_Data( $ixr_client );
- $module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
- $module_data_endpoint = new Jetpack_Core_API_Module_Data_Endpoint();
- $module_toggle_endpoint = new Jetpack_Core_API_Module_Toggle_Endpoint( new Jetpack_IXR_Client() );
- $site_endpoint = new Jetpack_Core_API_Site_Endpoint();
- $widget_endpoint = new Jetpack_Core_API_Widget_Endpoint();
- register_rest_route( 'jetpack/v4', 'plans', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_plans',
- 'permission_callback' => __CLASS__ . '::connect_url_permission_callback',
- ) );
- register_rest_route( 'jetpack/v4', '/jitm', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_jitm_message',
- ) );
- register_rest_route( 'jetpack/v4', '/jitm', array(
- 'methods' => WP_REST_Server::CREATABLE,
- 'callback' => __CLASS__ . '::delete_jitm_message'
- ) );
- // Register a site
- register_rest_route( 'jetpack/v4', '/verify_registration', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::verify_registration',
- ) );
- // Authorize a remote user
- register_rest_route( 'jetpack/v4', '/remote_authorize', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::remote_authorize',
- ) );
- // Get current connection status of Jetpack
- register_rest_route( 'jetpack/v4', '/connection', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::jetpack_connection_status',
- ) );
- register_rest_route( 'jetpack/v4', '/rewind', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_rewind_data',
- 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
- ) );
- // Fetches a fresh connect URL
- register_rest_route( 'jetpack/v4', '/connection/url', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::build_connect_url',
- 'permission_callback' => __CLASS__ . '::connect_url_permission_callback',
- ) );
- // Get current user connection data
- register_rest_route( 'jetpack/v4', '/connection/data', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_user_connection_data',
- 'permission_callback' => __CLASS__ . '::get_user_connection_data_permission_callback',
- ) );
- // Set the connection owner
- register_rest_route( 'jetpack/v4', '/connection/owner', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::set_connection_owner',
- 'permission_callback' => __CLASS__ . '::set_connection_owner_permission_callback',
- ) );
- // Current user: get or set tracking settings.
- register_rest_route( 'jetpack/v4', '/tracking/settings', array(
- array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_user_tracking_settings',
- 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
- ),
- array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::update_user_tracking_settings',
- 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
- 'args' => array(
- 'tracks_opt_out' => array( 'type' => 'boolean' ),
- ),
- ),
- ) );
- // Disconnect site from WordPress.com servers
- register_rest_route( 'jetpack/v4', '/connection', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::disconnect_site',
- 'permission_callback' => __CLASS__ . '::disconnect_site_permission_callback',
- ) );
- // Disconnect/unlink user from WordPress.com servers
- register_rest_route( 'jetpack/v4', '/connection/user', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::unlink_user',
- 'permission_callback' => __CLASS__ . '::unlink_user_permission_callback',
- ) );
- // Get current site data
- register_rest_route( 'jetpack/v4', '/site', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_site_data',
- 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
- ) );
- // Get current site data
- register_rest_route( 'jetpack/v4', '/site/features', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $site_endpoint, 'get_features' ),
- 'permission_callback' => array( $site_endpoint , 'can_request' ),
- ) );
- // Confirm that a site in identity crisis should be in staging mode
- register_rest_route( 'jetpack/v4', '/identity-crisis/confirm-safe-mode', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::confirm_safe_mode',
- 'permission_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
- ) );
- // IDC resolve: create an entirely new shadow site for this URL.
- register_rest_route( 'jetpack/v4', '/identity-crisis/start-fresh', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::start_fresh_connection',
- 'permission_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
- ) );
- // Handles the request to migrate stats and subscribers during an identity crisis.
- register_rest_route( 'jetpack/v4', 'identity-crisis/migrate', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::migrate_stats_and_subscribers',
- 'permissison_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
- ) );
- // Return all modules
- register_rest_route( 'jetpack/v4', '/module/all', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $module_list_endpoint, 'process' ),
- 'permission_callback' => array( $module_list_endpoint, 'can_request' ),
- ) );
- // Activate many modules
- register_rest_route( 'jetpack/v4', '/module/all/active', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $module_list_endpoint, 'process' ),
- 'permission_callback' => array( $module_list_endpoint, 'can_request' ),
- 'args' => array(
- 'modules' => array(
- 'default' => '',
- 'type' => 'array',
- 'items' => array(
- 'type' => 'string',
- ),
- 'required' => true,
- 'validate_callback' => __CLASS__ . '::validate_module_list',
- ),
- 'active' => array(
- 'default' => true,
- 'type' => 'boolean',
- 'required' => false,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- ),
- )
- ) );
- // Return a single module and update it when needed
- register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $core_api_endpoint, 'process' ),
- 'permission_callback' => array( $core_api_endpoint, 'can_request' ),
- ) );
- // Activate and deactivate a module
- register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)/active', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $module_toggle_endpoint, 'process' ),
- 'permission_callback' => array( $module_toggle_endpoint, 'can_request' ),
- 'args' => array(
- 'active' => array(
- 'default' => true,
- 'type' => 'boolean',
- 'required' => true,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- ),
- )
- ) );
- // Update a module
- register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $core_api_endpoint, 'process' ),
- 'permission_callback' => array( $core_api_endpoint, 'can_request' ),
- 'args' => self::get_updateable_parameters( 'any' )
- ) );
- // Get data for a specific module, i.e. Protect block count, WPCOM stats,
- // Akismet spam count, etc.
- register_rest_route( 'jetpack/v4', '/module/(?P<slug>[a-z\-]+)/data', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $module_data_endpoint, 'process' ),
- 'permission_callback' => array( $module_data_endpoint, 'can_request' ),
- 'args' => array(
- 'range' => array(
- 'default' => 'day',
- 'type' => 'string',
- 'required' => false,
- 'validate_callback' => __CLASS__ . '::validate_string',
- ),
- )
- ) );
- // Check if the API key for a specific service is valid or not
- register_rest_route( 'jetpack/v4', '/module/(?P<service>[a-z\-]+)/key/check', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $module_data_endpoint, 'key_check' ),
- 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
- 'sanitize_callback' => 'sanitize_text_field',
- ) );
- register_rest_route( 'jetpack/v4', '/module/(?P<service>[a-z\-]+)/key/check', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $module_data_endpoint, 'key_check' ),
- 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
- 'sanitize_callback' => 'sanitize_text_field',
- 'args' => array(
- 'api_key' => array(
- 'default' => '',
- 'type' => 'string',
- 'validate_callback' => __CLASS__ . '::validate_alphanum',
- ),
- )
- ) );
- // Update any Jetpack module option or setting
- register_rest_route( 'jetpack/v4', '/settings', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $core_api_endpoint, 'process' ),
- 'permission_callback' => array( $core_api_endpoint, 'can_request' ),
- 'args' => self::get_updateable_parameters( 'any' )
- ) );
- // Update a module
- register_rest_route( 'jetpack/v4', '/settings/(?P<slug>[a-z\-]+)', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $core_api_endpoint, 'process' ),
- 'permission_callback' => array( $core_api_endpoint, 'can_request' ),
- 'args' => self::get_updateable_parameters()
- ) );
- // Return all module settings
- register_rest_route( 'jetpack/v4', '/settings/', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $core_api_endpoint, 'process' ),
- 'permission_callback' => array( $core_api_endpoint, 'can_request' ),
- ) );
- // Reset all Jetpack options
- register_rest_route( 'jetpack/v4', '/options/(?P<options>[a-z\-]+)', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::reset_jetpack_options',
- 'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
- ) );
- // Return current Jumpstart status
- register_rest_route( 'jetpack/v4', '/jumpstart', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::jumpstart_status',
- 'permission_callback' => __CLASS__ . '::update_settings_permission_check',
- ) );
- // Update Jumpstart
- register_rest_route( 'jetpack/v4', '/jumpstart', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::jumpstart_toggle',
- 'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
- 'args' => array(
- 'active' => array(
- 'required' => true,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- ),
- ),
- ) );
- // Updates: get number of plugin updates available
- register_rest_route( 'jetpack/v4', '/updates/plugins', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_plugin_update_count',
- 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
- ) );
- // Dismiss Jetpack Notices
- register_rest_route( 'jetpack/v4', '/notice/(?P<notice>[a-z\-_]+)', array(
- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => __CLASS__ . '::dismiss_notice',
- 'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
- ) );
- // Plugins: get list of all plugins.
- register_rest_route( 'jetpack/v4', '/plugins', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_plugins',
- 'permission_callback' => __CLASS__ . '::activate_plugins_permission_check',
- ) );
- // Plugins: check if the plugin is active.
- register_rest_route( 'jetpack/v4', '/plugin/(?P<plugin>[a-z\/\.\-_]+)', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => __CLASS__ . '::get_plugin',
- 'permission_callback' => __CLASS__ . '::activate_plugins_permission_check',
- ) );
- // Widgets: get information about a widget that supports it.
- register_rest_route( 'jetpack/v4', '/widgets/(?P<id>[0-9a-z\-_]+)', array(
- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $widget_endpoint, 'process' ),
- 'permission_callback' => array( $widget_endpoint, 'can_request' ),
- ) );
- }
- public static function get_plans( $request ) {
- $request = Jetpack_Client::wpcom_json_api_request_as_user(
- '/plans?_locale=' . get_user_locale(),
- '2',
- array(
- 'method' => 'GET',
- 'headers' => array(
- 'X-Forwarded-For' => Jetpack::current_user_ip( true ),
- ),
- )
- );
- $body = wp_remote_retrieve_body( $request );
- if ( 200 === wp_remote_retrieve_response_code( $request ) ) {
- $data = $body;
- } else {
- // something went wrong so we'll just return the response without caching
- return $body;
- }
- return $data;
- }
- /**
- * Asks for a jitm, unless they've been disabled, in which case it returns an empty array
- *
- * @param $request WP_REST_Request
- *
- * @return array An array of jitms
- */
- public static function get_jitm_message( $request ) {
- require_once( JETPACK__PLUGIN_DIR . 'class.jetpack-jitm.php' );
- $jitm = Jetpack_JITM::init();
- if ( ! $jitm ) {
- return array();
- }
- return $jitm->get_messages( $request['message_path'], urldecode_deep( $request['query'] ) );
- }
- /**
- * Dismisses a jitm
- * @param $request WP_REST_Request The request
- *
- * @return bool Always True
- */
- public static function delete_jitm_message( $request ) {
- require_once( JETPACK__PLUGIN_DIR . 'class.jetpack-jitm.php' );
- $jitm = Jetpack_JITM::init();
- if ( ! $jitm ) {
- return true;
- }
- return $jitm->dismiss( $request['id'], $request['feature_class'] );
- }
- /**
- * Handles verification that a site is registered
- *
- * @since 5.4.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return array|wp-error
- */
- public static function verify_registration( $request ) {
- require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
- $xmlrpc_server = new Jetpack_XMLRPC_Server();
- $result = $xmlrpc_server->verify_registration( array( $request['secret_1'], $request['state'] ) );
- if ( is_a( $result, 'IXR_Error' ) ) {
- $result = new WP_Error( $result->code, $result->message );
- }
- return $result;
- }
- /**
- * Handles verification that a site is registered
- *
- * @since 5.4.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return array|wp-error
- */
- public static function remote_authorize( $request ) {
- require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
- $xmlrpc_server = new Jetpack_XMLRPC_Server();
- $result = $xmlrpc_server->remote_authorize( $request );
- if ( is_a( $result, 'IXR_Error' ) ) {
- $result = new WP_Error( $result->code, $result->message );
- }
- return $result;
- }
- /**
- * Handles dismissing of Jetpack Notices
- *
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return array|wp-error
- */
- public static function dismiss_notice( $request ) {
- $notice = $request['notice'];
- if ( ! isset( $request['dismissed'] ) || $request['dismissed'] !== true ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Invalid parameter "dismissed".', 'jetpack' ), array( 'status' => 404 ) );
- }
- if ( isset( $notice ) && ! empty( $notice ) ) {
- switch( $notice ) {
- case 'feedback_dash_request':
- case 'welcome':
- $notices = get_option( 'jetpack_dismissed_notices', array() );
- $notices[ $notice ] = true;
- update_option( 'jetpack_dismissed_notices', $notices );
- return rest_ensure_response( get_option( 'jetpack_dismissed_notices', array() ) );
- default:
- return new WP_Error( 'invalid_param', esc_html__( 'Invalid parameter "notice".', 'jetpack' ), array( 'status' => 404 ) );
- }
- }
- return new WP_Error( 'required_param', esc_html__( 'Missing parameter "notice".', 'jetpack' ), array( 'status' => 404 ) );
- }
- /**
- * Verify that the user can disconnect the site.
- *
- * @since 4.3.0
- *
- * @return bool|WP_Error True if user is able to disconnect the site.
- */
- public static function disconnect_site_permission_callback() {
- if ( current_user_can( 'jetpack_disconnect' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_jetpack_disconnect', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that the user can get a connect/link URL
- *
- * @since 4.3.0
- *
- * @return bool|WP_Error True if user is able to disconnect the site.
- */
- public static function connect_url_permission_callback() {
- if ( current_user_can( 'jetpack_connect_user' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_jetpack_disconnect', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that a user can get the data about the current user.
- * Only those who can connect.
- *
- * @since 4.3.0
- *
- * @uses Jetpack::is_user_connected();
- *
- * @return bool|WP_Error True if user is able to unlink.
- */
- public static function get_user_connection_data_permission_callback() {
- if ( current_user_can( 'jetpack_connect_user' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_user_connection_data', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Check that user has permission to change the master user.
- *
- * @since 6.2.0
- *
- * @return bool|WP_Error True if user is able to change master user.
- */
- public static function set_connection_owner_permission_callback() {
- if ( get_current_user_id() === Jetpack_Options::get_option( 'master_user' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_set_connection_owner', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that a user can use the /connection/user endpoint. Has to be a registered user and be currently linked.
- *
- * @since 4.3.0
- *
- * @uses Jetpack::is_user_connected();
- *
- * @return bool|WP_Error True if user is able to unlink.
- */
- public static function unlink_user_permission_callback() {
- if ( current_user_can( 'jetpack_connect_user' ) && Jetpack::is_user_connected( get_current_user_id() ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_unlink_user', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that user can manage Jetpack modules.
- *
- * @since 4.3.0
- *
- * @return bool Whether user has the capability 'jetpack_manage_modules'.
- */
- public static function manage_modules_permission_check() {
- if ( current_user_can( 'jetpack_manage_modules' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_manage_modules', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that user can update Jetpack modules.
- *
- * @since 4.3.0
- *
- * @return bool Whether user has the capability 'jetpack_configure_modules'.
- */
- public static function configure_modules_permission_check() {
- if ( current_user_can( 'jetpack_configure_modules' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_configure_modules', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that user can view Jetpack admin page.
- *
- * @since 4.3.0
- *
- * @return bool Whether user has the capability 'jetpack_admin_page'.
- */
- public static function view_admin_page_permission_check() {
- if ( current_user_can( 'jetpack_admin_page' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_view_admin', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that user can mitigate an identity crisis.
- *
- * @since 4.4.0
- *
- * @return bool Whether user has capability 'jetpack_disconnect'.
- */
- public static function identity_crisis_mitigation_permission_check() {
- if ( current_user_can( 'jetpack_disconnect' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_identity_crisis', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that user can update Jetpack general settings.
- *
- * @since 4.3.0
- *
- * @return bool Whether user has the capability 'update_settings_permission_check'.
- */
- public static function update_settings_permission_check() {
- if ( current_user_can( 'jetpack_configure_modules' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_manage_settings', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Verify that user can view Jetpack admin page and can activate plugins.
- *
- * @since 4.3.0
- *
- * @return bool Whether user has the capability 'jetpack_admin_page' and 'activate_plugins'.
- */
- public static function activate_plugins_permission_check() {
- if ( current_user_can( 'jetpack_admin_page' ) && current_user_can( 'activate_plugins' ) ) {
- return true;
- }
- return new WP_Error( 'invalid_user_permission_activate_plugins', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
- }
- /**
- * Contextual HTTP error code for authorization failure.
- *
- * Taken from rest_authorization_required_code() in WP-API plugin until is added to core.
- * @see https://github.com/WP-API/WP-API/commit/7ba0ae6fe4f605d5ffe4ee85b1cd5f9fb46900a6
- *
- * @since 4.3.0
- *
- * @return int
- */
- public static function rest_authorization_required_code() {
- return is_user_logged_in() ? 403 : 401;
- }
- /**
- * Get connection status for this Jetpack site.
- *
- * @since 4.3.0
- *
- * @return bool True if site is connected
- */
- public static function jetpack_connection_status() {
- return rest_ensure_response( array(
- 'isActive' => Jetpack::is_active(),
- 'isStaging' => Jetpack::is_staging_site(),
- 'devMode' => array(
- 'isActive' => Jetpack::is_development_mode(),
- 'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
- 'url' => site_url() && false === strpos( site_url(), '.' ),
- 'filter' => apply_filters( 'jetpack_development_mode', false ),
- ),
- )
- );
- }
- public static function rewind_data() {
- $site_id = Jetpack_Options::get_option( 'id' );
- if ( ! $site_id ) {
- return new WP_Error( 'site_id_missing' );
- }
- $response = Jetpack_Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d/rewind', $site_id ) .'?force=wpcom', '2', array(), null, 'wpcom' );
- if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
- return new WP_Error( 'rewind_data_fetch_failed' );
- }
- $body = wp_remote_retrieve_body( $response );
- return json_decode( $body );
- }
- /**
- * Get rewind data
- *
- * @since 5.7.0
- *
- * @return array Array of rewind properties.
- */
- public static function get_rewind_data() {
- $rewind_data = self::rewind_data();
- if ( ! is_wp_error( $rewind_data ) ) {
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Rewind data correctly received.', 'jetpack' ),
- 'data' => wp_json_encode( $rewind_data ),
- )
- );
- }
- if ( $rewind_data->get_error_code() === 'rewind_data_fetch_failed' ) {
- return new WP_Error( 'rewind_data_fetch_failed', esc_html__( 'Failed fetching rewind data. Try again later.', 'jetpack' ), array( 'status' => 400 ) );
- }
- if ( $rewind_data->get_error_code() === 'site_id_missing' ) {
- return new WP_Error( 'site_id_missing', esc_html__( 'The ID of this site does not exist.', 'jetpack' ), array( 'status' => 404 ) );
- }
- return new WP_Error(
- 'error_get_rewind_data',
- esc_html__( 'Could not retrieve Rewind data.', 'jetpack' ),
- array( 'status' => 500 )
- );
- }
- /**
- * Disconnects Jetpack from the WordPress.com Servers
- *
- * @uses Jetpack::disconnect();
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return bool|WP_Error True if Jetpack successfully disconnected.
- */
- public static function disconnect_site( $request ) {
- if ( ! isset( $request['isActive'] ) || $request['isActive'] !== false ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
- }
- if ( Jetpack::is_active() ) {
- Jetpack::disconnect();
- return rest_ensure_response( array( 'code' => 'success' ) );
- }
- return new WP_Error( 'disconnect_failed', esc_html__( 'Was not able to disconnect the site. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
- }
- /**
- * Gets a new connect raw URL with fresh nonce.
- *
- * @uses Jetpack::disconnect();
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
- */
- public static function build_connect_url() {
- $url = Jetpack::init()->build_connect_url( true, false, false );
- if ( $url ) {
- return rest_ensure_response( $url );
- }
- return new WP_Error( 'build_connect_url_failed', esc_html__( 'Unable to build the connect URL. Please reload the page and try again.', 'jetpack' ), array( 'status' => 400 ) );
- }
- /**
- * Get miscellaneous user data related to the connection. Similar data available in old "My Jetpack".
- * Information about the master/primary user.
- * Information about the current user.
- *
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return object
- */
- public static function get_user_connection_data() {
- require_once( JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class.jetpack-react-page.php' );
- $response = array(
- // 'othersLinked' => Jetpack::get_other_linked_admins(),
- 'currentUser' => jetpack_current_user_data(),
- );
- return rest_ensure_response( $response );
- }
- /**
- * Change the master user.
- *
- * @since 6.2.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return bool|WP_Error True if owner successfully changed.
- */
- public static function set_connection_owner( $request ) {
- if ( ! isset( $request['owner'] ) ) {
- return new WP_Error(
- 'invalid_param',
- esc_html__( 'Invalid Parameter', 'jetpack' ),
- array( 'status' => 400 )
- );
- }
- $new_owner_id = $request['owner'];
- if ( ! user_can( $new_owner_id, 'administrator' ) ) {
- return new WP_Error(
- 'new_owner_not_admin',
- esc_html__( 'New owner is not admin', 'jetpack' ),
- array( 'status' => 400 )
- );
- }
- if ( $new_owner_id === get_current_user_id() ) {
- return new WP_Error(
- 'new_owner_is_current_user',
- esc_html__( 'New owner is same as current user', 'jetpack' ),
- array( 'status' => 400 )
- );
- }
- if ( ! Jetpack::is_user_connected( $new_owner_id ) ) {
- return new WP_Error(
- 'new_owner_not_connected',
- esc_html__( 'New owner is not connected', 'jetpack' ),
- array( 'status' => 400 )
- );
- }
- // Update the master user in Jetpack
- $updated = Jetpack_Options::update_option( 'master_user', $new_owner_id );
- // Notify WPCOM about the master user change
- Jetpack::load_xml_rpc_client();
- $xml = new Jetpack_IXR_Client( array(
- 'user_id' => get_current_user_id(),
- ) );
- $xml->query( 'jetpack.switchBlogOwner', array(
- 'new_blog_owner' => $new_owner_id,
- ) );
- if ( $updated && ! $xml->isError() ) {
- return rest_ensure_response(
- array(
- 'code' => 'success',
- )
- );
- }
- return new WP_Error(
- 'error_setting_new_owner',
- esc_html__( 'Could not confirm new owner.', 'jetpack' ),
- array( 'status' => 500 )
- );
- }
- /**
- * Unlinks current user from the WordPress.com Servers.
- *
- * @since 4.3.0
- * @uses Jetpack::unlink_user
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return bool|WP_Error True if user successfully unlinked.
- */
- public static function unlink_user( $request ) {
- if ( ! isset( $request['linked'] ) || $request['linked'] !== false ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
- }
- if ( Jetpack::unlink_user() ) {
- return rest_ensure_response(
- array(
- 'code' => 'success'
- )
- );
- }
- return new WP_Error( 'unlink_user_failed', esc_html__( 'Was not able to unlink the user. Please try again.', 'jetpack' ), array( 'status' => 400 ) );
- }
- /**
- * Gets current user's tracking settings.
- *
- * @since 6.0.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return WP_REST_Response|WP_Error Response, else error.
- */
- public static function get_user_tracking_settings( $request ) {
- if ( ! Jetpack::is_user_connected() ) {
- $response = array(
- 'tracks_opt_out' => true, // Default to opt-out if not connected to wp.com.
- );
- } else {
- $response = Jetpack_Client::wpcom_json_api_request_as_user(
- '/jetpack-user-tracking',
- 'v2',
- array(
- 'method' => 'GET',
- 'headers' => array(
- 'X-Forwarded-For' => Jetpack::current_user_ip( true ),
- ),
- )
- );
- if ( ! is_wp_error( $response ) ) {
- $response = json_decode( wp_remote_retrieve_body( $response ), true );
- }
- }
- return rest_ensure_response( $response );
- }
- /**
- * Updates current user's tracking settings.
- *
- * @since 6.0.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return WP_REST_Response|WP_Error Response, else error.
- */
- public static function update_user_tracking_settings( $request ) {
- if ( ! Jetpack::is_user_connected() ) {
- $response = array(
- 'tracks_opt_out' => true, // Default to opt-out if not connected to wp.com.
- );
- } else {
- $response = Jetpack_Client::wpcom_json_api_request_as_user(
- '/jetpack-user-tracking',
- 'v2',
- array(
- 'method' => 'PUT',
- 'headers' => array(
- 'Content-Type' => 'application/json',
- 'X-Forwarded-For' => Jetpack::current_user_ip( true ),
- ),
- ),
- wp_json_encode( $request->get_params() )
- );
- if ( ! is_wp_error( $response ) ) {
- $response = json_decode( wp_remote_retrieve_body( $response ), true );
- }
- }
- return rest_ensure_response( $response );
- }
- /**
- * Fetch site data from .com including the site's current plan.
- *
- * @since 5.5.0
- *
- * @return array Array of site properties.
- */
- public static function site_data() {
- $site_id = Jetpack_Options::get_option( 'id' );
- if ( ! $site_id ) {
- new WP_Error( 'site_id_missing' );
- }
- $response = Jetpack_Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ) .'?force=wpcom', '1.1' );
- if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
- return new WP_Error( 'site_data_fetch_failed' );
- }
- // Save plan details in the database for future use without API calls
- $results = json_decode( $response['body'], true );
- if ( is_array( $results ) && isset( $results['plan'] ) ) {
- // Set flag for newly purchased plan
- $current_plan = Jetpack::get_active_plan();
- if ( $current_plan['product_slug'] !== $results['plan']['product_slug'] && 'jetpack_free' !== $results['plan']['product_slug'] ) {
- update_option( 'show_welcome_for_new_plan', true ) ;
- }
- update_option( 'jetpack_active_plan', $results['plan'] );
- }
- $body = wp_remote_retrieve_body( $response );
- return json_decode( $body );
- }
- /**
- * Get site data, including for example, the site's current plan.
- *
- * @since 4.3.0
- *
- * @return array Array of site properties.
- */
- public static function get_site_data() {
- $site_data = self::site_data();
- if ( ! is_wp_error( $site_data ) ) {
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Site data correctly received.', 'jetpack' ),
- 'data' => json_encode( $site_data ),
- )
- );
- }
- if ( $site_data->get_error_code() === 'site_data_fetch_failed' ) {
- return new WP_Error( 'site_data_fetch_failed', esc_html__( 'Failed fetching site data. Try again later.', 'jetpack' ), array( 'status' => 400 ) );
- }
- if ( $site_data->get_error_code() === 'site_id_missing' ) {
- return new WP_Error( 'site_id_missing', esc_html__( 'The ID of this site does not exist.', 'jetpack' ), array( 'status' => 404 ) );
- }
- }
- /**
- * Handles identity crisis mitigation, confirming safe mode for this site.
- *
- * @since 4.4.0
- *
- * @return bool | WP_Error True if option is properly set.
- */
- public static function confirm_safe_mode() {
- $updated = Jetpack_Options::update_option( 'safe_mode_confirmed', true );
- if ( $updated ) {
- return rest_ensure_response(
- array(
- 'code' => 'success'
- )
- );
- }
- return new WP_Error(
- 'error_setting_jetpack_safe_mode',
- esc_html__( 'Could not confirm safe mode.', 'jetpack' ),
- array( 'status' => 500 )
- );
- }
- /**
- * Handles identity crisis mitigation, migrating stats and subscribers from old url to this, new url.
- *
- * @since 4.4.0
- *
- * @return bool | WP_Error True if option is properly set.
- */
- public static function migrate_stats_and_subscribers() {
- if ( Jetpack_Options::get_option( 'sync_error_idc' ) && ! Jetpack_Options::delete_option( 'sync_error_idc' ) ) {
- return new WP_Error(
- 'error_deleting_sync_error_idc',
- esc_html__( 'Could not delete sync error option.', 'jetpack' ),
- array( 'status' => 500 )
- );
- }
- if ( Jetpack_Options::get_option( 'migrate_for_idc' ) || Jetpack_Options::update_option( 'migrate_for_idc', true ) ) {
- return rest_ensure_response(
- array(
- 'code' => 'success'
- )
- );
- }
- return new WP_Error(
- 'error_setting_jetpack_migrate',
- esc_html__( 'Could not confirm migration.', 'jetpack' ),
- array( 'status' => 500 )
- );
- }
- /**
- * This IDC resolution will disconnect the site and re-connect to a completely new
- * and separate shadow site than the original.
- *
- * It will first will disconnect the site without phoning home as to not disturb the production site.
- * It then builds a fresh connection URL and sends it back along with the response.
- *
- * @since 4.4.0
- * @return bool|WP_Error
- */
- public static function start_fresh_connection() {
- // First clear the options / disconnect.
- Jetpack::disconnect();
- return self::build_connect_url();
- }
- /**
- * Reset Jetpack options
- *
- * @since 4.3.0
- *
- * @param WP_REST_Request $request {
- * Array of parameters received by request.
- *
- * @type string $options Available options to reset are options|modules
- * }
- *
- * @return bool|WP_Error True if options were reset. Otherwise, a WP_Error instance with the corresponding error.
- */
- public static function reset_jetpack_options( $request ) {
- if ( ! isset( $request['reset'] ) || $request['reset'] !== true ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
- }
- if ( isset( $request['options'] ) ) {
- $data = $request['options'];
- switch( $data ) {
- case ( 'options' ) :
- $options_to_reset = Jetpack::get_jetpack_options_for_reset();
- // Reset the Jetpack options
- foreach ( $options_to_reset['jp_options'] as $option_to_reset ) {
- Jetpack_Options::delete_option( $option_to_reset );
- }
- foreach ( $options_to_reset['wp_options'] as $option_to_reset ) {
- delete_option( $option_to_reset );
- }
- // Reset to default modules
- $default_modules = Jetpack::get_default_modules();
- Jetpack::update_active_modules( $default_modules );
- // Jumpstart option is special
- Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Jetpack options reset.', 'jetpack' ),
- ) );
- break;
- case 'modules':
- $default_modules = Jetpack::get_default_modules();
- Jetpack::update_active_modules( $default_modules );
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Modules reset to default.', 'jetpack' ),
- ) );
- break;
- default:
- return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
- }
- }
- return new WP_Error( 'required_param', esc_html__( 'Missing parameter "type".', 'jetpack' ), array( 'status' => 404 ) );
- }
- /**
- * Retrieves the current status of Jumpstart.
- *
- * @since 4.5.0
- *
- * @return bool
- */
- public static function jumpstart_status() {
- return array(
- 'status' => Jetpack_Options::get_option( 'jumpstart' )
- );
- }
- /**
- * Toggles activation or deactivation of the JumpStart
- *
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return bool|WP_Error True if toggling Jumpstart succeeded. Otherwise, a WP_Error instance with the corresponding error.
- */
- public static function jumpstart_toggle( $request ) {
- if ( $request[ 'active' ] ) {
- return self::jumpstart_activate( $request );
- } else {
- return self::jumpstart_deactivate( $request );
- }
- }
- /**
- * Activates a series of valid Jetpack modules and initializes some options.
- *
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return bool|WP_Error True if Jumpstart succeeded. Otherwise, a WP_Error instance with the corresponding error.
- */
- public static function jumpstart_activate( $request ) {
- $modules = Jetpack::get_available_modules();
- $activate_modules = array();
- foreach ( $modules as $module ) {
- $module_info = Jetpack::get_module( $module );
- if ( isset( $module_info['feature'] ) && is_array( $module_info['feature'] ) && in_array( 'Jumpstart', $module_info['feature'] ) ) {
- $activate_modules[] = $module;
- }
- }
- // Collect success/error messages like modules that are properly activated.
- $result = array(
- 'activated_modules' => array(),
- 'failed_modules' => array(),
- );
- // Update the jumpstart option
- if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
- $result['jumpstart_activated'] = Jetpack_Options::update_option( 'jumpstart', 'jumpstart_activated' );
- }
- // Check for possible conflicting plugins
- $module_slugs_filtered = Jetpack::init()->filter_default_modules( $activate_modules );
- foreach ( $module_slugs_filtered as $module_slug ) {
- Jetpack::log( 'activate', $module_slug );
- if ( Jetpack::activate_module( $module_slug, false, false ) ) {
- $result['activated_modules'][] = $module_slug;
- } else {
- $result['failed_modules'][] = $module_slug;
- }
- }
- // Set the default sharing buttons and set to display on posts if none have been set.
- $sharing_services = get_option( 'sharing-services' );
- $sharing_options = get_option( 'sharing-options' );
- if ( empty( $sharing_services['visible'] ) ) {
- // Default buttons to set
- $visible = array(
- 'twitter',
- 'facebook',
- 'google-plus-1',
- );
- $hidden = array();
- // Set some sharing settings
- if ( class_exists( 'Sharing_Service' ) ) {
- $sharing = new Sharing_Service();
- $sharing_options['global'] = array(
- 'button_style' => 'icon',
- 'sharing_label' => $sharing->default_sharing_label,
- 'open_links' => 'same',
- 'show' => array( 'post' ),
- 'custom' => isset( $sharing_options['global']['custom'] ) ? $sharing_options['global']['custom'] : array()
- );
- $result['sharing_options'] = update_option( 'sharing-options', $sharing_options );
- $result['sharing_services'] = update_option( 'sharing-services', array( 'visible' => $visible, 'hidden' => $hidden ) );
- }
- }
- // If all Jumpstart modules were activated
- if ( empty( $result['failed_modules'] ) ) {
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Jumpstart done.', 'jetpack' ),
- 'data' => $result,
- ) );
- }
- return new WP_Error( 'jumpstart_failed', esc_html( sprintf( _n( 'Jumpstart failed activating this module: %s.', 'Jumpstart failed activating these modules: %s.', count( $result['failed_modules'] ), 'jetpack' ), join( ', ', $result['failed_modules'] ) ) ), array( 'status' => 400 ) );
- }
- /**
- * Dismisses Jumpstart so user is not prompted to go through it again.
- *
- * @since 4.3.0
- *
- * @param WP_REST_Request $request The request sent to the WP REST API.
- *
- * @return bool|WP_Error True if Jumpstart was disabled or was nothing to dismiss. Otherwise, a WP_Error instance with a message.
- */
- public static function jumpstart_deactivate( $request ) {
- // If dismissed, flag the jumpstart option as such.
- if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
- if ( Jetpack_Options::update_option( 'jumpstart', 'jumpstart_dismissed' ) ) {
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Jumpstart dismissed.', 'jetpack' ),
- ) );
- } else {
- return new WP_Error( 'jumpstart_failed_dismiss', esc_html__( 'Jumpstart could not be dismissed.', 'jetpack' ), array( 'status' => 400 ) );
- }
- }
- // If this was not a new connection and there was nothing to dismiss, don't fail.
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Nothing to dismiss. This was not a new connection.', 'jetpack' ),
- ) );
- }
- /**
- * Get the query parameters to update module options or general settings.
- *
- * @since 4.3.0
- * @since 4.4.0 Accepts a $selector parameter.
- *
- * @param string $selector Selects a set of options to update, Can be empty, a module slug or 'any'.
- *
- * @return array
- */
- public static function get_updateable_parameters( $selector = '' ) {
- $parameters = array(
- 'context' => array(
- 'default' => 'edit',
- ),
- );
- return array_merge( $parameters, self::get_updateable_data_list( $selector ) );
- }
- /**
- * Returns a list of module options or general settings that can be updated.
- *
- * @since 4.3.0
- * @since 4.4.0 Accepts 'any' as a parameter which will make it return the entire list.
- *
- * @param string|array $selector Module slug, 'any', or an array of parameters.
- * If empty, it's assumed we're updating a module and we'll try to get its slug.
- * If 'any' the full list is returned.
- * If it's an array of parameters, includes the elements by matching keys.
- *
- * @return array
- */
- public static function get_updateable_data_list( $selector = '' ) {
- $options = array(
- // Carousel
- 'carousel_background_color' => array(
- 'description' => esc_html__( 'Color scheme.', 'jetpack' ),
- 'type' => 'string',
- 'default' => 'black',
- 'enum' => array(
- 'black',
- 'white',
- ),
- 'enum_labels' => array(
- 'black' => esc_html__( 'Black', 'jetpack' ),
- 'white' => esc_html__( 'White', 'jetpack' ),
- ),
- 'validate_callback' => __CLASS__ . '::validate_list_item',
- 'jp_group' => 'carousel',
- ),
- 'carousel_display_exif' => array(
- 'description' => wp_kses( sprintf( __( 'Show photo metadata (<a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) ), array( 'a' => array( 'href' => true, 'target' => true ) ) ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'carousel',
- ),
- // Comments
- 'highlander_comment_form_prompt' => array(
- 'description' => esc_html__( 'Greeting Text', 'jetpack' ),
- 'type' => 'string',
- 'default' => esc_html__( 'Leave a Reply', 'jetpack' ),
- 'sanitize_callback' => 'sanitize_text_field',
- 'jp_group' => 'comments',
- ),
- 'jetpack_comment_form_color_scheme' => array(
- 'description' => esc_html__( "Color scheme", 'jetpack' ),
- 'type' => 'string',
- 'default' => 'light',
- 'enum' => array(
- 'light',
- 'dark',
- 'transparent',
- ),
- 'enum_labels' => array(
- 'light' => esc_html__( 'Light', 'jetpack' ),
- 'dark' => esc_html__( 'Dark', 'jetpack' ),
- 'transparent' => esc_html__( 'Transparent', 'jetpack' ),
- ),
- 'validate_callback' => __CLASS__ . '::validate_list_item',
- 'jp_group' => 'comments',
- ),
- // Custom Content Types
- 'jetpack_portfolio' => array(
- 'description' => esc_html__( 'Enable or disable Jetpack portfolio post type.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'custom-content-types',
- ),
- 'jetpack_portfolio_posts_per_page' => array(
- 'description' => esc_html__( 'Number of entries to show at most in Portfolio pages.', 'jetpack' ),
- 'type' => 'integer',
- 'default' => 10,
- 'validate_callback' => __CLASS__ . '::validate_posint',
- 'jp_group' => 'custom-content-types',
- ),
- 'jetpack_testimonial' => array(
- 'description' => esc_html__( 'Enable or disable Jetpack testimonial post type.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'custom-content-types',
- ),
- 'jetpack_testimonial_posts_per_page' => array(
- 'description' => esc_html__( 'Number of entries to show at most in Testimonial pages.', 'jetpack' ),
- 'type' => 'integer',
- 'default' => 10,
- 'validate_callback' => __CLASS__ . '::validate_posint',
- 'jp_group' => 'custom-content-types',
- ),
- // Galleries
- 'tiled_galleries' => array(
- 'description' => esc_html__( 'Display all your gallery pictures in a cool mosaic.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'tiled-gallery',
- ),
- 'gravatar_disable_hovercards' => array(
- 'description' => esc_html__( "View people's profiles when you mouse over their Gravatars", 'jetpack' ),
- 'type' => 'string',
- 'default' => 'enabled',
- // Not visible. This is used as the checkbox value.
- 'enum' => array(
- 'enabled',
- 'disabled',
- ),
- 'enum_labels' => array(
- 'enabled' => esc_html__( 'Enabled', 'jetpack' ),
- 'disabled' => esc_html__( 'Disabled', 'jetpack' ),
- ),
- 'validate_callback' => __CLASS__ . '::validate_list_item',
- 'jp_group' => 'gravatar-hovercards',
- ),
- // Infinite Scroll
- 'infinite_scroll' => array(
- 'description' => esc_html__( 'To infinity and beyond', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'infinite-scroll',
- ),
- 'infinite_scroll_google_analytics' => array(
- 'description' => esc_html__( 'Use Google Analytics with Infinite Scroll', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'infinite-scroll',
- ),
- // Likes
- 'wpl_default' => array(
- 'description' => esc_html__( 'WordPress.com Likes are', 'jetpack' ),
- 'type' => 'string',
- 'default' => 'on',
- 'enum' => array(
- 'on',
- 'off',
- ),
- 'enum_labels' => array(
- 'on' => esc_html__( 'On for all posts', 'jetpack' ),
- 'off' => esc_html__( 'Turned on per post', 'jetpack' ),
- ),
- 'validate_callback' => __CLASS__ . '::validate_list_item',
- 'jp_group' => 'likes',
- ),
- 'social_notifications_like' => array(
- 'description' => esc_html__( 'Send email notification when someone likes a post', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'likes',
- ),
- // Markdown
- 'wpcom_publish_comments_with_markdown' => array(
- 'description' => esc_html__( 'Use Markdown for comments.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'markdown',
- ),
- 'wpcom_publish_posts_with_markdown' => array(
- 'description' => esc_html__( 'Use Markdown for posts.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'markdown',
- ),
- // Mobile Theme
- 'wp_mobile_excerpt' => array(
- 'description' => esc_html__( 'Excerpts', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'minileven',
- ),
- 'wp_mobile_featured_images' => array(
- 'description' => esc_html__( 'Featured Images', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'minileven',
- ),
- 'wp_mobile_app_promos' => array(
- 'description' => esc_html__( 'Show a promo for the WordPress mobile apps in the footer of the mobile theme.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'minileven',
- ),
- // Monitor
- 'monitor_receive_notifications' => array(
- 'description' => esc_html__( 'Receive Monitor Email Notifications.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'monitor',
- ),
- // Post by Email
- 'post_by_email_address' => array(
- 'description' => esc_html__( 'Email Address', 'jetpack' ),
- 'type' => 'string',
- 'default' => 'noop',
- 'enum' => array(
- 'noop',
- 'create',
- 'regenerate',
- 'delete',
- ),
- 'enum_labels' => array(
- 'noop' => '',
- 'create' => esc_html__( 'Create Post by Email address', 'jetpack' ),
- 'regenerate' => esc_html__( 'Regenerate Post by Email address', 'jetpack' ),
- 'delete' => esc_html__( 'Delete Post by Email address', 'jetpack' ),
- ),
- 'validate_callback' => __CLASS__ . '::validate_list_item',
- 'jp_group' => 'post-by-email',
- ),
- // Protect
- 'jetpack_protect_key' => array(
- 'description' => esc_html__( 'Protect API key', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_alphanum',
- 'jp_group' => 'protect',
- ),
- 'jetpack_protect_global_whitelist' => array(
- 'description' => esc_html__( 'Protect global whitelist', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_string',
- 'sanitize_callback' => 'esc_textarea',
- 'jp_group' => 'protect',
- ),
- // Sharing
- 'sharing_services' => array(
- 'description' => esc_html__( 'Enabled Services and those hidden behind a button', 'jetpack' ),
- 'type' => 'object',
- 'default' => array(
- 'visible' => array( 'twitter', 'facebook', 'google-plus-1' ),
- 'hidden' => array(),
- ),
- 'validate_callback' => __CLASS__ . '::validate_services',
- 'jp_group' => 'sharedaddy',
- ),
- 'button_style' => array(
- 'description' => esc_html__( 'Button Style', 'jetpack' ),
- 'type' => 'string',
- 'default' => 'icon',
- 'enum' => array(
- 'icon-text',
- 'icon',
- 'text',
- 'official',
- ),
- 'enum_labels' => array(
- 'icon-text' => esc_html__( 'Icon + text', 'jetpack' ),
- 'icon' => esc_html__( 'Icon only', 'jetpack' ),
- 'text' => esc_html__( 'Text only', 'jetpack' ),
- 'official' => esc_html__( 'Official buttons', 'jetpack' ),
- ),
- 'validate_callback' => __CLASS__ . '::validate_list_item',
- 'jp_group' => 'sharedaddy',
- ),
- 'sharing_label' => array(
- 'description' => esc_html__( 'Sharing Label', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_string',
- 'sanitize_callback' => 'esc_html',
- 'jp_group' => 'sharedaddy',
- ),
- 'show' => array(
- 'description' => esc_html__( 'Views where buttons are shown', 'jetpack' ),
- 'type' => 'array',
- 'items' => array(
- 'type' => 'string'
- ),
- 'default' => array( 'post' ),
- 'validate_callback' => __CLASS__ . '::validate_sharing_show',
- 'jp_group' => 'sharedaddy',
- ),
- 'jetpack-twitter-cards-site-tag' => array(
- 'description' => esc_html__( "The Twitter username of the owner of this site's domain.", 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_twitter_username',
- 'sanitize_callback' => 'esc_html',
- 'jp_group' => 'sharedaddy',
- ),
- 'sharedaddy_disable_resources' => array(
- 'description' => esc_html__( 'Disable CSS and JS', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'sharedaddy',
- ),
- 'custom' => array(
- 'description' => esc_html__( 'Custom sharing services added by user.', 'jetpack' ),
- 'type' => 'object',
- 'default' => array(
- 'sharing_name' => '',
- 'sharing_url' => '',
- 'sharing_icon' => '',
- ),
- 'validate_callback' => __CLASS__ . '::validate_custom_service',
- 'jp_group' => 'sharedaddy',
- ),
- // Not an option, but an action that can be perfomed on the list of custom services passing the service ID.
- 'sharing_delete_service' => array(
- 'description' => esc_html__( 'Delete custom sharing service.', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_custom_service_id',
- 'jp_group' => 'sharedaddy',
- ),
- // SSO
- 'jetpack_sso_require_two_step' => array(
- 'description' => esc_html__( 'Require Two-Step Authentication', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'sso',
- ),
- 'jetpack_sso_match_by_email' => array(
- 'description' => esc_html__( 'Match by Email', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'sso',
- ),
- // Subscriptions
- 'stb_enabled' => array(
- 'description' => esc_html__( "Show a <em>'follow blog'</em> option in the comment form", 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'subscriptions',
- ),
- 'stc_enabled' => array(
- 'description' => esc_html__( "Show a <em>'follow comments'</em> option in the comment form", 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'subscriptions',
- ),
- // Related Posts
- 'show_headline' => array(
- 'description' => esc_html__( 'Highlight related content with a heading', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'related-posts',
- ),
- 'show_thumbnails' => array(
- 'description' => esc_html__( 'Show a thumbnail image where available', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'related-posts',
- ),
- // Spelling and Grammar - After the Deadline
- 'onpublish' => array(
- 'description' => esc_html__( 'Proofread when a post or page is first published.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'onupdate' => array(
- 'description' => esc_html__( 'Proofread when a post or page is updated.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Bias Language' => array(
- 'description' => esc_html__( 'Bias Language', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Cliches' => array(
- 'description' => esc_html__( 'Clichés', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Complex Expression' => array(
- 'description' => esc_html__( 'Complex Phrases', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Diacritical Marks' => array(
- 'description' => esc_html__( 'Diacritical Marks', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Double Negative' => array(
- 'description' => esc_html__( 'Double Negatives', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Hidden Verbs' => array(
- 'description' => esc_html__( 'Hidden Verbs', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Jargon Language' => array(
- 'description' => esc_html__( 'Jargon', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Passive voice' => array(
- 'description' => esc_html__( 'Passive Voice', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Phrases to Avoid' => array(
- 'description' => esc_html__( 'Phrases to Avoid', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'Redundant Expression' => array(
- 'description' => esc_html__( 'Redundant Phrases', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'guess_lang' => array(
- 'description' => esc_html__( 'Use automatically detected language to proofread posts and pages', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'after-the-deadline',
- ),
- 'ignored_phrases' => array(
- 'description' => esc_html__( 'Add Phrase to be ignored', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'sanitize_callback' => 'esc_html',
- 'jp_group' => 'after-the-deadline',
- ),
- 'unignore_phrase' => array(
- 'description' => esc_html__( 'Remove Phrase from being ignored', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'sanitize_callback' => 'esc_html',
- 'jp_group' => 'after-the-deadline',
- ),
- // Verification Tools
- 'google' => array(
- 'description' => esc_html__( 'Google Search Console', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_verification_service',
- 'jp_group' => 'verification-tools',
- ),
- 'bing' => array(
- 'description' => esc_html__( 'Bing Webmaster Center', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_verification_service',
- 'jp_group' => 'verification-tools',
- ),
- 'pinterest' => array(
- 'description' => esc_html__( 'Pinterest Site Verification', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_verification_service',
- 'jp_group' => 'verification-tools',
- ),
- 'yandex' => array(
- 'description' => esc_html__( 'Yandex Site Verification', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_verification_service',
- 'jp_group' => 'verification-tools',
- ),
- 'enable_header_ad' => array(
- 'description' => esc_html__( 'Display an ad unit at the top of each page.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_approved' => array(
- 'description' => esc_html__( 'Is site approved for WordAds?', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_second_belowpost' => array(
- 'description' => esc_html__( 'Display second ad below post?', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_display_front_page' => array(
- 'description' => esc_html__( 'Display ads on the front page?', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_display_post' => array(
- 'description' => esc_html__( 'Display ads on posts?', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_display_page' => array(
- 'description' => esc_html__( 'Display ads on pages?', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_display_archive' => array(
- 'description' => esc_html__( 'Display ads on archive pages?', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'wordads',
- ),
- 'wordads_custom_adstxt' => array(
- 'description' => esc_html__( 'Custom ads.txt entries', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_string',
- 'sanitize_callback' => 'sanitize_textarea_field',
- 'jp_group' => 'wordads',
- ),
- // Google Analytics
- 'google_analytics_tracking_id' => array(
- 'description' => esc_html__( 'Google Analytics', 'jetpack' ),
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_alphanum',
- 'jp_group' => 'google-analytics',
- ),
- // Stats
- 'admin_bar' => array(
- 'description' => esc_html__( 'Put a chart showing 48 hours of views in the admin bar.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'stats',
- ),
- 'roles' => array(
- 'description' => esc_html__( 'Select the roles that will be able to view stats reports.', 'jetpack' ),
- 'type' => 'array',
- 'items' => array(
- 'type' => 'string'
- ),
- 'default' => array( 'administrator' ),
- 'validate_callback' => __CLASS__ . '::validate_stats_roles',
- 'sanitize_callback' => __CLASS__ . '::sanitize_stats_allowed_roles',
- 'jp_group' => 'stats',
- ),
- 'count_roles' => array(
- 'description' => esc_html__( 'Count the page views of registered users who are logged in.', 'jetpack' ),
- 'type' => 'array',
- 'items' => array(
- 'type' => 'string'
- ),
- 'default' => array( 'administrator' ),
- 'validate_callback' => __CLASS__ . '::validate_stats_roles',
- 'jp_group' => 'stats',
- ),
- 'blog_id' => array(
- 'description' => esc_html__( 'Blog ID.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'stats',
- ),
- 'do_not_track' => array(
- 'description' => esc_html__( 'Do not track.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'stats',
- ),
- 'hide_smile' => array(
- 'description' => esc_html__( 'Hide the stats smiley face image.', 'jetpack' ),
- 'type' => 'boolean',
- 'default' => 1,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'stats',
- ),
- 'version' => array(
- 'description' => esc_html__( 'Version.', 'jetpack' ),
- 'type' => 'integer',
- 'default' => 9,
- 'validate_callback' => __CLASS__ . '::validate_posint',
- 'jp_group' => 'stats',
- ),
- // Akismet - Not a module, but a plugin. The options can be passed and handled differently.
- 'akismet_show_user_comments_approved' => array(
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'settings',
- ),
- 'wordpress_api_key' => array(
- 'description' => '',
- 'type' => 'string',
- 'default' => '',
- 'validate_callback' => __CLASS__ . '::validate_alphanum',
- 'jp_group' => 'settings',
- ),
- // Apps card on dashboard
- 'dismiss_dash_app_card' => array(
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'settings',
- ),
- // Empty stats card dismiss
- 'dismiss_empty_stats_card' => array(
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'settings',
- ),
- 'lang_id' => array(
- 'description' => esc_html__( 'Primary language for the site.', 'jetpack' ),
- 'type' => 'string',
- 'default' => 'en_US',
- 'jp_group' => 'settings',
- ),
- 'onboarding' => array(
- 'description' => '',
- 'type' => 'object',
- 'default' => array(
- 'siteTitle' => '',
- 'siteDescription' => '',
- 'siteType' => 'personal',
- 'homepageFormat' => 'posts',
- 'addContactForm' => 0,
- 'businessAddress' => array(
- 'name' => '',
- 'street' => '',
- 'city' => '',
- 'state' => '',
- 'zip' => '',
- ),
- 'installWooCommerce' => false,
- ),
- 'validate_callback' => __CLASS__ . '::validate_onboarding',
- 'jp_group' => 'settings',
- ),
- // Show welcome for newly purchased plan
- 'show_welcome_for_new_plan' => array(
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'settings',
- ),
- );
- // Add modules to list so they can be toggled
- $modules = Jetpack::get_available_modules();
- if ( is_array( $modules ) && ! empty( $modules ) ) {
- $module_args = array(
- 'description' => '',
- 'type' => 'boolean',
- 'default' => 0,
- 'validate_callback' => __CLASS__ . '::validate_boolean',
- 'jp_group' => 'modules',
- );
- foreach( $modules as $module ) {
- $options[ $module ] = $module_args;
- }
- }
- if ( is_array( $selector ) ) {
- // Return only those options whose keys match $selector keys
- return array_intersect_key( $options, $selector );
- }
- if ( 'any' === $selector ) {
- // Toggle module or update any module option or any general setting
- return $options;
- }
- // We're updating the options for a single module.
- if ( empty( $selector ) ) {
- $selector = self::get_module_requested();
- }
- $selected = array();
- foreach ( $options as $option => $attributes ) {
- // Not adding an isset( $attributes['jp_group'] ) because if it's not set, it must be fixed, otherwise options will fail.
- if ( $selector === $attributes['jp_group'] ) {
- $selected[ $option ] = $attributes;
- }
- }
- return $selected;
- }
- /**
- * Validates that the parameters are proper values that can be set during Jetpack onboarding.
- *
- * @since 5.4.0
- *
- * @param array $onboarding_data Values to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_onboarding( $onboarding_data, $request, $param ) {
- if ( ! is_array( $onboarding_data ) ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Not valid onboarding data.', 'jetpack' ) );
- }
- foreach ( $onboarding_data as $value ) {
- if ( is_string( $value ) ) {
- $onboarding_choice = self::validate_string( $value, $request, $param );
- } elseif ( is_array( $value ) ) {
- $onboarding_choice = self::validate_onboarding( $value, $request, $param );
- } else {
- $onboarding_choice = self::validate_boolean( $value, $request, $param );
- }
- if ( is_wp_error( $onboarding_choice ) ) {
- return $onboarding_choice;
- }
- }
- return true;
- }
- /**
- * Validates that the parameter is either a pure boolean or a numeric string that can be mapped to a boolean.
- *
- * @since 4.3.0
- *
- * @param string|bool $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_boolean( $value, $request, $param ) {
- if ( ! is_bool( $value ) && ! ( ( ctype_digit( $value ) || is_numeric( $value ) ) && in_array( $value, array( 0, 1 ) ) ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be true, false, 0 or 1.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is a positive integer.
- *
- * @since 4.3.0
- *
- * @param int $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_posint( $value = 0, $request, $param ) {
- if ( ! is_numeric( $value ) || $value <= 0 ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a positive integer.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter belongs to a list of admitted values.
- *
- * @since 4.3.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_list_item( $value = '', $request, $param ) {
- $attributes = $request->get_attributes();
- if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s not recognized', 'jetpack' ), $param ) );
- }
- $args = $attributes['args'][ $param ];
- if ( ! empty( $args['enum'] ) ) {
- // If it's an associative array, use the keys to check that the value is among those admitted.
- $enum = ( count( array_filter( array_keys( $args['enum'] ), 'is_string' ) ) > 0 ) ? array_keys( $args['enum'] ) : $args['enum'];
- if ( ! in_array( $value, $enum ) ) {
- return new WP_Error( 'invalid_param_value', sprintf(
- /* Translators: first variable is the parameter passed to endpoint that holds the list item, the second is a list of admitted values. */
- esc_html__( '%1$s must be one of %2$s', 'jetpack' ), $param, implode( ', ', $enum )
- ) );
- }
- }
- return true;
- }
- /**
- * Validates that the parameter belongs to a list of admitted values.
- *
- * @since 4.3.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_module_list( $value = '', $request, $param ) {
- if ( ! is_array( $value ) ) {
- return new WP_Error( 'invalid_param_value', sprintf( esc_html__( '%s must be an array', 'jetpack' ), $param ) );
- }
- $modules = Jetpack::get_available_modules();
- if ( count( array_intersect( $value, $modules ) ) != count( $value ) ) {
- return new WP_Error( 'invalid_param_value', sprintf( esc_html__( '%s must be a list of valid modules', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is an alphanumeric or empty string (to be able to clear the field).
- *
- * @since 4.3.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_alphanum( $value = '', $request, $param ) {
- if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/^[a-z0-9]+$/i', $value ) ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is a tag or id for a verification service, or an empty string (to be able to clear the field).
- *
- * @since 4.6.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_verification_service( $value = '', $request, $param ) {
- if ( ! empty( $value ) && ! ( is_string( $value ) && ( preg_match( '/^[a-z0-9_-]+$/i', $value ) || jetpack_verification_get_code( $value ) !== false ) ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string or a verification tag.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is among the roles allowed for Stats.
- *
- * @since 4.3.0
- *
- * @param string|bool $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_stats_roles( $value, $request, $param ) {
- if ( ! empty( $value ) && ! array_intersect( self::$stats_roles, $value ) ) {
- return new WP_Error( 'invalid_param', sprintf(
- /* Translators: first variable is the name of a parameter passed to endpoint holding the role that will be checked, the second is a list of roles allowed to see stats. The parameter is checked against this list. */
- esc_html__( '%1$s must be %2$s.', 'jetpack' ), $param, join( ', ', self::$stats_roles )
- ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is among the views where the Sharing can be displayed.
- *
- * @since 4.3.0
- *
- * @param string|bool $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_sharing_show( $value, $request, $param ) {
- $views = array( 'index', 'post', 'page', 'attachment', 'jetpack-portfolio' );
- if ( ! is_array( $value ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array of post types.', 'jetpack' ), $param ) );
- }
- if ( ! array_intersect( $views, $value ) ) {
- return new WP_Error( 'invalid_param', sprintf(
- /* Translators: first variable is the name of a parameter passed to endpoint holding the post type where Sharing will be displayed, the second is a list of post types where Sharing can be displayed */
- esc_html__( '%1$s must be %2$s.', 'jetpack' ), $param, join( ', ', $views )
- ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is among the views where the Sharing can be displayed.
- *
- * @since 4.3.0
- *
- * @param string|bool $value {
- * Value to check received by request.
- *
- * @type array $visible List of slug of services to share to that are displayed directly in the page.
- * @type array $hidden List of slug of services to share to that are concealed in a folding menu.
- * }
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_services( $value, $request, $param ) {
- if ( ! is_array( $value ) || ! isset( $value['visible'] ) || ! isset( $value['hidden'] ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array with visible and hidden items.', 'jetpack' ), $param ) );
- }
- // Allow to clear everything.
- if ( empty( $value['visible'] ) && empty( $value['hidden'] ) ) {
- return true;
- }
- if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
- }
- $sharer = new Sharing_Service();
- $services = array_keys( $sharer->get_all_services() );
- if (
- ( ! empty( $value['visible'] ) && ! array_intersect( $value['visible'], $services ) )
- ||
- ( ! empty( $value['hidden'] ) && ! array_intersect( $value['hidden'], $services ) ) )
- {
- return new WP_Error( 'invalid_param', sprintf(
- /* Translators: placeholder 1 is a parameter holding the services passed to endpoint, placeholder 2 is a list of all Jetpack Sharing services */
- esc_html__( '%1$s visible and hidden items must be a list of %2$s.', 'jetpack' ), $param, join( ', ', $services )
- ) );
- }
- return true;
- }
- /**
- * Validates that the parameter has enough information to build a custom sharing button.
- *
- * @since 4.3.0
- *
- * @param string|bool $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_custom_service( $value, $request, $param ) {
- if ( ! is_array( $value ) || ! isset( $value['sharing_name'] ) || ! isset( $value['sharing_url'] ) || ! isset( $value['sharing_icon'] ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array with sharing name, url and icon.', 'jetpack' ), $param ) );
- }
- // Allow to clear everything.
- if ( empty( $value['sharing_name'] ) && empty( $value['sharing_url'] ) && empty( $value['sharing_icon'] ) ) {
- return true;
- }
- if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
- }
- if ( ( ! empty( $value['sharing_name'] ) && ! is_string( $value['sharing_name'] ) )
- || ( ! empty( $value['sharing_url'] ) && ! is_string( $value['sharing_url'] ) )
- || ( ! empty( $value['sharing_icon'] ) && ! is_string( $value['sharing_icon'] ) ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s needs sharing name, url and icon.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is a custom sharing service ID like 'custom-1461976264'.
- *
- * @since 4.3.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_custom_service_id( $value = '', $request, $param ) {
- if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/custom\-[0-1]+/i', $value ) ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( "%s must be a string prefixed with 'custom-' and followed by a numeric ID.", 'jetpack' ), $param ) );
- }
- if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
- return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
- }
- $sharer = new Sharing_Service();
- $services = array_keys( $sharer->get_all_services() );
- if ( ! empty( $value ) && ! in_array( $value, $services ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s is not a registered custom sharing service.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is a Twitter username or empty string (to be able to clear the field).
- *
- * @since 4.3.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_twitter_username( $value = '', $request, $param ) {
- if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/^@?\w{1,15}$/i', $value ) ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a Twitter username.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * Validates that the parameter is a string.
- *
- * @since 4.3.0
- *
- * @param string $value Value to check.
- * @param WP_REST_Request $request The request sent to the WP REST API.
- * @param string $param Name of the parameter passed to endpoint holding $value.
- *
- * @return bool|WP_Error
- */
- public static function validate_string( $value = '', $request, $param ) {
- if ( ! is_string( $value ) ) {
- return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a string.', 'jetpack' ), $param ) );
- }
- return true;
- }
- /**
- * If for some reason the roles allowed to see Stats are empty (for example, user tampering with checkboxes),
- * return an array with only 'administrator' as the allowed role and save it for 'roles' option.
- *
- * @since 4.3.0
- *
- * @param string|bool $value Value to check.
- *
- * @return bool|array
- */
- public static function sanitize_stats_allowed_roles( $value ) {
- if ( empty( $value ) ) {
- return array( 'administrator' );
- }
- return $value;
- }
- /**
- * Get the currently accessed route and return the module slug in it.
- *
- * @since 4.3.0
- *
- * @param string $route Regular expression for the endpoint with the module slug to return.
- *
- * @return array|string
- */
- public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
- if ( empty( $GLOBALS['wp']->query_vars['rest_route'] ) ) {
- return '';
- }
- preg_match( "#$route#", $GLOBALS['wp']->query_vars['rest_route'], $module );
- if ( empty( $module['slug'] ) ) {
- return '';
- }
- return $module['slug'];
- }
- /**
- * Adds extra information for modules.
- *
- * @since 4.3.0
- *
- * @param string|array $modules Can be a single module or a list of modules.
- * @param null|string $slug Slug of the module in the first parameter.
- *
- * @return array|string
- */
- public static function prepare_modules_for_response( $modules = '', $slug = null ) {
- global $wp_rewrite;
- /** This filter is documented in modules/sitemaps/sitemaps.php */
- $location = apply_filters( 'jetpack_sitemap_location', '' );
- if ( $wp_rewrite->using_index_permalinks() ) {
- $sitemap_url = home_url( '/index.php' . $location . '/sitemap.xml' );
- $news_sitemap_url = home_url( '/index.php' . $location . '/news-sitemap.xml' );
- } else if ( $wp_rewrite->using_permalinks() ) {
- $sitemap_url = home_url( $location . '/sitemap.xml' );
- $news_sitemap_url = home_url( $location . '/news-sitemap.xml' );
- } else {
- $sitemap_url = home_url( $location . '/?jetpack-sitemap=sitemap.xml' );
- $news_sitemap_url = home_url( $location . '/?jetpack-sitemap=news-sitemap.xml' );
- }
- if ( is_null( $slug ) && isset( $modules['sitemaps'] ) ) {
- // Is a list of modules
- $modules['sitemaps']['extra']['sitemap_url'] = $sitemap_url;
- $modules['sitemaps']['extra']['news_sitemap_url'] = $news_sitemap_url;
- } elseif ( 'sitemaps' == $slug ) {
- // It's a single module
- $modules['extra']['sitemap_url'] = $sitemap_url;
- $modules['extra']['news_sitemap_url'] = $news_sitemap_url;
- }
- return $modules;
- }
- /**
- * Remove 'validate_callback' item from options available for module.
- * Fetch current option value and add to array of module options.
- * Prepare values of module options that need special handling, like those saved in wpcom.
- *
- * @since 4.3.0
- *
- * @param string $module Module slug.
- * @return array
- */
- public static function prepare_options_for_response( $module = '' ) {
- $options = self::get_updateable_data_list( $module );
- if ( ! is_array( $options ) || empty( $options ) ) {
- return $options;
- }
- // Some modules need special treatment.
- switch ( $module ) {
- case 'monitor':
- // Status of user notifications
- $options['monitor_receive_notifications']['current_value'] = self::cast_value( self::get_remote_value( 'monitor', 'monitor_receive_notifications' ), $options['monitor_receive_notifications'] );
- break;
- case 'post-by-email':
- // Email address
- $options['post_by_email_address']['current_value'] = self::cast_value( self::get_remote_value( 'post-by-email', 'post_by_email_address' ), $options['post_by_email_address'] );
- break;
- case 'protect':
- // Protect
- $options['jetpack_protect_key']['current_value'] = get_site_option( 'jetpack_protect_key', false );
- if ( ! function_exists( 'jetpack_protect_format_whitelist' ) ) {
- include_once( JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php' );
- }
- $options['jetpack_protect_global_whitelist']['current_value'] = jetpack_protect_format_whitelist();
- break;
- case 'related-posts':
- // It's local, but it must be broken apart since it's saved as an array.
- $options = self::split_options( $options, Jetpack_Options::get_option( 'relatedposts' ) );
- break;
- case 'verification-tools':
- // It's local, but it must be broken apart since it's saved as an array.
- $options = self::split_options( $options, get_option( 'verification_services_codes' ) );
- break;
- case 'google-analytics':
- $wga = get_option( 'jetpack_wga' );
- $code = '';
- if ( is_array( $wga ) && array_key_exists( 'code', $wga ) ) {
- $code = $wga[ 'code' ];
- }
- $options[ 'google_analytics_tracking_id' ][ 'current_value' ] = $code;
- break;
- case 'sharedaddy':
- // It's local, but it must be broken apart since it's saved as an array.
- if ( ! class_exists( 'Sharing_Service' ) && ! include_once( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
- break;
- }
- $sharer = new Sharing_Service();
- $options = self::split_options( $options, $sharer->get_global_options() );
- $options['sharing_services']['current_value'] = $sharer->get_blog_services();
- $other_sharedaddy_options = array( 'jetpack-twitter-cards-site-tag', 'sharedaddy_disable_resources', 'sharing_delete_service' );
- foreach ( $other_sharedaddy_options as $key ) {
- $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
- $current_value = get_option( $key, $default_value );
- $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
- }
- break;
- case 'after-the-deadline':
- if ( ! function_exists( 'AtD_get_options' ) ) {
- include_once( JETPACK__PLUGIN_DIR . 'modules/after-the-deadline.php' );
- }
- $atd_options = array_merge( AtD_get_options( get_current_user_id(), 'AtD_options' ), AtD_get_options( get_current_user_id(), 'AtD_check_when' ) );
- unset( $atd_options['name'] );
- foreach ( $atd_options as $key => $value ) {
- $options[ $key ]['current_value'] = self::cast_value( $value, $options[ $key ] );
- }
- $atd_options = AtD_get_options( get_current_user_id(), 'AtD_guess_lang' );
- $options['guess_lang']['current_value'] = self::cast_value( isset( $atd_options['true'] ), $options[ 'guess_lang' ] );
- $options['ignored_phrases']['current_value'] = AtD_get_setting( get_current_user_id(), 'AtD_ignored_phrases' );
- unset( $options['unignore_phrase'] );
- break;
- case 'stats':
- // It's local, but it must be broken apart since it's saved as an array.
- if ( ! function_exists( 'stats_get_options' ) ) {
- include_once( JETPACK__PLUGIN_DIR . 'modules/stats.php' );
- }
- $options = self::split_options( $options, stats_get_options() );
- break;
- default:
- // These option are just stored as plain WordPress options.
- foreach ( $options as $key => $value ) {
- $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
- $current_value = get_option( $key, $default_value );
- $options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
- }
- }
- // At this point some options have current_value not set because they're options
- // that only get written on update, so we set current_value to the default one.
- foreach ( $options as $key => $value ) {
- // We don't need validate_callback in the response
- if ( isset( $options[ $key ]['validate_callback'] ) ) {
- unset( $options[ $key ]['validate_callback'] );
- }
- $default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
- if ( ! array_key_exists( 'current_value', $options[ $key ] ) ) {
- $options[ $key ]['current_value'] = self::cast_value( $default_value, $options[ $key ] );
- }
- }
- return $options;
- }
- /**
- * Splits module options saved as arrays like relatedposts or verification_services_codes into separate options to be returned in the response.
- *
- * @since 4.3.0
- *
- * @param array $separate_options Array of options admitted by the module.
- * @param array $grouped_options Option saved as array to be splitted.
- * @param string $prefix Optional prefix for the separate option keys.
- *
- * @return array
- */
- public static function split_options( $separate_options, $grouped_options, $prefix = '' ) {
- if ( is_array( $grouped_options ) ) {
- foreach ( $grouped_options as $key => $value ) {
- $option_key = $prefix . $key;
- if ( isset( $separate_options[ $option_key ] ) ) {
- $separate_options[ $option_key ]['current_value'] = self::cast_value( $grouped_options[ $key ], $separate_options[ $option_key ] );
- }
- }
- }
- return $separate_options;
- }
- /**
- * Perform a casting to the value specified in the option definition.
- *
- * @since 4.3.0
- *
- * @param mixed $value Value to cast to the proper type.
- * @param array $definition Type to cast the value to.
- *
- * @return bool|float|int|string
- */
- public static function cast_value( $value, $definition ) {
- if ( $value === 'NULL' ) {
- return null;
- }
- if ( isset( $definition['type'] ) ) {
- switch ( $definition['type'] ) {
- case 'boolean':
- if ( 'true' === $value ) {
- return true;
- } elseif ( 'false' === $value ) {
- return false;
- }
- return (bool) $value;
- break;
- case 'integer':
- return (int) $value;
- break;
- case 'float':
- return (float) $value;
- break;
- case 'string':
- return (string) $value;
- break;
- }
- }
- return $value;
- }
- /**
- * Get a value not saved locally.
- *
- * @since 4.3.0
- *
- * @param string $module Module slug.
- * @param string $option Option name.
- *
- * @return bool Whether user is receiving notifications or not.
- */
- public static function get_remote_value( $module, $option ) {
- if ( in_array( $module, array( 'post-by-email' ), true ) ) {
- $option .= get_current_user_id();
- }
- // If option doesn't exist, 'does_not_exist' will be returned.
- $value = get_option( $option, 'does_not_exist' );
- // If option exists, just return it.
- if ( 'does_not_exist' !== $value ) {
- return $value;
- }
- // Only check a remote option if Jetpack is connected.
- if ( ! Jetpack::is_active() ) {
- return false;
- }
- // Do what is necessary for each module.
- switch ( $module ) {
- case 'monitor':
- // Load the class to use the method. If class can't be found, do nothing.
- if ( ! class_exists( 'Jetpack_Monitor' ) && ! include_once( Jetpack::get_module_path( $module ) ) ) {
- return false;
- }
- $value = Jetpack_Monitor::user_receives_notifications( false );
- break;
- case 'post-by-email':
- // Load the class to use the method. If class can't be found, do nothing.
- if ( ! class_exists( 'Jetpack_Post_By_Email' ) && ! include_once( Jetpack::get_module_path( $module ) ) ) {
- return false;
- }
- $post_by_email = new Jetpack_Post_By_Email();
- $value = $post_by_email->get_post_by_email_address();
- if ( $value === null ) {
- $value = 'NULL'; // sentinel value so it actually gets set
- }
- break;
- }
- // Normalize value to boolean.
- if ( is_wp_error( $value ) || is_null( $value ) ) {
- $value = false;
- }
- // Save option to use it next time.
- update_option( $option, $value );
- return $value;
- }
- /**
- * Get number of plugin updates available.
- *
- * @since 4.3.0
- *
- * @return mixed|WP_Error Number of plugin updates available. Otherwise, a WP_Error instance with the corresponding error.
- */
- public static function get_plugin_update_count() {
- $updates = wp_get_update_data();
- if ( isset( $updates['counts'] ) && isset( $updates['counts']['plugins'] ) ) {
- $count = $updates['counts']['plugins'];
- if ( 0 == $count ) {
- $response = array(
- 'code' => 'success',
- 'message' => esc_html__( 'All plugins are up-to-date. Keep up the good work!', 'jetpack' ),
- 'count' => 0,
- );
- } else {
- $response = array(
- 'code' => 'updates-available',
- 'message' => esc_html( sprintf( _n( '%s plugin need updating.', '%s plugins need updating.', $count, 'jetpack' ), $count ) ),
- 'count' => $count,
- );
- }
- return rest_ensure_response( $response );
- }
- return new WP_Error( 'not_found', esc_html__( 'Could not check updates for plugins on this site.', 'jetpack' ), array( 'status' => 404 ) );
- }
- /**
- * Returns a list of all plugins in the site.
- *
- * @since 4.2.0
- * @uses get_plugins()
- *
- * @return array
- */
- private static function core_get_plugins() {
- if ( ! function_exists( 'get_plugins' ) ) {
- require_once ABSPATH . 'wp-admin/includes/plugin.php';
- }
- /** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
- $plugins = apply_filters( 'all_plugins', get_plugins() );
- if ( is_array( $plugins ) && ! empty( $plugins ) ) {
- foreach ( $plugins as $plugin_slug => $plugin_data ) {
- $plugins[ $plugin_slug ]['active'] = self::core_is_plugin_active( $plugin_slug );
- }
- return $plugins;
- }
- return array();
- }
- /**
- * Checks if the queried plugin is active.
- *
- * @since 4.2.0
- * @uses is_plugin_active()
- *
- * @return bool
- */
- private static function core_is_plugin_active( $plugin ) {
- if ( ! function_exists( 'is_plugin_active' ) ) {
- require_once ABSPATH . 'wp-admin/includes/plugin.php';
- }
- return is_plugin_active( $plugin );
- }
- /**
- * Get plugins data in site.
- *
- * @since 4.2.0
- *
- * @return WP_REST_Response|WP_Error List of plugins in the site. Otherwise, a WP_Error instance with the corresponding error.
- */
- public static function get_plugins() {
- $plugins = self::core_get_plugins();
- if ( ! empty( $plugins ) ) {
- return rest_ensure_response( $plugins );
- }
- return new WP_Error( 'not_found', esc_html__( 'Unable to list plugins.', 'jetpack' ), array( 'status' => 404 ) );
- }
- /**
- * Get data about the queried plugin. Currently it only returns whether the plugin is active or not.
- *
- * @since 4.2.0
- *
- * @param WP_REST_Request $request {
- * Array of parameters received by request.
- *
- * @type string $slug Plugin slug with the syntax 'plugin-directory/plugin-main-file.php'.
- * }
- *
- * @return bool|WP_Error True if module was activated. Otherwise, a WP_Error instance with the corresponding error.
- */
- public static function get_plugin( $request ) {
- $plugins = self::core_get_plugins();
- if ( empty( $plugins ) ) {
- return new WP_Error( 'no_plugins_found', esc_html__( 'This site has no plugins.', 'jetpack' ), array( 'status' => 404 ) );
- }
- $plugin = stripslashes( $request['plugin'] );
- if ( ! in_array( $plugin, array_keys( $plugins ) ) ) {
- return new WP_Error( 'plugin_not_found', esc_html( sprintf( __( 'Plugin %s is not installed.', 'jetpack' ), $plugin ) ), array( 'status' => 404 ) );
- }
- $plugin_data = $plugins[ $plugin ];
- $plugin_data['active'] = self::core_is_plugin_active( $plugin );
- return rest_ensure_response( array(
- 'code' => 'success',
- 'message' => esc_html__( 'Plugin found.', 'jetpack' ),
- 'data' => $plugin_data
- ) );
- }
- } // class end
|