Docs: Miscellaneous docblock corrections and improvements.

See #49572

git-svn-id: https://develop.svn.wordpress.org/trunk@48462 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2020-07-13 22:08:16 +00:00
parent c3cdd9c962
commit f36c42c700
7 changed files with 33 additions and 19 deletions
+3 -3
View File
@@ -2355,7 +2355,7 @@ function sanitize_post( $post, $context = 'display' ) {
}
/**
* Sanitize post field based on context.
* Sanitizes a post field based on context.
*
* Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and
* 'js'. The 'display' context is used by default. 'attribute' and 'js' contexts
@@ -2367,7 +2367,7 @@ function sanitize_post( $post, $context = 'display' ) {
* @param string $field The Post Object field name.
* @param mixed $value The Post Object value.
* @param int $post_id Post ID.
* @param string $context Optional. How to sanitize post fields. Looks for 'raw', 'edit',
* @param string $context Optional. How to sanitize the field. Possible values are 'raw', 'edit',
* 'db', 'display', 'attribute' and 'js'. Default 'display'.
* @return mixed Sanitized value.
*/
@@ -2494,7 +2494,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
* @param mixed $value Value of the prefixed post field.
* @param int $post_id Post ID.
* @param string $context Context for how to sanitize the field. Possible
* values include 'raw', 'edit', 'db', 'display',
* values include 'edit', 'display',
* 'attribute' and 'js'.
*/
$value = apply_filters( "{$field}", $value, $post_id, $context );