Query-Auflösungsaktion

Wenn der GraphQL-Server eine Query auflöst, löst er die folgenden Action-Hooks mit der GraphQL-Antwort aus:

gatographql__executed_query:{$operationName} (nur wenn die auszuführende GraphQL-Operation angegeben wurde)
gatographql__executed_query

Die ausgelösten Action-Hooks sind:

// Triggered only if the GraphQL operation to execute was provided
do_action(
  "gatographql__executed_query:{$operationName}",
  $response,
  $isInternalExecution,
  $query,
  $variables,
);
 
// Triggered always
do_action(
  'gatographql__executed_query',
  $response,
  $isInternalExecution,
  $operationName,
  $query,
  $variables,
);

Die übergebenen Parameter sind:

$response: Ein Objekt der Klasse PoP\Root\HttpFoundation\Response, das die GraphQL-Antwort enthält (einschließlich Inhalt und Header)
$isInternalExecution: true, wenn die Query über den Internal GraphQL Server ausgeführt wurde (z. B. über die Klasse GatoGraphQL\InternalGraphQLServer\GraphQLServer), andernfalls false (z. B. über den Single-Endpoint)
$operationName: Ausgeführte GraphQL-Operation (nur für den zweiten Action-Hook; beim ersten ist sie implizit im Hook-Namen enthalten)
$query: Ausgeführte GraphQL-Query
$variables: Bereitgestellte GraphQL-Variablen

Beispiele

Dank des Internal GraphQL Server können wir auf die Auflösung einer GraphQL-Query reagieren (egal ob sie gegen den Internal GraphQL Server, den Single-Endpoint, einen Custom-Endpoint oder eine Persisted Query ausgeführt wird) und eine weitere GraphQL-Query gegen den Internal GraphQL Server ausführen.

Ein Beispiel-Workflow ist:

In die Ausführung einer GraphQL-Query einhaken, z. B. über ihren Operationsnamen (wie CreatePost)
Eine Benachrichtigung an den Administrator senden, indem die Mutation _sendEmail über GatoGraphQL\InternalGraphQLServer\GraphQLServer::executeQuery ausgeführt wird

Dieser PHP-Code verkettet 2 GraphQL-Query-Ausführungen:

GraphQLServer::executeQuery(
  <<<GRAPHQL
    mutation CreatePost(
      \$postTitle: String!,
      \$postContent: String!
    ) {
      createPost(input: {
        title: \$postTitle
        contentAs: { html: \$postContent }
      }) {
        status
        errors {
          __typename
          ...on ErrorPayload {
            message
          }
        }
        postID
      }
    }
  GRAPHQL,
  [
    'postTitle' => 'New post',
    'postContent' => 'Some content',
  ],
  'CreatePost'
);
 
add_action(
  "gatographql__executed_query:CreatePost",
  function (Response $response) {
    /** @var string */
    $responseContent = $response->getContent();
    /** @var array<string,mixed> */
    $responseJSON = json_decode($responseContent, true);
    $postID = $responseJSON['data']['createPost']['postID'] ?? null;
    if ($postID === null) {
      // Do nothing
      return;
    }
 
    $post = get_post($postID);
 
    // Execute the chained query!
    GraphQLServer::executeQuery(
      <<<GRAPHQL
        mutation SendEmail(
          \$emailSubject: String!
          \$emailMessage: String!
        ) {
          _sendEmail(
            input: {
              to: "admin@site.com"
              subject: \$emailSubject
              messageAs: {
                html: \$emailMessage
              }
            }
          ) {
            status
          }
        }
      GRAPHQL,
      [
        'emailSubject' => sprintf(__("New post: %s"), $post->post_title),
        'emailMessage' => $post->post_content,
      ]
    );
  }
);

​Beispiele

Beispiele