Docs: Miscellaneous DocBlock corrections. (7cc79943) · Commits · singing-chimes.co.uk / wordpress-core

wp-includes/bookmark.php

+3 −3

Original line number	Diff line number	Diff line
		@@ -14,9 +14,9 @@
		* @global wpdb $wpdb WordPress database abstraction object.
		*
		* @param int\|stdClass $bookmark
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond
		* to an stdClass object, an associative array, or a numeric array, respectively.
		* Default OBJECT.
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
		* correspond to an stdClass object, an associative array, or a numeric array,
		* respectively. Default OBJECT.
		* @param string $filter Optional. How to sanitize bookmark fields. Default 'raw'.
		* @return array\|object\|null Type returned depends on $output value.
		*/

wp-includes/category.php

+8 −8

Original line number	Diff line number	Diff line
		@@ -80,9 +80,9 @@ function get_categories( $args = '' ) {
		*
		* @since 1.5.1
		*
		* @param int\|object $category Category ID or Category row object
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,
		* which correspond to a WP_Term object, an associative array, or a numeric array,
		* @param int\|object $category Category ID or category row object.
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
		* correspond to a WP_Term object, an associative array, or a numeric array,
		* respectively. Default OBJECT.
		* @param string $filter Optional. How to sanitize category fields. Default 'raw'.
		* @return object\|array\|WP_Error\|null Category data in type defined by $output parameter.
		@@ -116,8 +116,8 @@ function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
		*
		* @param string $category_path URL containing category slugs.
		* @param bool $full_match Optional. Whether full path should be matched.
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,
		* which correspond to a WP_Term object, an associative array, or a numeric array,
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
		* correspond to a WP_Term object, an associative array, or a numeric array,
		* respectively. Default OBJECT.
		* @return WP_Term\|array\|WP_Error\|null Type is based on $output value.
		*/
		@@ -329,8 +329,8 @@ function get_tags( $args = '' ) {
		* @since 2.3.0
		*
		* @param int\|WP_Term\|object $tag A tag ID or object.
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,
		* which correspond to a WP_Term object, an associative array, or a numeric array,
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
		* correspond to a WP_Term object, an associative array, or a numeric array,
		* respectively. Default OBJECT.
		* @param string $filter Optional. How to sanitize tag fields. Default 'raw'.
		* @return WP_Term\|array\|WP_Error\|null Tag data in type defined by $output parameter.
		@@ -371,7 +371,7 @@ function clean_category_cache( $id ) {
		* @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
		* @access private
		*
		* @param array\|object\|WP_Term $category Category Row object or array
		* @param array\|object\|WP_Term $category Category row object or array.
		*/
		function _make_cat_compat( &$category ) {
		if ( is_object( $category ) && ! is_wp_error( $category ) ) {

wp-includes/class-wp-user.php

+13 −11

Original line number	Diff line number	Diff line
		@@ -56,8 +56,8 @@ class WP_User {
		* Capabilities that the individual user has been granted outside of those inherited from their role.
		*
		* @since 2.0.0
		* @var bool[] Array of key/value pairs where keys represent a capability name and boolean values
		* represent whether the user has that capability.
		* @var bool[] Array of key/value pairs where keys represent a capability name
		* and boolean values represent whether the user has that capability.
		*/
		public $caps = array();

		@@ -81,8 +81,8 @@ class WP_User {
		* All capabilities the user has, including individual and role based.
		*
		* @since 2.0.0
		* @var bool[] Array of key/value pairs where keys represent a capability name and boolean values
		* represent whether the user has that capability.
		* @var bool[] Array of key/value pairs where keys represent a capability name
		* and boolean values represent whether the user has that capability.
		*/
		public $allcaps = array();

		@@ -482,15 +482,17 @@ class WP_User {
		}

		/**
		* Retrieves all of the capabilities of the roles of the user, and merges them with individual user capabilities.
		* Retrieves all of the capabilities of the user's roles, and merges them with
		* individual user capabilities.
		*
		* All of the capabilities of the roles of the user are merged with the user's individual capabilities. This means
		* that the user can be denied specific capabilities that their role might have, but the user is specifically denied.
		* All of the capabilities of the user's roles are merged with the user's individual
		* capabilities. This means that the user can be denied specific capabilities that
		* their role might have, but the user is specifically denied.
		*
		* @since 2.0.0
		*
		* @return bool[] Array of key/value pairs where keys represent a capability name and boolean values
		* represent whether the user has that capability.
		* @return bool[] Array of key/value pairs where keys represent a capability name
		* and boolean values represent whether the user has that capability.
		*/
		public function get_role_caps() {
		$switch_site = false;
		@@ -766,8 +768,8 @@ class WP_User {
		* @since 2.0.0
		* @since 3.7.0 Added the `$user` parameter.
		*
		* @param bool[] $allcaps Array of key/value pairs where keys represent a capability name and boolean values
		* represent whether the user has that capability.
		* @param bool[] $allcaps Array of key/value pairs where keys represent a capability name
		* and boolean values represent whether the user has that capability.
		* @param string[] $caps Required primitive capabilities for the requested capability.
		* @param array $args {
		* Arguments that accompany the requested capability check.

wp-includes/comment.php

+3 −2

Original line number	Diff line number	Diff line
		@@ -187,8 +187,9 @@ function get_approved_comments( $post_id, $args = array() ) {
		* @global WP_Comment $comment Global comment object.
		*
		* @param WP_Comment\|string\|int $comment Comment to retrieve.
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
		* a WP_Comment object, an associative array, or a numeric array, respectively. Default OBJECT.
		* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
		* correspond to a WP_Comment object, an associative array, or a numeric array,
		* respectively. Default OBJECT.
		* @return WP_Comment\|array\|null Depends on $output value.
		*/
		function get_comment( &$comment = null, $output = OBJECT ) {

wp-includes/functions.php

+4 −4

Original line number	Diff line number	Diff line
		@@ -7524,10 +7524,10 @@ function get_dirsize( $directory, $max_execution_time = null ) {
		* @since 5.2.0 $max_execution_time parameter added.
		*
		* @param string $directory Full path of a directory.
		* @param string\|array $exclude Optional. Full path of a subdirectory to exclude from the total, or array of
		* paths. Expected without trailing slash(es).
		* @param int $max_execution_time Maximum time to run before giving up. In seconds.
		* The timeout is global and is measured from the moment WordPress started to load.
		* @param string\|array $exclude Optional. Full path of a subdirectory to exclude from the total,
		* or array of paths. Expected without trailing slash(es).
		* @param int $max_execution_time Maximum time to run before giving up. In seconds. The timeout is global
		* and is measured from the moment WordPress started to load.
		* @return int\|false\|null Size in bytes if a valid directory. False if not. Null if timeout.
		*/
		function recurse_dirsize( $directory, $exclude = null, $max_execution_time = null ) {