WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Various corrections and improvements to inline docs and docblocks. 

See #57840

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


git-svn-id: http://core.svn.wordpress.org/trunk@55265 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2023-05-12 21:35:21 +00:00
parent fe6b65c44b
commit a714bc03ee
11 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-activate.php
View File

@ -87,7 +87,7 @@ do_action( 'activate_header' );
*/ */
function do_activate_header() { function do_activate_header() {
/** /**
* Fires before the Site Activation page is loaded. * Fires within the `<head>` section of the Site Activation page.
* *
* Fires on the {@see 'wp_head'} action. * Fires on the {@see 'wp_head'} action.
* *

6
wp-admin/includes/deprecated.php
View File

@ -197,7 +197,7 @@ function remove_option_update_handler( $option_group, $option_name, $sanitize_ca
* @deprecated 3.0.0 * @deprecated 3.0.0
* *
* @param string $filename * @param string $filename
**/ */
function codepress_get_lang( $filename ) { function codepress_get_lang( $filename ) {
_deprecated_function( __FUNCTION__, '3.0.0' ); _deprecated_function( __FUNCTION__, '3.0.0' );
} }
@ -207,7 +207,7 @@ function codepress_get_lang( $filename ) {
* *
* @since 2.8.0 * @since 2.8.0
* @deprecated 3.0.0 * @deprecated 3.0.0
**/ */
function codepress_footer_js() { function codepress_footer_js() {
_deprecated_function( __FUNCTION__, '3.0.0' ); _deprecated_function( __FUNCTION__, '3.0.0' );
} }
@ -217,7 +217,7 @@ function codepress_footer_js() {
* *
* @since 2.8.0 * @since 2.8.0
* @deprecated 3.0.0 * @deprecated 3.0.0
**/ */
function use_codepress() { function use_codepress() {
_deprecated_function( __FUNCTION__, '3.0.0' ); _deprecated_function( __FUNCTION__, '3.0.0' );
} }

3
wp-admin/includes/media.php
View File

@ -254,6 +254,9 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $
* *
* @access private * @access private
* @since 3.4.0 * @since 3.4.0
*
* @param array $matches Single regex match.
* @return string Cleaned up HTML for caption.
*/ */
function _cleanup_image_add_caption( $matches ) { function _cleanup_image_add_caption( $matches ) {
// Remove any line breaks from inside the tags. // Remove any line breaks from inside the tags.

1
wp-admin/includes/ms.php
View File

@ -848,6 +848,7 @@ var tb_pathToImage = "<?php echo esc_js( includes_url( 'js/thickbox/loadingAnima
/** /**
* @param array $users * @param array $users
* @return bool
*/ */
function confirm_delete_users( $users ) { function confirm_delete_users( $users ) {
$current_user = wp_get_current_user(); $current_user = wp_get_current_user();

2
wp-admin/includes/widgets.php
View File

@ -67,6 +67,8 @@ function wp_list_widgets() {
* @since 3.1.0 * @since 3.1.0
* @access private * @access private
* *
* @param array $a First array.
* @param array $b Second array.
* @return int * @return int
*/ */
function _sort_name_callback( $a, $b ) { function _sort_name_callback( $a, $b ) {

2
wp-includes/class-simplepie.php
View File

@ -20,6 +20,8 @@ require ABSPATH . WPINC . '/SimplePie/Author.php';
* WordPress autoloader for SimplePie. * WordPress autoloader for SimplePie.
* *
* @since 3.5.0 * @since 3.5.0
*
* @param string $class Class name.
*/ */
function wp_simplepie_autoload( $class ) { function wp_simplepie_autoload( $class ) {
if ( ! str_starts_with( $class, 'SimplePie_' ) ) if ( ! str_starts_with( $class, 'SimplePie_' ) )

1
wp-includes/comment.php
View File

@ -2981,6 +2981,7 @@ function do_all_trackbacks() {
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int|WP_Post $post Post ID or object to do trackbacks on. * @param int|WP_Post $post Post ID or object to do trackbacks on.
* @return void|false Returns false on failure.
*/ */
function do_trackbacks( $post ) { function do_trackbacks( $post ) {
global $wpdb; global $wpdb;

2
wp-includes/deprecated.php
View File

@ -3916,7 +3916,7 @@ function _sort_nav_menu_items( $a, $b ) {
* *
* @since 2.6.0 * @since 2.6.0
* @deprecated 4.9.0 * @deprecated 4.9.0
* * @return string
*/ */
function get_shortcut_link() { function get_shortcut_link() {
_deprecated_function( __FUNCTION__, '4.9.0' ); _deprecated_function( __FUNCTION__, '4.9.0' );

1
wp-includes/feed.php
View File

@ -747,6 +747,7 @@ function get_feed_build_date( $format ) {
* @since 2.8.0 * @since 2.8.0
* *
* @param string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'. * @param string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'.
* @return string Content type for specified feed type.
*/ */
function feed_content_type( $type = '' ) { function feed_content_type( $type = '' ) {
if ( empty( $type ) ) { if ( empty( $type ) ) {

1
wp-includes/plugin.php
View File

@ -707,6 +707,7 @@ function did_action( $hook_name ) {
* @param string $version The version of WordPress that deprecated the hook. * @param string $version The version of WordPress that deprecated the hook.
* @param string $replacement Optional. The hook that should have been used. Default empty. * @param string $replacement Optional. The hook that should have been used. Default empty.
* @param string $message Optional. A message regarding the change. Default empty. * @param string $message Optional. A message regarding the change. Default empty.
* @return mixed The filtered value after all hooked functions are applied to it.
*/ */
function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) { function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
if ( ! has_filter( $hook_name ) ) { if ( ! has_filter( $hook_name ) ) {

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.3-alpha-55752'; $wp_version = '6.3-alpha-55753';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.