Changeset 3059

Timestamp:

05/02/2016 04:16:25 PM (8 years ago)

Author:

ocean90

Message:

Translate: Improve documentation of the jobs endpoint and allow only hooks which are prefixed with wporg_translate_.

See #1636.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/endpoints/class-jobs-controller.php (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/rest-api/endpoints/class-jobs-controller.php

@@ -24 +24 @@
                 'args'                => [
                     'timestamp'  => [
+                        'description'       => 'Timestamp for when to run the job.',
                         'required'          => true,
                         'sanitize_callback' => 'absint',
@@ -29 +30 @@
                     ],
                     'recurrence' => [
+                        'description'       => 'How often the job should rerun.',
                         'required'          => true,
+                        'enum'              => array_merge( [ 'once' ], array_keys( wp_get_schedules() ) ),
                         'sanitize_callback' => 'sanitize_text_field',
                         'validate_callback' => [ $this, 'validate_recurrence' ],
                     ],
                     'hook'       => [
+                        'description'       => 'Action hook to execute when cron is run. Must be prefixed with `wporg_translate_`.',
                         'required'          => true,
                         'sanitize_callback' => 'sanitize_text_field',
+                        'validate_callback' => [ $this, 'validate_hook' ],
                     ],
                     'args'       => [
-                        'default' => [],
+                        'description'       => 'Arguments to pass to the hook\'s callback function.',
+                        'default'           => [],
                         'validate_callback' => [ $this, 'validate_args' ],
                     ],
@@ -49 +55 @@
                 'args'                => [
                     'timestamp'  => [
+                        'description'       => 'Timestamp for the next run of the job.',
                         'required'          => true,
                         'sanitize_callback' => 'absint',
@@ -54 +61 @@
                     ],
                     'hook'       => [
+                        'description'       => 'Action hook to execute when cron is run. Must be prefixed with `wporg_translate_`.',
                         'required'          => true,
                         'sanitize_callback' => 'sanitize_text_field',
+                        'validate_callback' => [ $this, 'validate_hook' ],
                     ],
                     'args'       => [
-                        'default' => [],
+                        'description'       => 'Arguments to pass to the hook\'s callback function.',
+                        'default'           => [],
                         'validate_callback' => [ $this, 'validate_args' ],
                     ],
@@ -164 +174 @@
 
     /**
+     * Validates an action hook.
+     *
+     * @param string $hook The action hook to validate.
+     * @return bool True if valid, false if not.
+     */
+    public function validate_hook( $hook ) {
+        if ( 0 === strpos( $hook, 'wporg_translate_' ) ) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
      * Validates the args parameter for a job.
      *