Docs: Replace incorrect @private tags.

The `@private` tag does not exist and is not supported. To indicate that something is private when in the global namespace, `@access private` should be used instead.

Reference: [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#phpdoc-tags PHP Documentation Standards: PHPDoc tags].

Props jrf.
See #59651.

git-svn-id: https://develop.svn.wordpress.org/trunk@57065 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2023-11-06 09:25:02 +00:00
parent f9429d5f93
commit f84e228196
4 changed files with 6 additions and 6 deletions

View File

@ -13,8 +13,8 @@ if ( is_network_admin() ) {
*
* The hook fires before menus and sub-menus are removed based on user privileges.
*
* @private
* @since 3.1.0
* @access private
*/
do_action( '_network_admin_menu' );
} elseif ( is_user_admin() ) {
@ -24,8 +24,8 @@ if ( is_network_admin() ) {
*
* The hook fires before menus and sub-menus are removed based on user privileges.
*
* @private
* @since 3.1.0
* @access private
*/
do_action( '_user_admin_menu' );
} else {
@ -35,8 +35,8 @@ if ( is_network_admin() ) {
*
* The hook fires before menus and sub-menus are removed based on user privileges.
*
* @private
* @since 2.2.0
* @access private
*/
do_action( '_admin_menu' );
}

View File

@ -1197,8 +1197,8 @@ function filter_block_content( $text, $allowed_html = 'post', $allowed_protocols
/**
* Callback used for regular expression replacement in filter_block_content().
*
* @private
* @since 6.2.1
* @access private
*
* @param array $matches Array of preg_replace_callback matches.
* @return string Replacement string.

View File

@ -3355,8 +3355,8 @@ function wp_add_editor_classic_theme_styles( $editor_settings ) {
* $js = '<script type="text/javascript">console.log( "hi" );</script>';
* 'console.error( ... )' === wp_remove_surrounding_empty_script_tags( $js );
*
* @private
* @since 6.4.0
* @access private
*
* @see wp_print_inline_script_tag()
* @see wp_get_inline_script_tag()

View File

@ -64,7 +64,7 @@ function wp_attach_theme_preview_middleware() {
* @see https://github.com/WordPress/gutenberg/pull/41836.
*
* @since 6.3.0
* @private
* @access private
*/
function wp_block_theme_activate_nonce() {
$nonce_handle = 'switch-theme_' . wp_get_theme_preview_path();