Automatisation
AutomatisationWP-Cron

WP-Cron

Les action hooks suivants sont fournis, pour être invoqués depuis WP-Cron :

gatographql__execute_query

Ce hook reçoit les paramètres suivants (dans cet ordre) :

#Obligatoire ?ParamètreDescription
1$queryLa requête GraphQL à exécuter
2$variablesVariables GraphQL
3$operationNameLe nom de l'opération à exécuter
4$executeAsUserL'utilisateur avec lequel se connecter pour exécuter la requête
5$schemaConfigurationIDOrSlugL'ID (comme int) ou le slug (comme string) de la configuration du schéma à appliquer lors de l'exécution de la requête. Passer null utilisera la valeur par défaut, et passer -1 signifie « n'utiliser aucune configuration de schéma »

Le paramètre $executeAsUser est nécessaire si la requête exige que l'utilisateur soit connecté, par exemple lors de l'exécution d'une mutation :

  • S'il est fourni, l'utilisateur avec l'ID donné (comme int) ou le nom d'utilisateur (comme string) se connectera juste avant l'exécution de la requête GraphQL, et se déconnectera immédiatement après.
  • S'il n'est pas fourni, aucun utilisateur ne sera connecté lors de l'exécution de la requête.

gatographql__execute_persisted_query

Ce hook reçoit les paramètres suivants (dans cet ordre) :

#Obligatoire ?ParamètreDescription
1$persistedQueryIDOrSlugL'ID (comme int) ou le slug (comme string) de la Persisted Query
2$variablesVariables GraphQL
3$operationNameLe nom de l'opération à exécuter
4$executeAsUserL'utilisateur avec lequel se connecter pour exécuter la requête

Notez que la configuration du schéma à appliquer est déjà sélectionnée dans la persisted query.

Exemples

L'événement WP-Cron suivant exécute le hook gatographql__execute_persisted_query pour envoyer un e-mail quotidien indiquant le nombre de nouveaux commentaires ajoutés au site :

  • Dans les dernières 24 heures
  • Dans la dernière année
  • Depuis le début du mois
  • Depuis le début de l'année

Nous créons une Persisted Query avec le slug "daily-stats-by-email-number-of-comments" et le contenu :

query CountComments {
  DATE_ISO8601: _env(name: DATE_ISO8601) @remove
 
  timeToday: _time
  dateToday: _date(format: $__DATE_ISO8601, timestamp: $__timeToday)
  
  timeYesterday: _intSubtract(subtract: 86400, from: $__timeToday)
  dateYesterday: _date(format: $__DATE_ISO8601, timestamp: $__timeYesterday)
  
  time1YearAgo: _intSubtract(subtract: 31536000, from: $__timeToday)
  date1YearAgo: _date(format: $__DATE_ISO8601, timestamp: $__time1YearAgo)
 
  timeBegOfThisMonth: _makeTime(hour: 0, minute: 0, second: 0, day: 1)
  dateBegOfThisMonth: _date(format: $__DATE_ISO8601, timestamp: $__timeBegOfThisMonth)
 
  timeBegOfThisYear: _makeTime(hour: 0, minute: 0, second: 0, month: 1, day: 1)
  dateBegOfThisYear: _date(format: $__DATE_ISO8601, timestamp: $__timeBegOfThisYear)
  
  commentsAddedInLast24Hs: commentCount(filter: { dateQuery: { after: $__dateYesterday } } )
    @export(as: "commentsAddedInLast24Hs")
  commentsAddedInLast1Year: commentCount(filter: { dateQuery: { after: $__date1YearAgo } } )
    @export(as: "commentsAddedInLast1Year")
  commentsAddedSinceBegOfThisMonth: commentCount(filter: { dateQuery: { after: $__dateBegOfThisMonth } } )
    @export(as: "commentsAddedSinceBegOfThisMonth")
  commentsAddedSinceBegOfThisYear: commentCount(filter: { dateQuery: { after: $__dateBegOfThisYear } } )
    @export(as: "commentsAddedSinceBegOfThisYear")
}
 
query CreateEmailMessage @depends(on: "CountComments") {
  emailMessageTemplate: _strConvertMarkdownToHTML(
    text: """
 
This is the number of comments added to the site:
 
| Period | # Comments added |
| --- | --- |
| **In the last 24 hs**: | {$commentsAddedInLast24Hs} |
| **In the last 365 days**: | {$commentsAddedInLast1Year} |
| **Since begginning of this month**: | {$commentsAddedSinceBegOfThisMonth} |
| **Since begginning of this year**: | {$commentsAddedSinceBegOfThisYear} |
 
    """
  )
  emailMessage: _strReplaceMultiple(
    search: [
      "{$commentsAddedInLast24Hs}",
      "{$commentsAddedInLast1Year}",
      "{$commentsAddedSinceBegOfThisMonth}",
      "{$commentsAddedSinceBegOfThisYear}"
    ],
    replaceWith: [
      $commentsAddedInLast24Hs,
      $commentsAddedInLast1Year,
      $commentsAddedSinceBegOfThisMonth,
      $commentsAddedSinceBegOfThisYear
    ],
    in: $__emailMessageTemplate
  )
    @export(as: "emailMessage")
}
 
mutation SendDailyStatsByEmailNumberOfComments(
  $to: [String!]!
)
  @depends(on: "CreateEmailMessage")
{
  _sendEmail(
    input: {
      to: $to
      subject: "Daily stats: Number of new comments"
      messageAs: {
        html: $emailMessage
      }
    }
  ) {
    status
  }
}

Ensuite, nous planifions l'événement WP-Cron, soit via PHP :

\wp_schedule_event(
  time(),
  'daily',
  'gatographql__execute_persisted_query',
  [
    'daily-stats-by-email-number-of-comments',
    [
      'to' => ['admin@yoursite.com']
    ],
    'SendDailyStatsByEmailNumberOfComments',
    1 // This is the admin user's ID
  ]
);

Ou via le plugin WP-Crontrol :

  • Type d'événement : Standard cron event
  • Nom du hook : gatographql__execute_persisted_query
  • Arguments : ["daily-stats-by-email-number-of-comments",{"to":["admin@yoursite.com"]},"SendDailyStatsByEmailNumberOfComments",1]
  • Récurrence : Once Daily

Nouvelle entrée dans WP-Crontrol