Docs: Correct invalid hook docblocks.

See #48303

Built from https://develop.svn.wordpress.org/trunk@46603


git-svn-id: http://core.svn.wordpress.org/trunk@46400 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2019-10-27 19:11:02 +00:00
parent c283f8b1ed
commit c8f91f77ac
10 changed files with 32 additions and 32 deletions

View File

@ -74,11 +74,11 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
*
* @since 3.6.0
*
* @param string $compare_from->$field The current revision field to compare to or from.
* @param string $field The current revision field.
* @param WP_Post $compare_from The revision post object to compare to or from.
* @param string null The context of whether the current revision is the old
* or the new one. Values are 'to' or 'from'.
* @param string $revision_field The current revision field to compare to or from.
* @param string $field The current revision field.
* @param WP_Post $compare_from The revision post object to compare to or from.
* @param string $context The context of whether the current revision is the old
* or the new one. Values are 'to' or 'from'.
*/
$content_from = $compare_from ? apply_filters( "_wp_post_revision_field_{$field}", $compare_from->$field, $field, $compare_from, 'from' ) : '';

View File

@ -168,8 +168,8 @@ switch ( $action ) {
*
* @since 4.9.0
*
* @param boolean Whether to replace the editor. Default false.
* @param object $post Post object.
* @param bool $replace Whether to replace the editor. Default false.
* @param WP_Post $post Post object.
*/
if ( apply_filters( 'replace_editor', false, $post ) === true ) {
break;

View File

@ -3572,10 +3572,10 @@ function wp_comments_personal_data_eraser( $email_address, $page = 1 ) {
*
* @since 4.9.6
*
* @param bool|string Whether to apply the comment anonymization (bool).
* Custom prevention message (string). Default true.
* @param WP_Comment $comment WP_Comment object.
* @param array $anonymized_comment Anonymized comment data.
* @param bool|string $anon_message Whether to apply the comment anonymization (bool) or a custom
* message (string). Default true.
* @param WP_Comment $comment WP_Comment object.
* @param array $anonymized_comment Anonymized comment data.
*/
$anon_message = apply_filters( 'wp_anonymize_comment', true, $comment, $anonymized_comment );

View File

@ -5584,7 +5584,7 @@ function _print_emoji_detection_script() {
*
* @since 4.2.0
*
* @param string The emoji base URL for png images.
* @param string $url The emoji base URL for png images.
*/
'baseUrl' => apply_filters( 'emoji_url', 'https://s.w.org/images/core/emoji/12.0.0-1/72x72/' ),
@ -5593,7 +5593,7 @@ function _print_emoji_detection_script() {
*
* @since 4.2.0
*
* @param string The emoji extension for png files. Default .png.
* @param string $extension The emoji extension for png files. Default .png.
*/
'ext' => apply_filters( 'emoji_ext', '.png' ),
@ -5602,7 +5602,7 @@ function _print_emoji_detection_script() {
*
* @since 4.6.0
*
* @param string The emoji base URL for svg images.
* @param string $url The emoji base URL for svg images.
*/
'svgUrl' => apply_filters( 'emoji_svg_url', 'https://s.w.org/images/core/emoji/12.0.0-1/svg/' ),
@ -5611,7 +5611,7 @@ function _print_emoji_detection_script() {
*
* @since 4.6.0
*
* @param string The emoji extension for svg files. Default .svg.
* @param string $extension The emoji extension for svg files. Default .svg.
*/
'svgExt' => apply_filters( 'emoji_svg_ext', '.svg' ),
);

View File

@ -126,7 +126,7 @@ function determine_locale() {
*
* @since 5.0.0
*
* @param string|null The locale to return and short-circuit, or null as default.
* @param string|null $locale The locale to return and short-circuit. Default null.
*/
$determined_locale = apply_filters( 'pre_determine_locale', null );
if ( ! empty( $determined_locale ) && is_string( $determined_locale ) ) {

View File

@ -635,9 +635,9 @@ function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = fa
*
* @since 5.3.0
*
* @param bool The filtered value.
* @param int Original image width.
* @param int Original image height.
* @param bool $proceed The filtered value.
* @param int $orig_w Original image width.
* @param int $orig_h Original image height.
*/
$proceed = (bool) apply_filters( 'wp_image_resize_identical_dimensions', false, $orig_w, $orig_h );
@ -3696,8 +3696,8 @@ function wp_enqueue_media( $args = array() ) {
*
* @link https://core.trac.wordpress.org/ticket/31071
*
* @param bool|null Whether to show the button, or `null` to decide based
* on whether any audio files exist in the media library.
* @param bool|null $show Whether to show the button, or `null` to decide based
* on whether any audio files exist in the media library.
*/
$show_audio_playlist = apply_filters( 'media_library_show_audio_playlist', true );
if ( null === $show_audio_playlist ) {
@ -3726,8 +3726,8 @@ function wp_enqueue_media( $args = array() ) {
*
* @link https://core.trac.wordpress.org/ticket/31071
*
* @param bool|null Whether to show the button, or `null` to decide based
* on whether any video files exist in the media library.
* @param bool|null $show Whether to show the button, or `null` to decide based
* on whether any video files exist in the media library.
*/
$show_video_playlist = apply_filters( 'media_library_show_video_playlist', true );
if ( null === $show_video_playlist ) {
@ -3754,9 +3754,9 @@ function wp_enqueue_media( $args = array() ) {
*
* @link https://core.trac.wordpress.org/ticket/31071
*
* @param array|null An array of objects with `month` and `year`
* properties, or `null` (or any other non-array value)
* for default behavior.
* @param array|null $months An array of objects with `month` and `year`
* properties, or `null` (or any other non-array value)
* for default behavior.
*/
$months = apply_filters( 'media_library_months_with_files', null );
if ( ! is_array( $months ) ) {

View File

@ -78,7 +78,7 @@ function ms_site_check() {
*
* @since 3.0.0
*
* @param bool null Whether to skip the blog status check. Default null.
* @param bool|null $check Whether to skip the blog status check. Default null.
*/
$check = apply_filters( 'ms_site_check', null );
if ( null !== $check ) {

View File

@ -2870,9 +2870,9 @@ function current_theme_supports( $feature, ...$args ) {
*
* @since 3.4.0
*
* @param bool true Whether the current theme supports the given feature. Default true.
* @param array $args Array of arguments for the feature.
* @param string $feature The theme feature.
* @param bool $supports Whether the current theme supports the given feature. Default true.
* @param array $args Array of arguments for the feature.
* @param string $feature The theme feature.
*/
return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
}

View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.4-alpha-46602';
$wp_version = '5.4-alpha-46603';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -594,7 +594,7 @@ switch ( $action ) {
*
* @since 5.3.0
*
* @param int Interval time (in seconds).
* @param int $interval Interval time (in seconds).
*/
$admin_email_check_interval = (int) apply_filters( 'admin_email_check_interval', 6 * MONTH_IN_SECONDS );