Docs: Misc corrections and additions to inline documentation.

See #39130
Props keesiemeijer


git-svn-id: https://develop.svn.wordpress.org/trunk@39639 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2016-12-27 09:27:38 +00:00
parent 5f645d2f34
commit 8512036e4e
12 changed files with 22 additions and 13 deletions

View File

@@ -1593,6 +1593,7 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
* string is allowed when a comment is being updated.
*
* @since 4.7.0
* @access public
*
* @param string $value Author email value submitted.
* @param WP_REST_Request $request Full details about the request.

View File

@@ -1166,6 +1166,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
* Checks whether current user can assign all terms sent with the current request.
*
* @since 4.7.0
* @access protected
*
* @param WP_REST_Request $request The request object with post and terms data.
* @return bool Whether the current user can assign the provided terms.
@@ -1519,6 +1520,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
* in a machine readable format, we remove the "Protected: " prefix.
*
* @since 4.7.0
* @access public
*
* @return string Protected title format.
*/

View File

@@ -306,6 +306,7 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
* provide a wrapper sanitizer to whitelist the use of `null`.
*
* @since 4.7.0
* @access public
*
* @param mixed $value The value for the setting.
* @param WP_REST_Request $request The request object.

View File

@@ -142,6 +142,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* The value can be an integer, 'false', false, or ''.
*
* @since 4.7.0
* @access public
*
* @param int|bool $value The value passed to the reassign parameter.
* @param WP_REST_Request $request Full details about the request.
@@ -1054,6 +1055,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
*
* @since 4.7.0
* @access public
*
* @param mixed $value The username submitted in the request.
* @param WP_REST_Request $request Full details about the request.
@@ -1083,6 +1085,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
*
* @since 4.7.0
* @access public
*
* @param mixed $value The password submitted in the request.
* @param WP_REST_Request $request Full details about the request.