mirror of
https://gh.wpcy.net/https://github.com/mainwp/mainwp.dev.git
synced 2026-07-16 17:53:07 +08:00
3081 lines
162 KiB
HTML
3081 lines
162 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>MainWP Dashboard Documentation</title>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<base href="../">
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="css/template.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
<script src="js/template.js"></script>
|
|
<script src="js/search.js"></script>
|
|
<script defer src="js/searchIndex.js"></script>
|
|
</head>
|
|
<body id="top">
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">MainWP Dashboard Documentation</a></h1>
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
<i class="fas fa-bars"></i>
|
|
</label>
|
|
<section data-search-form class="phpdocumentor-search">
|
|
<label>
|
|
<span class="visually-hidden">Search for</span>
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
</svg>
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
</label>
|
|
</section>
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="phpdocumentor">
|
|
<div class="phpdocumentor-section">
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
Menu
|
|
</label>
|
|
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category -namespaces">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/mainwp.html" class="">MainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/mainwp-dashboard.html" class="">Dashboard</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category -packages">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPDashboard.html" class="">MainWPDashboard</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPAPIManagerKeyHandler.html" class="">MainWPAPIManagerKeyHandler</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPMainWP.html" class="">MainWPMainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPMainWP-API.html" class="">API</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPMainWP-Keys.html" class="">Keys</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPMainWP-Client.html" class="">Client</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPAPIManagerUpdateHandler.html" class="">MainWPAPIManagerUpdateHandler</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPMainWPAPIManager.html" class="">MainWPMainWPAPIManager</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWP.html" class="">MainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWP-Dashboard.html" class="">Dashboard</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardMainWPsitesclientlist.html" class="">DashboardMainWPsitesclientlist</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardThisclasshandlesthe.html" class="">DashboardThisclasshandlesthe</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardMainWPsitesmonitoringlist.html" class="">DashboardMainWPsitesmonitoringlist</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardCheckforpremiumpluginupdates.html" class="">DashboardCheckforpremiumpluginupdates</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSettings.html" class="">MainWPSettings</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPBackups.html" class="">MainWPBackups</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPBackups-Continue.html" class="">Continue</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPBootstrap.html" class="">MainWPBootstrap</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPUpdates.html" class="">MainWPUpdates</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPUpdates-Check.html" class="">Check</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPUpdates-Overview.html" class="">Overview</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPPingChilds.html" class="">MainWPPingChilds</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPStats.html" class="">MainWPStats</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPExtensions.html" class="">MainWPExtensions</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSecurtiy.html" class="">MainWPSecurtiy</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSecurtiy-Issues.html" class="">Issues</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSetup.html" class="">MainWPSetup</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSetup-Wizard.html" class="">Wizard</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSite.html" class="">MainWPSite</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSite-Open.html" class="">Open</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPThemes.html" class="">MainWPThemes</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPUser.html" class="">MainWPUser</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPWidget.html" class="">MainWPWidget</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPWidget-Mainwp.html" class="">Mainwp</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPWidget-Recent.html" class="">Recent</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPPlugins.html" class="">MainWPPlugins</a>
|
|
</h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -reports">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -indices">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
</section>
|
|
</aside>
|
|
|
|
<div class="phpdocumentor-column -nine phpdocumentor-content">
|
|
<section>
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
MainWP_Rest_Global_Batch_Controller
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <a href="classes/MainWP-REST-Controller.html"><abbr title="\MainWP_REST_Controller">MainWP_REST_Controller</abbr></a>
|
|
</span>
|
|
|
|
<div class="phpdocumentor-element__package">
|
|
in package
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP.html">MainWP</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP-Dashboard.html">Dashboard</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</h2>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
|
|
|
|
</div>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">15</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.15" class="phpdocumentor-element-found-in__source" data-line="15" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Class MainWP_Rest_Global_Batch_Controller</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-properties">
|
|
Properties
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#property_controller_names">$controller_names</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Route base.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#property_namespace">$namespace</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Endpoint namespace.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#property_rest_base">$rest_base</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Route base.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#property__fields">$_fields</a>
|
|
<span>
|
|
: null|array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Used to cache computed return fields.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#property__request">$_request</a>
|
|
<span>
|
|
: null|<abbr title="\WP_REST_Request">WP_REST_Request</abbr> </span>
|
|
</dt>
|
|
<dd>Used to verify if cached fields are for correct request object.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#property_instance">$instance</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Protected static variable to hold the single instance of the class.</dd>
|
|
|
|
</dl>
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#method_batch_items">batch_items()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Bulk create, update and delete items.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_filter_response_data_by_allowed_fields">filter_response_data_by_allowed_fields()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Gets an array of fields to be included on the response.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_allowed_fields_by_context">get_allowed_fields_by_context()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Gets an array of fields to be included on the response.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_client_by">get_client_by()</a>
|
|
<span>
|
|
: array<string|int, mixed>|mixed </span>
|
|
</dt>
|
|
<dd>Get site by.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_collection_params">get_collection_params()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Get the query params for collections of attachments.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_endpoint_args_for_item_schema">get_endpoint_args_for_item_schema()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Compatibility functions for WP 5.5, since custom types are not supported anymore.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_fields_for_response">get_fields_for_response()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Gets an array of fields to be included on the response.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_item_response">get_item_response()</a>
|
|
<span>
|
|
: array<string|int, mixed>|<abbr title="\stdClass">stdClass</abbr> </span>
|
|
</dt>
|
|
<dd>Returns the full item response.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_item_schema">get_item_schema()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Returns the full item schema.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_properties">get_properties()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Return schema properties.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_public_batch_schema">get_public_batch_schema()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Get the batch schema, conforming to JSON Schema.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_rest_api_user">get_rest_api_user()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Method get_rest_api_user().</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_rest_data_error">get_rest_data_error()</a>
|
|
<span>
|
|
: <abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Get route error.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_rest_permissions_check">get_rest_permissions_check()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check rest permissions callback.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_site_by">get_site_by()</a>
|
|
<span>
|
|
: array<string|int, mixed>|mixed </span>
|
|
</dt>
|
|
<dd>Get site by.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_site_item">get_site_item()</a>
|
|
<span>
|
|
: <abbr title="\WP_Error">WP_Error</abbr>|object </span>
|
|
</dt>
|
|
<dd>Get site item by id or domain.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_validate_args_params">get_validate_args_params()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Method get_validate_args_params().</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#method_instance">instance()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Method instance()</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_parent_get_endpoint_args_for_item_schema">parent_get_endpoint_args_for_item_schema()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Retrieves an array of endpoint arguments from the item schema for the controller.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#method_register_routes">register_routes()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Method register_routes()</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_sanitize_request_slugs">sanitize_request_slugs()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Method sanitize_request_slugs().</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_rest_args">validate_rest_args()</a>
|
|
<span>
|
|
: <abbr title="\WP_Error">WP_Error</abbr>|<abbr title="\WP_REST_Response">WP_REST_Response</abbr> </span>
|
|
</dt>
|
|
<dd>Method validate_get_items_args().</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_checkbox_field">validate_setting_checkbox_field()</a>
|
|
<span>
|
|
: string|<abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Validate checkbox based settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_image_width_field">validate_setting_image_width_field()</a>
|
|
<span>
|
|
: string|<abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Validate image_width based settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_multiselect_field">validate_setting_multiselect_field()</a>
|
|
<span>
|
|
: array<string|int, mixed>|<abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Validate multiselect based settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_radio_field">validate_setting_radio_field()</a>
|
|
<span>
|
|
: string|<abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Validate radio based settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_select_field">validate_setting_select_field()</a>
|
|
<span>
|
|
: string|<abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Validate select based settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_text_field">validate_setting_text_field()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Validate a text value for a text based setting.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_validate_setting_textarea_field">validate_setting_textarea_field()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Validate textarea based settings.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_add_additional_fields_schema">add_additional_fields_schema()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Add the schema from additional fields to an schema array.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/MainWP-Rest-Global-Batch-Controller.html#method_check_batch_limit">check_batch_limit()</a>
|
|
<span>
|
|
: bool|<abbr title="\WP_Error">WP_Error</abbr> </span>
|
|
</dt>
|
|
<dd>Check batch limit.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_get_normalized_rest_base">get_normalized_rest_base()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get normalized rest base.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_prepare_objects_query">prepare_objects_query()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Prepare objects query.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/MainWP-REST-Controller.html#method_remove_arg_options">remove_arg_options()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Recursive removal of arg_options.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_controller_names">
|
|
$controller_names
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_controller_names" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">43</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.43" class="phpdocumentor-element-found-in__source" data-line="43" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Route base.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$controller_names</span>
|
|
= <span class="phpdocumentor-signature__default-value">array('sites', 'clients', 'updates', 'costs', 'tags')</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_namespace">
|
|
$namespace
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_namespace" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">29</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.29" class="phpdocumentor-element-found-in__source" data-line="29" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Endpoint namespace.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$namespace</span>
|
|
= <span class="phpdocumentor-signature__default-value">'mainwp/v2'</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_rest_base">
|
|
$rest_base
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_rest_base" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.36" class="phpdocumentor-element-found-in__source" data-line="36" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Route base.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$rest_base</span>
|
|
= <span class="phpdocumentor-signature__default-value">'batch'</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property__fields">
|
|
$_fields
|
|
<a href="classes/MainWP-REST-Controller.html#property__fields" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">54</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.54" class="phpdocumentor-element-found-in__source" data-line="54" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Used to cache computed return fields.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">null|array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$_fields</span>
|
|
= <span class="phpdocumentor-signature__default-value">\null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property__request">
|
|
$_request
|
|
<a href="classes/MainWP-REST-Controller.html#property__request" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">61</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.61" class="phpdocumentor-element-found-in__source" data-line="61" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Used to verify if cached fields are for correct request object.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">null|<abbr title="\WP_REST_Request">WP_REST_Request</abbr></span>
|
|
<span class="phpdocumentor-signature__name">$_request</span>
|
|
= <span class="phpdocumentor-signature__default-value">\null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_instance">
|
|
$instance
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_instance" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">22</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.22" class="phpdocumentor-element-found-in__source" data-line="22" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Protected static variable to hold the single instance of the class.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">$instance</span>
|
|
= <span class="phpdocumentor-signature__default-value">\null</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Default null</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_batch_items">
|
|
batch_items()
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_batch_items" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">86</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.86" class="phpdocumentor-element-found-in__source" data-line="86" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Bulk create, update and delete items.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">batch_items</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$request</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Full details about the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Of WP_Error or WP_REST_Response.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_filter_response_data_by_allowed_fields">
|
|
filter_response_data_by_allowed_fields()
|
|
<a href="classes/MainWP-REST-Controller.html#method_filter_response_data_by_allowed_fields" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1241</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1241" class="phpdocumentor-element-found-in__source" data-line="1241" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets an array of fields to be included on the response.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">filter_response_data_by_allowed_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$context</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'view'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Included fields are based on item schema and <code class="prettyprint">_fields=</code> request argument.
|
|
Updated from WordPress 5.3, included into this class to support old versions.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$item</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>data.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$context</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">'view'</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>fields to filter.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Fields to be included in the response.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_allowed_fields_by_context">
|
|
get_allowed_fields_by_context()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_allowed_fields_by_context" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1277</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1277" class="phpdocumentor-element-found-in__source" data-line="1277" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets an array of fields to be included on the response.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_allowed_fields_by_context</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$context</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Included fields are based on item schema and <code class="prettyprint">_fields=</code> request argument.
|
|
Updated from WordPress 5.3, included into this class to support old versions.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$context</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>context.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_allowed_fields_by_context#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Fields to be included in the response.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_client_by">
|
|
get_client_by()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_client_by" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">113</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get site by.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_client_by</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$by</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$by</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Get by.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Site id or domain.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$args</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>args.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Response data, ready for insertion into collection data.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_collection_params">
|
|
get_collection_params()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_collection_params" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1319</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1319" class="phpdocumentor-element-found-in__source" data-line="1319" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the query params for collections of attachments.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_collection_params</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_endpoint_args_for_item_schema">
|
|
get_endpoint_args_for_item_schema()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_endpoint_args_for_item_schema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">134</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.134" class="phpdocumentor-element-found-in__source" data-line="134" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Compatibility functions for WP 5.5, since custom types are not supported anymore.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_endpoint_args_for_item_schema</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">WP_REST_Server::CREATABLE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>See @link https://core.trac.wordpress.org/changeset/48306</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$method</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">WP_REST_Server::CREATABLE</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Optional. HTTP method of the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Endpoint arguments.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_fields_for_response">
|
|
get_fields_for_response()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_fields_for_response" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1113</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1113" class="phpdocumentor-element-found-in__source" data-line="1113" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets an array of fields to be included on the response.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_fields_for_response</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Included fields are based on item schema and <code class="prettyprint">_fields=</code> request argument.
|
|
Updated from WordPress 5.3, included into this class to support old versions.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$request</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Full details about the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_fields_for_response#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Fields to be included in the response.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_item_response">
|
|
get_item_response()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_item_response" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1194</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1194" class="phpdocumentor-element-found-in__source" data-line="1194" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the full item response.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_item_response</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|<abbr title="\stdClass">stdClass</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$item</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Item to get response for.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|<abbr title="\stdClass">stdClass</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_item_schema">
|
|
get_item_schema()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_item_schema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1178</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1178" class="phpdocumentor-element-found-in__source" data-line="1178" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the full item schema.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_item_schema</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_properties">
|
|
get_properties()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1203</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1203" class="phpdocumentor-element-found-in__source" data-line="1203" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Return schema properties.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_properties</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_public_batch_schema">
|
|
get_public_batch_schema()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_public_batch_schema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1028</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1028" class="phpdocumentor-element-found-in__source" data-line="1028" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the batch schema, conforming to JSON Schema.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_public_batch_schema</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_rest_api_user">
|
|
get_rest_api_user()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_rest_api_user" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1310</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1310" class="phpdocumentor-element-found-in__source" data-line="1310" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method get_rest_api_user().</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_rest_api_user</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_rest_data_error">
|
|
get_rest_data_error()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_rest_data_error" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1215</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1215" class="phpdocumentor-element-found-in__source" data-line="1215" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get route error.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_rest_data_error</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type_slug</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'object'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$type_slug</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Type slug.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">'object'</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>'object'.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_rest_permissions_check">
|
|
get_rest_permissions_check()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_rest_permissions_check" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1297</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1297" class="phpdocumentor-element-found-in__source" data-line="1297" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check rest permissions callback.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_rest_permissions_check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$request</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Full details about the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_site_by">
|
|
get_site_by()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_site_by" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">430</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.430" class="phpdocumentor-element-found-in__source" data-line="430" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get site by.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_site_by</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$by</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$by</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Get by.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Site id or domain.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$args</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>args.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Response data, ready for insertion into collection data.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_site_item">
|
|
get_site_item()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_site_item" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">86</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.86" class="phpdocumentor-element-found-in__source" data-line="86" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get site item by id or domain.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_site_item</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\WP_Error">WP_Error</abbr>|object</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$request</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Full details about the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\WP_Error">WP_Error</abbr>|object</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Item.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_validate_args_params">
|
|
get_validate_args_params()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_validate_args_params" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">266</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.266" class="phpdocumentor-element-found-in__source" data-line="266" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method get_validate_args_params().</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_validate_args_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$slug</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$slug</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>to validate args.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>validate args info.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_instance">
|
|
instance()
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_instance" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">53</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.53" class="phpdocumentor-element-found-in__source" data-line="53" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method instance()</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">instance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Create public static instance.</p>
|
|
</section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_instance#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">static</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">@return</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>static::$instance</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_parent_get_endpoint_args_for_item_schema">
|
|
parent_get_endpoint_args_for_item_schema()
|
|
<a href="classes/MainWP-REST-Controller.html#method_parent_get_endpoint_args_for_item_schema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">152</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.152" class="phpdocumentor-element-found-in__source" data-line="152" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Retrieves an array of endpoint arguments from the item schema for the controller.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">parent_get_endpoint_args_for_item_schema</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">WP_REST_Server::CREATABLE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$method</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">WP_REST_Server::CREATABLE</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Optional. HTTP method of the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_parent_get_endpoint_args_for_item_schema#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\rest_get_endpoint_args_for_schema()">rest_get_endpoint_args_for_schema()</abbr></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Endpoint arguments.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_register_routes">
|
|
register_routes()
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_register_routes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">66</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.66" class="phpdocumentor-element-found-in__source" data-line="66" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method register_routes()</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">register_routes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Creates the necessary endpoints for the api.
|
|
Note, for a request to be successful the URL query parameters consumer_key and consumer_secret need to be set and correct.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_sanitize_request_slugs">
|
|
sanitize_request_slugs()
|
|
<a href="classes/MainWP-REST-Controller.html#method_sanitize_request_slugs" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1399</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1399" class="phpdocumentor-element-found-in__source" data-line="1399" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method sanitize_request_slugs().</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">sanitize_request_slugs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$slugs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$slugs</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>slugs.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_rest_args">
|
|
validate_rest_args()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_rest_args" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">300</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.300" class="phpdocumentor-element-found-in__source" data-line="300" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method validate_get_items_args().</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_rest_args</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$args</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$valid_args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\WP_Error">WP_Error</abbr>|<abbr title="\WP_REST_Response">WP_REST_Response</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$args</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>args request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$valid_args</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Valid args array.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\WP_Error">WP_Error</abbr>|<abbr title="\WP_REST_Response">WP_REST_Response</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_checkbox_field">
|
|
validate_setting_checkbox_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_checkbox_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">986</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.986" class="phpdocumentor-element-found-in__source" data-line="986" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate checkbox based settings.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_checkbox_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Value.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_checkbox_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_image_width_field">
|
|
validate_setting_image_width_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_image_width_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">948</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.948" class="phpdocumentor-element-found-in__source" data-line="948" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate image_width based settings.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_image_width_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$values</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Values.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_image_width_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_multiselect_field">
|
|
validate_setting_multiselect_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_multiselect_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">921</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.921" class="phpdocumentor-element-found-in__source" data-line="921" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate multiselect based settings.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_multiselect_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|<abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$values</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Values.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_multiselect_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|<abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_radio_field">
|
|
validate_setting_radio_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_radio_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">974</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.974" class="phpdocumentor-element-found-in__source" data-line="974" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate radio based settings.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_radio_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Value.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_radio_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_select_field">
|
|
validate_setting_select_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_select_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">905</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.905" class="phpdocumentor-element-found-in__source" data-line="905" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate select based settings.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_select_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Value.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_select_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|<abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_text_field">
|
|
validate_setting_text_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_text_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">892</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.892" class="phpdocumentor-element-found-in__source" data-line="892" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate a text value for a text based setting.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_text_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Value.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_text_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_validate_setting_textarea_field">
|
|
validate_setting_textarea_field()
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_textarea_field" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1004</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.1004" class="phpdocumentor-element-found-in__source" data-line="1004" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Validate textarea based settings.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">validate_setting_textarea_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$setting</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Value.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$setting</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Setting.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_validate_setting_textarea_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_additional_fields_schema">
|
|
add_additional_fields_schema()
|
|
<a href="classes/MainWP-REST-Controller.html#method_add_additional_fields_schema" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">73</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.73" class="phpdocumentor-element-found-in__source" data-line="73" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add the schema from additional fields to an schema array.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">add_additional_fields_schema</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$schema</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>The type of object is inferred from the passed schema.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$schema</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Schema array.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_check_batch_limit">
|
|
check_batch_limit()
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_check_batch_limit" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-global-batch-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php">class-mainwp-rest-global-batch-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">477</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.477" class="phpdocumentor-element-found-in__source" data-line="477" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check batch limit.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">check_batch_limit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$items</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|<abbr title="\WP_Error">WP_Error</abbr></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$items</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Request items.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool|<abbr title="\WP_Error">WP_Error</abbr></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_normalized_rest_base">
|
|
get_normalized_rest_base()
|
|
<a href="classes/MainWP-REST-Controller.html#method_get_normalized_rest_base" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">185</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.185" class="phpdocumentor-element-found-in__source" data-line="185" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get normalized rest base.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">get_normalized_rest_base</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_prepare_objects_query">
|
|
prepare_objects_query()
|
|
<a href="classes/MainWP-REST-Controller.html#method_prepare_objects_query" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">348</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.348" class="phpdocumentor-element-found-in__source" data-line="348" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Prepare objects query.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">prepare_objects_query</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'object'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$request</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\WP_REST_Request">WP_REST_Request</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Full details about the request.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">'object'</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Object type.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/MainWP-REST-Controller.html#method_prepare_objects_query#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_remove_arg_options">
|
|
remove_arg_options()
|
|
<a href="classes/MainWP-REST-Controller.html#method_remove_arg_options" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php"><a href="files/includes-rest-api-controller-version2-class-mainwp-rest-controller.html"><abbr title="includes/rest-api/controller/version2/class-mainwp-rest-controller.php">class-mainwp-rest-controller.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">164</span>
|
|
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#source-view.164" class="phpdocumentor-element-found-in__source" data-line="164" data-modal="source-view" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-controller.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Recursive removal of arg_options.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">remove_arg_options</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$properties</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$properties</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Schema properties.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<div class="phpdocumentor-modal" id="source-view">
|
|
<div class="phpdocumentor-modal-bg" data-exit-button></div>
|
|
<div class="phpdocumentor-modal-container">
|
|
<div class="phpdocumentor-modal-content">
|
|
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/includes/rest-api/controller/version2/class-mainwp-rest-global-batch-controller.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
|
</div>
|
|
<button data-exit-button class="phpdocumentor-modal__close">×</button>
|
|
</div>
|
|
</div>
|
|
|
|
<script type="text/javascript">
|
|
(function () {
|
|
function loadExternalCodeSnippet(el, url, line) {
|
|
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
|
|
const language = 'php';
|
|
|
|
const code = document.createElement('code');
|
|
code.className = 'language-' + language;
|
|
pre.textContent = '';
|
|
pre.setAttribute('data-line', line)
|
|
code.textContent = 'Loading…';
|
|
pre.appendChild(code);
|
|
|
|
var xhr = new XMLHttpRequest();
|
|
|
|
xhr.open('GET', src, true);
|
|
|
|
xhr.onreadystatechange = function () {
|
|
if (xhr.readyState !== 4) {
|
|
return;
|
|
}
|
|
|
|
if (xhr.status < 400 && xhr.responseText) {
|
|
code.textContent = xhr.responseText;
|
|
Prism.highlightElement(code);
|
|
return;
|
|
}
|
|
|
|
if (xhr.status === 404) {
|
|
code.textContent = '✖ Error: File could not be found';
|
|
return;
|
|
}
|
|
|
|
if (xhr.status >= 400) {
|
|
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
return;
|
|
}
|
|
|
|
code.textContent = '✖ Error: An unknown error occurred';
|
|
};
|
|
|
|
xhr.send(null);
|
|
});
|
|
}
|
|
|
|
const modalButtons = document.querySelectorAll("[data-modal]");
|
|
const openedAsLocalFile = window.location.protocol === 'file:';
|
|
if (modalButtons.length > 0 && openedAsLocalFile) {
|
|
console.warn(
|
|
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
|
|
'browsers block XHR requests when a page is opened this way'
|
|
);
|
|
}
|
|
|
|
modalButtons.forEach(function (trigger) {
|
|
if (openedAsLocalFile) {
|
|
trigger.setAttribute("hidden", "hidden");
|
|
}
|
|
|
|
trigger.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
const modal = document.getElementById(trigger.dataset.modal);
|
|
if (!modal) {
|
|
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
|
|
return;
|
|
}
|
|
modal.classList.add("phpdocumentor-modal__open");
|
|
|
|
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
|
|
const exits = modal.querySelectorAll("[data-exit-button]");
|
|
exits.forEach(function (exit) {
|
|
exit.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
modal.classList.remove("phpdocumentor-modal__open");
|
|
});
|
|
});
|
|
});
|
|
});
|
|
})();
|
|
</script>
|
|
|
|
</article>
|
|
</section>
|
|
<section class="phpdocumentor-on-this-page__sidebar">
|
|
|
|
<section class="phpdocumentor-on-this-page__content">
|
|
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
|
|
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/MainWP-Rest-Global-Batch-Controller.html#toc-properties">Properties</a></li>
|
|
<li><a href="classes/MainWP-Rest-Global-Batch-Controller.html#toc-methods">Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_controller_names">$controller_names</a></li>
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_namespace">$namespace</a></li>
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_rest_base">$rest_base</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#property__fields">$_fields</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#property__request">$_request</a></li>
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#property_instance">$instance</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_batch_items">batch_items()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_filter_response_data_by_allowed_fields">filter_response_data_by_allowed_fields()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_allowed_fields_by_context">get_allowed_fields_by_context()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_client_by">get_client_by()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_collection_params">get_collection_params()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_endpoint_args_for_item_schema">get_endpoint_args_for_item_schema()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_fields_for_response">get_fields_for_response()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_item_response">get_item_response()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_item_schema">get_item_schema()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_properties">get_properties()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_public_batch_schema">get_public_batch_schema()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_rest_api_user">get_rest_api_user()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_rest_data_error">get_rest_data_error()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_rest_permissions_check">get_rest_permissions_check()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_site_by">get_site_by()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_site_item">get_site_item()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_validate_args_params">get_validate_args_params()</a></li>
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_instance">instance()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_parent_get_endpoint_args_for_item_schema">parent_get_endpoint_args_for_item_schema()</a></li>
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_register_routes">register_routes()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_sanitize_request_slugs">sanitize_request_slugs()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_rest_args">validate_rest_args()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_checkbox_field">validate_setting_checkbox_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_image_width_field">validate_setting_image_width_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_multiselect_field">validate_setting_multiselect_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_radio_field">validate_setting_radio_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_select_field">validate_setting_select_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_text_field">validate_setting_text_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_validate_setting_textarea_field">validate_setting_textarea_field()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_add_additional_fields_schema">add_additional_fields_schema()</a></li>
|
|
<li class=""><a href="classes/MainWP-Rest-Global-Batch-Controller.html#method_check_batch_limit">check_batch_limit()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_get_normalized_rest_base">get_normalized_rest_base()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_prepare_objects_query">prepare_objects_query()</a></li>
|
|
<li class=""><a href="classes/MainWP-REST-Controller.html#method_remove_arg_options">remove_arg_options()</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
|
|
</section>
|
|
</div>
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
<header class="phpdocumentor-search-results__header">
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
</header>
|
|
<section class="phpdocumentor-search-results__body">
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<a href="classes/MainWP-Rest-Global-Batch-Controller.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|
