Changeset 36021 for trunk/src/wp-includes/compat.php

Timestamp:

12/19/2015 05:10:29 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing DocBlocks for hash_hmac() and _hash_hmac().

Both will be ignored from parsing as and serve as compat functions for PHP's hash_hmac().

Introduced in [18111].

See #32246.

File:

• trunk/src/wp-includes/compat.php (modified) (2 diffs)

trunk/src/wp-includes/compat.php

@@ -218 +218 @@
 
 if ( !function_exists('hash_hmac') ):
+/**
+ * Compat function to mimic hash_hmac().
+ *
+ * @ignore
+ * @since 3.2.0
+ *
+ * @see _hash_hmac()
+ *
+ * @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
+ * @param string $data       Data to be hashed.
+ * @param string $key        Secret key to use for generating the hash.
+ * @param bool   $raw_output Optional. Whether to output raw binary data (true),
+ *                           or lowercase hexits (false). Default false.
+ * @return string|false The hash in output determined by `$raw_output`. False if `$algo`
+ *                      is unknown or invalid.
+ */
 function hash_hmac($algo, $data, $key, $raw_output = false) {
     return _hash_hmac($algo, $data, $key, $raw_output);
@@ -223 +239 @@
 endif;
 
+/**
+ * Internal compat function to mimic hash_hmac().
+ *
+ * @ignore
+ * @since 3.2.0
+ *
+ * @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
+ * @param string $data       Data to be hashed.
+ * @param string $key        Secret key to use for generating the hash.
+ * @param bool   $raw_output Optional. Whether to output raw binary data (true),
+ *                           or lowercase hexits (false). Default false.
+ * @return string|false The hash in output determined by `$raw_output`. False if `$algo`
+ *                      is unknown or invalid.
+ */
 function _hash_hmac($algo, $data, $key, $raw_output = false) {
     $packs = array('md5' => 'H32', 'sha1' => 'H40');