Function commonRequest

Parameters

• __namedParameters: {
      allowBatchRequest?:
          | boolean
          | Pick<
              {
                  restNamespace: string;
                  restNonce?: string;
                  restPathObfuscateOffset?: string;
                  restQuery?: object;
                  restRecreateNonceEndpoint?: string;
                  restRoot: string;
              } & {
                  onQueueItemFinished?: (state: boolean) => void;
                  signal?: AbortSignal;
                  waitForPromise?: Promise<void>;
              },
              "onQueueItemFinished"
              | "waitForPromise",
          >;
      multipart?: boolean | MultiPartOptions;
      params?: TParams;
      replayReason?: ReplayReason;
      request?: TRequest;
      sendReferer?: boolean;
      sendRestNonce?: boolean;
      settings?: Partial<{ -readonly [P in keyof Request]: Request[P] }>;
  } & UrlBuilderArgs

  • OptionalallowBatchRequest?:
        | boolean
        | Pick<
            {
                restNamespace: string;
                restNonce?: string;
                restPathObfuscateOffset?: string;
                restQuery?: object;
                restRecreateNonceEndpoint?: string;
                restRoot: string;
            } & {
                onQueueItemFinished?: (state: boolean) => void;
                signal?: AbortSignal;
                waitForPromise?: Promise<void>;
            },
            "onQueueItemFinished"
            | "waitForPromise",
        >

    See batchRequest for more information.

    See

    https://make.wordpress.org/core/2020/11/20/rest-api-batch-framework-in-wordpress-5-6/

  • Optionalmultipart?: boolean | MultiPartOptions

  • Optionalparams?: TParams

  • OptionalreplayReason?: ReplayReason

  • Optionalrequest?: TRequest

  • OptionalsendReferer?: boolean

    Send the current URL as _wp_http_referer as URL parameter (for GET and DELETE) or body payload (for non-GET requests).

    See

    https://app.clickup.com/t/86954236z

  • OptionalsendRestNonce?: boolean

  • Optionalsettings?: Partial<{ -readonly [P in keyof Request]: Request[P] }>

    Settings for the window.fetch call.