Changeset 30673

Timestamp:

11/30/2014 10:55:08 PM (10 years ago)

Author:

wonderboymusic

Message:

Improve various @param docs.

See #30224.

Location:

trunk/src/wp-includes

Files:

• option.php (modified) (4 diffs)
• query.php (modified) (5 diffs)
• revision.php (modified) (2 diffs)
• taxonomy.php (modified) (2 diffs)

trunk/src/wp-includes/option.php

@@ -344 +344 @@
  * @since 1.0.0
  *
- * @param string $option Name of option to add. Expected to not be SQL-escaped.
- * @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
- * @param mixed $deprecated Optional. Description. Not used anymore.
- * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.
+ * @param string         $option      Name of option to add. Expected to not be SQL-escaped.
+ * @param mixed          $value       Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
+ * @param string         $deprecated  Optional. Description. Not used anymore.
+ * @param string|bool    $autoload    Optional. Default is enabled. Whether to load the option when WordPress starts up.
  * @return bool False if option was not added and true if option was added.
  */
@@ -776 +776 @@
  * @param string $name The name of the setting.
  * @param string $value The value for the setting.
- * @return bool true if set successfully/false if not.
+ * @return null|bool true if set successfully/false if not.
  */
 function set_user_setting( $name, $value ) {
@@ -798 +798 @@
  * @since 2.7.0
  *
- * @param mixed $names The name or array of names of the setting to be deleted.
- * @return bool true if deleted successfully/false if not.
+ * @param string $names The name or array of names of the setting to be deleted.
+ * @return null|bool true if deleted successfully/false if not.
  */
 function delete_user_setting( $names ) {
@@ -869 +869 @@
  *
  * @param array $user_settings
- * @return bool
+ * @return null|bool
  */
 function wp_set_all_user_settings( $user_settings ) {

trunk/src/wp-includes/query.php

@@ -177 +177 @@
  * @uses $wp_query
  *
- * @param mixed $attachment Attachment ID, title, slug, or array of such.
+ * @param int|string|array $attachment Attachment ID, title, slug, or array of such.
  * @return bool
  */
@@ -277 +277 @@
  * @uses $wp_query
  *
- * @param mixed $taxonomy Optional. Taxonomy slug or slugs.
- * @param mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs.
+ * @param string|array $taxonomy Optional. Taxonomy slug or slugs.
+ * @param int|string|array $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs.
  * @return bool
  */
@@ -2101 +2101 @@
      * @since 3.7.0
      *
-     * @param array Terms to check.
+     * @param array $terms Terms to check.
      * @return array Terms that are not stopwords.
      */
@@ -4541 +4541 @@
      * @since 4.1.0
      *
-     * @param object $post Post data.
+     * @param WP_Post $post Post data.
      * @return bool True when finished.
      */
@@ -4609 +4609 @@
      *
      * @since 3.7.0
-     *
-     * @return bool
      */
     public function reset_postdata() {

trunk/src/wp-includes/revision.php

@@ -439 +439 @@
  * @since 3.6.0
  *
- * @param object $post The post object.
+ * @param WP_Post $post The post object.
  * @return bool True if number of revisions to keep isn't zero, false otherwise.
  */
@@ -573 +573 @@
  * @access private
  *
- * @param object $post Post object
+ * @param WP_Post $post Post object
  * @param array $revisions Current revisions of the post
  * @return bool true if the revisions were upgraded, false if problems

trunk/src/wp-includes/taxonomy.php

@@ -820 +820 @@
      *
      * @param string $relation Raw relation key from the query argument.
-     * @return Sanitized relation ('AND' or 'OR').
+     * @return string Sanitized relation ('AND' or 'OR').
      */
     public function sanitize_relation( $relation ) {
@@ -3737 +3737 @@
  * @param string|array $object_ids Single or list of term object ID(s)
  * @param array|string $object_type The taxonomy object type
- * @return null|bool Null value is given with empty $object_ids. False if
+ * @return null|false Null value is given with empty $object_ids. False if
  */
 function update_object_term_cache($object_ids, $object_type) {