Docs: Consistently include an empty line between @since tag and @see, @link, or @global, per the documentation standards.

See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48067 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-06-16 21:05:20 +00:00
parent 9f11a8414f
commit 3bdf8b7b02
42 changed files with 113 additions and 27 deletions

View File

@ -36,10 +36,10 @@ if ( isset( $_GET['dt'] ) ) {
} }
} }
// Prevent actions on a comment associated with a trashed post.
$comment_id = absint( $_GET['c'] ); $comment_id = absint( $_GET['c'] );
$comment = get_comment( $comment_id ); $comment = get_comment( $comment_id );
// Prevent actions on a comment associated with a trashed post.
if ( 'trash' === get_post_status( $comment->comment_post_ID ) ) { if ( 'trash' === get_post_status( $comment->comment_post_ID ) ) {
wp_die( wp_die(
__( 'You can’t edit this comment because the associated post is in the Trash. Please restore the post first, then try again.' ) __( 'You can’t edit this comment because the associated post is in the Trash. Please restore the post first, then try again.' )

View File

@ -421,8 +421,8 @@ function wp_ajax_logged_in() {
* *
* Contrary to normal success Ajax response ("1"), die with time() on success. * Contrary to normal success Ajax response ("1"), die with time() on success.
* *
* @access private
* @since 2.7.0 * @since 2.7.0
* @access private
* *
* @param int $comment_id * @param int $comment_id
* @param int $delta * @param int $delta
@ -554,8 +554,8 @@ function _wp_ajax_delete_comment_response( $comment_id, $delta = -1 ) {
/** /**
* Ajax handler for adding a hierarchical term. * Ajax handler for adding a hierarchical term.
* *
* @access private
* @since 3.1.0 * @since 3.1.0
* @access private
*/ */
function _wp_ajax_add_hierarchical_term() { function _wp_ajax_add_hierarchical_term() {
$action = $_POST['action']; $action = $_POST['action'];
@ -4668,6 +4668,7 @@ function wp_ajax_search_install_plugins() {
* Ajax handler for editing a theme or plugin file. * Ajax handler for editing a theme or plugin file.
* *
* @since 4.9.0 * @since 4.9.0
*
* @see wp_edit_theme_plugin_file() * @see wp_edit_theme_plugin_file()
*/ */
function wp_ajax_edit_theme_plugin_file() { function wp_ajax_edit_theme_plugin_file() {

View File

@ -1468,9 +1468,10 @@ function unzip_file( $file, $to ) {
* Assumes that WP_Filesystem() has already been called and set up. * Assumes that WP_Filesystem() has already been called and set up.
* *
* @since 3.0.0 * @since 3.0.0
* @see unzip_file()
* @access private * @access private
* *
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
* *
* @param string $file Full path and filename of ZIP archive. * @param string $file Full path and filename of ZIP archive.
@ -1599,9 +1600,10 @@ function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) {
* Assumes that WP_Filesystem() has already been called and set up. * Assumes that WP_Filesystem() has already been called and set up.
* *
* @since 3.0.0 * @since 3.0.0
* @see unzip_file()
* @access private * @access private
* *
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
* *
* @param string $file Full path and filename of ZIP archive. * @param string $file Full path and filename of ZIP archive.

View File

@ -542,6 +542,7 @@ function is_plugin_active( $plugin ) {
* Conditional Tags} article in the Theme Developer Handbook. * Conditional Tags} article in the Theme Developer Handbook.
* *
* @since 3.1.0 * @since 3.1.0
*
* @see is_plugin_active() * @see is_plugin_active()
* *
* @param string $plugin Path to the plugin file relative to the plugins directory. * @param string $plugin Path to the plugin file relative to the plugins directory.

View File

@ -146,6 +146,7 @@ function _get_template_edit_filename( $fullpath, $containingfolder ) {
* Will display link, if there is an update available. * Will display link, if there is an update available.
* *
* @since 2.7.0 * @since 2.7.0
*
* @see get_theme_update_available() * @see get_theme_update_available()
* *
* @param WP_Theme $theme Theme data object. * @param WP_Theme $theme Theme data object.

View File

@ -11,6 +11,7 @@
* Stores files to be deleted. * Stores files to be deleted.
* *
* @since 2.7.0 * @since 2.7.0
*
* @global array $_old_files * @global array $_old_files
* @var array * @var array
* @name $_old_files * @name $_old_files
@ -1314,14 +1315,16 @@ function update_core( $from, $to ) {
/** /**
* Copies a directory from one location to another via the WordPress Filesystem Abstraction. * Copies a directory from one location to another via the WordPress Filesystem Abstraction.
*
* Assumes that WP_Filesystem() has already been called and setup. * Assumes that WP_Filesystem() has already been called and setup.
* *
* This is a temporary function for the 3.1 -> 3.2 upgrade, as well as for those upgrading to * This is a temporary function for the 3.1 -> 3.2 upgrade, as well as for those
* 3.7+ * upgrading to 3.7+.
* *
* @ignore * @ignore
* @since 3.2.0 * @since 3.2.0
* @since 3.7.0 Updated not to use a regular expression for the skip list * @since 3.7.0 Updated not to use a regular expression for the skip list.
*
* @see copy_dir() * @see copy_dir()
* *
* @global WP_Filesystem_Base $wp_filesystem * @global WP_Filesystem_Base $wp_filesystem

View File

@ -644,6 +644,7 @@ add_action( 'customize_register', 'twentyeleven_customize_register' );
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Eleven 2.4 * @since Twenty Eleven 2.4
*
* @see twentyeleven_customize_register() * @see twentyeleven_customize_register()
* *
* @return void * @return void
@ -656,6 +657,7 @@ function twentyeleven_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Eleven 2.4 * @since Twenty Eleven 2.4
*
* @see twentyeleven_customize_register() * @see twentyeleven_customize_register()
* *
* @return void * @return void

View File

@ -116,6 +116,7 @@ add_action( 'customize_register', 'twentyfifteen_customize_register', 11 );
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Fifteen 1.5 * @since Twenty Fifteen 1.5
*
* @see twentyfifteen_customize_register() * @see twentyfifteen_customize_register()
* *
* @return void * @return void
@ -128,6 +129,7 @@ function twentyfifteen_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Fifteen 1.5 * @since Twenty Fifteen 1.5
*
* @see twentyfifteen_customize_register() * @see twentyfifteen_customize_register()
* *
* @return void * @return void

View File

@ -98,6 +98,7 @@ add_action( 'customize_register', 'twentyfourteen_customize_register' );
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Fourteen 1.7 * @since Twenty Fourteen 1.7
*
* @see twentyfourteen_customize_register() * @see twentyfourteen_customize_register()
* *
* @return void * @return void
@ -110,6 +111,7 @@ function twentyfourteen_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Fourteen 1.7 * @since Twenty Fourteen 1.7
*
* @see twentyfourteen_customize_register() * @see twentyfourteen_customize_register()
* *
* @return void * @return void

View File

@ -625,6 +625,7 @@ add_filter( 'widget_tag_cloud_args', 'twentyseventeen_widget_tag_cloud_args' );
* but it is unique across the life of the PHP process. * but it is unique across the life of the PHP process.
* *
* @since Twenty Seventeen 2.0 * @since Twenty Seventeen 2.0
*
* @see wp_unique_id() Themes requiring WordPress 5.0.3 and greater should use this instead. * @see wp_unique_id() Themes requiring WordPress 5.0.3 and greater should use this instead.
* *
* @staticvar int $id_counter * @staticvar int $id_counter

View File

@ -197,6 +197,7 @@ function twentyseventeen_sanitize_colorscheme( $input ) {
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
*
* @see twentyseventeen_customize_register() * @see twentyseventeen_customize_register()
* *
* @return void * @return void
@ -209,6 +210,7 @@ function twentyseventeen_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Seventeen 1.0 * @since Twenty Seventeen 1.0
*
* @see twentyseventeen_customize_register() * @see twentyseventeen_customize_register()
* *
* @return void * @return void

View File

@ -251,6 +251,7 @@ add_action( 'customize_register', 'twentysixteen_customize_register', 11 );
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Sixteen 1.2 * @since Twenty Sixteen 1.2
*
* @see twentysixteen_customize_register() * @see twentysixteen_customize_register()
* *
* @return void * @return void
@ -263,6 +264,7 @@ function twentysixteen_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Sixteen 1.2 * @since Twenty Sixteen 1.2
*
* @see twentysixteen_customize_register() * @see twentysixteen_customize_register()
* *
* @return void * @return void

View File

@ -734,6 +734,7 @@ add_action( 'customize_register', 'twentythirteen_customize_register' );
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Thirteen 1.9 * @since Twenty Thirteen 1.9
*
* @see twentythirteen_customize_register() * @see twentythirteen_customize_register()
* *
* @return void * @return void
@ -746,6 +747,7 @@ function twentythirteen_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Thirteen 1.9 * @since Twenty Thirteen 1.9
*
* @see twentythirteen_customize_register() * @see twentythirteen_customize_register()
* *
* @return void * @return void

View File

@ -651,6 +651,7 @@ add_action( 'customize_register', 'twentytwelve_customize_register' );
* Render the site title for the selective refresh partial. * Render the site title for the selective refresh partial.
* *
* @since Twenty Twelve 2.0 * @since Twenty Twelve 2.0
*
* @see twentytwelve_customize_register() * @see twentytwelve_customize_register()
* *
* @return void * @return void
@ -663,6 +664,7 @@ function twentytwelve_customize_partial_blogname() {
* Render the site tagline for the selective refresh partial. * Render the site tagline for the selective refresh partial.
* *
* @since Twenty Twelve 2.0 * @since Twenty Twelve 2.0
*
* @see twentytwelve_customize_register() * @see twentytwelve_customize_register()
* *
* @return void * @return void

View File

@ -49,6 +49,7 @@ function get_the_author( $deprecated = '' ) {
* return it. However, backward compatibility has to be maintained. * return it. However, backward compatibility has to be maintained.
* *
* @since 0.71 * @since 0.71
*
* @see get_the_author() * @see get_the_author()
* @link https://developer.wordpress.org/reference/functions/the_author/ * @link https://developer.wordpress.org/reference/functions/the_author/
* *

View File

@ -48,6 +48,7 @@ function unregister_block_type( $name ) {
* you should use the block parser on post content. * you should use the block parser on post content.
* *
* @since 5.0.0 * @since 5.0.0
*
* @see parse_blocks() * @see parse_blocks()
* *
* @param int|string|WP_Post|null $post Optional. Post content, post ID, or post object. Defaults to global $post. * @param int|string|WP_Post|null $post Optional. Post content, post ID, or post object. Defaults to global $post.
@ -72,6 +73,7 @@ function has_blocks( $post = null ) {
* you should use the block parser on post content. * you should use the block parser on post content.
* *
* @since 5.0.0 * @since 5.0.0
*
* @see parse_blocks() * @see parse_blocks()
* *
* @param string $block_name Full Block type to look for. * @param string $block_name Full Block type to look for.

View File

@ -11,6 +11,7 @@
* Retrieves category link URL. * Retrieves category link URL.
* *
* @since 1.0.0 * @since 1.0.0
*
* @see get_term_link() * @see get_term_link()
* *
* @param int|object $category Category ID or object. * @param int|object $category Category ID or object.
@ -1117,6 +1118,7 @@ function walk_category_dropdown_tree( ...$args ) {
* Retrieves the link to the tag. * Retrieves the link to the tag.
* *
* @since 2.3.0 * @since 2.3.0
*
* @see get_term_link() * @see get_term_link()
* *
* @param int|object $tag Tag ID or object. * @param int|object $tag Tag ID or object.

View File

@ -13,6 +13,7 @@
* will be returned instead. * will be returned instead.
* *
* @since 2.1.0 * @since 2.1.0
*
* @see get_terms() Type of arguments that can be changed. * @see get_terms() Type of arguments that can be changed.
* *
* @param string|array $args { * @param string|array $args {

View File

@ -847,6 +847,7 @@ class WP_Http {
* are supported, eg `*.wordpress.org` will allow for all subdomains of `wordpress.org` to be contacted. * are supported, eg `*.wordpress.org` will allow for all subdomains of `wordpress.org` to be contacted.
* *
* @since 2.8.0 * @since 2.8.0
*
* @link https://core.trac.wordpress.org/ticket/8927 Allow preventing external requests. * @link https://core.trac.wordpress.org/ticket/8927 Allow preventing external requests.
* @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_ACCESSIBLE_HOSTS * @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_ACCESSIBLE_HOSTS
* *

View File

@ -18,6 +18,7 @@ class WP_Ajax_Response {
* Constructor - Passes args to WP_Ajax_Response::add(). * Constructor - Passes args to WP_Ajax_Response::add().
* *
* @since 2.1.0 * @since 2.1.0
*
* @see WP_Ajax_Response::add() * @see WP_Ajax_Response::add()
* *
* @param string|array $args Optional. Will be passed to add() method. * @param string|array $args Optional. Will be passed to add() method.

View File

@ -606,6 +606,7 @@ final class WP_Customize_Manager {
* enabled, then a new UUID will be generated. * enabled, then a new UUID will be generated.
* *
* @since 4.9.0 * @since 4.9.0
*
* @global string $pagenow * @global string $pagenow
*/ */
public function establish_loaded_changeset() { public function establish_loaded_changeset() {
@ -737,6 +738,7 @@ final class WP_Customize_Manager {
* Gets whether settings are or will be previewed. * Gets whether settings are or will be previewed.
* *
* @since 4.9.0 * @since 4.9.0
*
* @see WP_Customize_Setting::preview() * @see WP_Customize_Setting::preview()
* *
* @return bool * @return bool
@ -749,6 +751,7 @@ final class WP_Customize_Manager {
* Gets whether data from a changeset's autosaved revision should be loaded if it exists. * Gets whether data from a changeset's autosaved revision should be loaded if it exists.
* *
* @since 4.9.0 * @since 4.9.0
*
* @see WP_Customize_Manager::changeset_data() * @see WP_Customize_Manager::changeset_data()
* *
* @return bool Is using autosaved changeset revision. * @return bool Is using autosaved changeset revision.
@ -761,6 +764,7 @@ final class WP_Customize_Manager {
* Whether the changeset branching is allowed. * Whether the changeset branching is allowed.
* *
* @since 4.9.0 * @since 4.9.0
*
* @see WP_Customize_Manager::establish_loaded_changeset() * @see WP_Customize_Manager::establish_loaded_changeset()
* *
* @return bool Is changeset branching. * @return bool Is changeset branching.
@ -801,6 +805,7 @@ final class WP_Customize_Manager {
* Get the changeset UUID. * Get the changeset UUID.
* *
* @since 4.7.0 * @since 4.7.0
*
* @see WP_Customize_Manager::establish_loaded_changeset() * @see WP_Customize_Manager::establish_loaded_changeset()
* *
* @return string UUID. * @return string UUID.
@ -1946,6 +1951,7 @@ final class WP_Customize_Manager {
* Add customize state query params to a given URL if preview is allowed. * Add customize state query params to a given URL if preview is allowed.
* *
* @since 4.7.0 * @since 4.7.0
*
* @see wp_redirect() * @see wp_redirect()
* @see WP_Customize_Manager::get_allowed_url() * @see WP_Customize_Manager::get_allowed_url()
* *
@ -3030,8 +3036,9 @@ final class WP_Customize_Manager {
* untouched. * untouched.
* *
* @since 4.9.0 * @since 4.9.0
* @global wpdb $wpdb WordPress database abstraction object. *
* @see wp_trash_post() * @see wp_trash_post()
* @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int|WP_Post $post The changeset post. * @param int|WP_Post $post The changeset post.
* @return mixed A WP_Post object for the trashed post or an empty value on failure. * @return mixed A WP_Post object for the trashed post or an empty value on failure.
@ -3179,6 +3186,7 @@ final class WP_Customize_Manager {
* This should be able to be removed once #40922 is addressed in core. * This should be able to be removed once #40922 is addressed in core.
* *
* @since 4.9.0 * @since 4.9.0
*
* @link https://core.trac.wordpress.org/ticket/40922 * @link https://core.trac.wordpress.org/ticket/40922
* @see WP_Customize_Manager::save_changeset_post() * @see WP_Customize_Manager::save_changeset_post()
* @see _wp_translate_postdata() * @see _wp_translate_postdata()
@ -3407,6 +3415,7 @@ final class WP_Customize_Manager {
* invoking this method. * invoking this method.
* *
* @since 4.7.0 * @since 4.7.0
*
* @see _wp_customize_publish_changeset() * @see _wp_customize_publish_changeset()
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *

View File

@ -1409,6 +1409,7 @@ final class WP_Customize_Nav_Menus {
* Keep track of the arguments that are being passed to wp_nav_menu(). * Keep track of the arguments that are being passed to wp_nav_menu().
* *
* @since 4.3.0 * @since 4.3.0
*
* @see wp_nav_menu() * @see wp_nav_menu()
* @see WP_Customize_Widgets::filter_dynamic_sidebar_params() * @see WP_Customize_Widgets::filter_dynamic_sidebar_params()
* *

View File

@ -13,9 +13,9 @@
* Handles saving and sanitizing of settings. * Handles saving and sanitizing of settings.
* *
* @since 3.4.0 * @since 3.4.0
* @link https://developer.wordpress.org/themes/customize-api
* *
* @see WP_Customize_Manager * @see WP_Customize_Manager
* @link https://developer.wordpress.org/themes/customize-api
*/ */
class WP_Customize_Setting { class WP_Customize_Setting {
/** /**

View File

@ -91,6 +91,7 @@ class WP_Http_Encoding {
* https://core.trac.wordpress.org/ticket/18273 * https://core.trac.wordpress.org/ticket/18273
* *
* @since 2.8.1 * @since 2.8.1
*
* @link https://core.trac.wordpress.org/ticket/18273 * @link https://core.trac.wordpress.org/ticket/18273
* @link https://www.php.net/manual/en/function.gzinflate.php#70875 * @link https://www.php.net/manual/en/function.gzinflate.php#70875
* @link https://www.php.net/manual/en/function.gzinflate.php#77336 * @link https://www.php.net/manual/en/function.gzinflate.php#77336

View File

@ -3378,6 +3378,7 @@ class WP_Query {
* Sets up the current comment. * Sets up the current comment.
* *
* @since 2.2.0 * @since 2.2.0
*
* @global WP_Comment $comment Global comment object. * @global WP_Comment $comment Global comment object.
*/ */
public function the_comment() { public function the_comment() {

View File

@ -445,6 +445,7 @@ function get_comment_count( $post_id = 0 ) {
* Add meta data field to a comment. * Add meta data field to a comment.
* *
* @since 2.9.0 * @since 2.9.0
*
* @link https://developer.wordpress.org/reference/functions/add_comment_meta/ * @link https://developer.wordpress.org/reference/functions/add_comment_meta/
* *
* @param int $comment_id Comment ID. * @param int $comment_id Comment ID.
@ -466,6 +467,7 @@ function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false
* allows removing all metadata matching key, if needed. * allows removing all metadata matching key, if needed.
* *
* @since 2.9.0 * @since 2.9.0
*
* @link https://developer.wordpress.org/reference/functions/delete_comment_meta/ * @link https://developer.wordpress.org/reference/functions/delete_comment_meta/
* *
* @param int $comment_id Comment ID. * @param int $comment_id Comment ID.
@ -483,6 +485,7 @@ function delete_comment_meta( $comment_id, $meta_key, $meta_value = '' ) {
* Retrieve comment meta field for a comment. * Retrieve comment meta field for a comment.
* *
* @since 2.9.0 * @since 2.9.0
*
* @link https://developer.wordpress.org/reference/functions/get_comment_meta/ * @link https://developer.wordpress.org/reference/functions/get_comment_meta/
* *
* @param int $comment_id Comment ID. * @param int $comment_id Comment ID.
@ -507,6 +510,7 @@ function get_comment_meta( $comment_id, $key = '', $single = false ) {
* If the meta field for the comment does not exist, it will be added. * If the meta field for the comment does not exist, it will be added.
* *
* @since 2.9.0 * @since 2.9.0
*
* @link https://developer.wordpress.org/reference/functions/update_comment_meta/ * @link https://developer.wordpress.org/reference/functions/update_comment_meta/
* *
* @param int $comment_id Comment ID. * @param int $comment_id Comment ID.
@ -2449,6 +2453,7 @@ function wp_update_comment( $commentarr ) {
* updated without having to call wp_update_comment_count() after. * updated without having to call wp_update_comment_count() after.
* *
* @since 2.5.0 * @since 2.5.0
*
* @staticvar bool $_defer * @staticvar bool $_defer
* *
* @param bool $defer * @param bool $defer
@ -2480,6 +2485,7 @@ function wp_defer_comment_counting( $defer = null ) {
* IDs will be updated along with the current $post_id. * IDs will be updated along with the current $post_id.
* *
* @since 2.1.0 * @since 2.1.0
*
* @see wp_update_comment_count_now() For what could cause a false return value * @see wp_update_comment_count_now() For what could cause a false return value
* *
* @staticvar array $_deferred * @staticvar array $_deferred
@ -3013,6 +3019,7 @@ function weblog_ping( $server = '', $path = '' ) {
* Default filter attached to pingback_ping_source_uri to validate the pingback's Source URI * Default filter attached to pingback_ping_source_uri to validate the pingback's Source URI
* *
* @since 3.5.1 * @since 3.5.1
*
* @see wp_http_validate_url() * @see wp_http_validate_url()
* *
* @param string $source_uri * @param string $source_uri
@ -3029,6 +3036,7 @@ function pingback_ping_source_uri( $source_uri ) {
* which reports that the pingback is already registered. * which reports that the pingback is already registered.
* *
* @since 3.5.1 * @since 3.5.1
*
* @link https://www.hixie.ch/specs/pingback/pingback#TOC3 * @link https://www.hixie.ch/specs/pingback/pingback#TOC3
* *
* @param IXR_Error $ixr_error * @param IXR_Error $ixr_error
@ -3127,8 +3135,8 @@ function _prime_comment_caches( $comment_ids, $update_meta_cache = true ) {
/** /**
* Close comments on old posts on the fly, without any extra DB queries. Hooked to the_posts. * Close comments on old posts on the fly, without any extra DB queries. Hooked to the_posts.
* *
* @access private
* @since 2.7.0 * @since 2.7.0
* @access private
* *
* @param WP_Post $posts Post data object. * @param WP_Post $posts Post data object.
* @param WP_Query $query Query object. * @param WP_Query $query Query object.
@ -3167,8 +3175,8 @@ function _close_comments_for_old_posts( $posts, $query ) {
/** /**
* Close comments on an old post. Hooked to comments_open and pings_open. * Close comments on an old post. Hooked to comments_open and pings_open.
* *
* @access private
* @since 2.7.0 * @since 2.7.0
* @access private
* *
* @param bool $open Comments open or closed * @param bool $open Comments open or closed
* @param int $post_id Post ID * @param int $post_id Post ID

View File

@ -65,6 +65,7 @@ class WP_Customize_Code_Editor_Control extends WP_Customize_Control {
* Refresh the parameters passed to the JavaScript via JSON. * Refresh the parameters passed to the JavaScript via JSON.
* *
* @since 4.9.0 * @since 4.9.0
*
* @see WP_Customize_Control::json() * @see WP_Customize_Control::json()
* *
* @return array Array of parameters passed to the JavaScript. * @return array Array of parameters passed to the JavaScript.

View File

@ -95,6 +95,7 @@ final class WP_Customize_Custom_CSS_Setting extends WP_Customize_Setting {
* This is used in the preview when `wp_get_custom_css()` is called for rendering the styles. * This is used in the preview when `wp_get_custom_css()` is called for rendering the styles.
* *
* @since 4.7.0 * @since 4.7.0
*
* @see wp_get_custom_css() * @see wp_get_custom_css()
* *
* @param string $css Original CSS. * @param string $css Original CSS.
@ -115,6 +116,7 @@ final class WP_Customize_Custom_CSS_Setting extends WP_Customize_Setting {
* Fetch the value of the setting. Will return the previewed value when `preview()` is called. * Fetch the value of the setting. Will return the previewed value when `preview()` is called.
* *
* @since 4.7.0 * @since 4.7.0
*
* @see WP_Customize_Setting::value() * @see WP_Customize_Setting::value()
* *
* @return string * @return string

View File

@ -187,6 +187,7 @@ class WP_Customize_Date_Time_Control extends WP_Customize_Control {
* Based on touch_time(). * Based on touch_time().
* *
* @since 4.9.0 * @since 4.9.0
*
* @see touch_time() * @see touch_time()
* *
* @global WP_Locale $wp_locale WordPress date and time locale object. * @global WP_Locale $wp_locale WordPress date and time locale object.
@ -261,6 +262,7 @@ class WP_Customize_Date_Time_Control extends WP_Customize_Control {
* Format GMT Offset. * Format GMT Offset.
* *
* @since 4.9.0 * @since 4.9.0
*
* @see wp_timezone_choice() * @see wp_timezone_choice()
* *
* @param float $offset Offset in hours. * @param float $offset Offset in hours.

View File

@ -97,6 +97,7 @@ class WP_Customize_Partial {
* Render callback. * Render callback.
* *
* @since 4.5.0 * @since 4.5.0
*
* @see WP_Customize_Partial::render() * @see WP_Customize_Partial::render()
* @var callable Callback is called with one argument, the instance of * @var callable Callback is called with one argument, the instance of
* WP_Customize_Partial. The callback can either echo the * WP_Customize_Partial. The callback can either echo the

View File

@ -401,6 +401,7 @@ function wp_templating_constants() {
* It will be used as the fallback if the current theme doesn't exist. * It will be used as the fallback if the current theme doesn't exist.
* *
* @since 3.0.0 * @since 3.0.0
*
* @see WP_Theme::get_core_default_theme() * @see WP_Theme::get_core_default_theme()
*/ */
if ( ! defined( 'WP_DEFAULT_THEME' ) ) { if ( ! defined( 'WP_DEFAULT_THEME' ) ) {

View File

@ -18,6 +18,7 @@
* are retrieved for use in the feeds. * are retrieved for use in the feeds.
* *
* @since 1.5.1 * @since 1.5.1
*
* @see get_bloginfo() For the list of possible values to display. * @see get_bloginfo() For the list of possible values to display.
* *
* @param string $show See get_bloginfo() for possible values. * @param string $show See get_bloginfo() for possible values.
@ -47,6 +48,7 @@ function get_bloginfo_rss( $show = '' ) {
* are retrieved for use in the feeds. * are retrieved for use in the feeds.
* *
* @since 0.71 * @since 0.71
*
* @see get_bloginfo() For the list of possible values to display. * @see get_bloginfo() For the list of possible values to display.
* *
* @param string $show See get_bloginfo() for possible values. * @param string $show See get_bloginfo() for possible values.
@ -177,6 +179,7 @@ function the_title_rss() {
* Retrieve the post content for feeds. * Retrieve the post content for feeds.
* *
* @since 2.9.0 * @since 2.9.0
*
* @see get_the_content() * @see get_the_content()
* *
* @param string $feed_type The type of feed. rss2 | atom | rss | rdf * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
@ -427,6 +430,7 @@ function get_the_category_rss( $type = null ) {
* Display the post categories in the feed. * Display the post categories in the feed.
* *
* @since 0.71 * @since 0.71
*
* @see get_the_category_rss() For better explanation. * @see get_the_category_rss() For better explanation.
* *
* @param string $type Optional, default is the type returned by get_default_feed(). * @param string $type Optional, default is the type returned by get_default_feed().
@ -772,6 +776,7 @@ function fetch_feed( $url ) {
$feed->set_feed_url( $url ); $feed->set_feed_url( $url );
/** This filter is documented in wp-includes/class-wp-feed-cache-transient.php */ /** This filter is documented in wp-includes/class-wp-feed-cache-transient.php */
$feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) ); $feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) );
/** /**
* Fires just before processing the SimplePie feed object. * Fires just before processing the SimplePie feed object.
* *
@ -781,6 +786,7 @@ function fetch_feed( $url ) {
* @param string|string[] $url URL of feed or array of URLs of feeds to retrieve. * @param string|string[] $url URL of feed or array of URLs of feeds to retrieve.
*/ */
do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) ); do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
$feed->init(); $feed->init();
$feed->set_output_encoding( get_option( 'blog_charset' ) ); $feed->set_output_encoding( get_option( 'blog_charset' ) );

View File

@ -2123,6 +2123,7 @@ function get_next_post_link( $format = '%link »', $link = '%title', $in_sa
* Displays the next post link that is adjacent to the current post. * Displays the next post link that is adjacent to the current post.
* *
* @since 1.5.0 * @since 1.5.0
*
* @see get_next_post_link() * @see get_next_post_link()
* *
* @param string $format Optional. Link anchor format. Default '« %link'. * @param string $format Optional. Link anchor format. Default '« %link'.

View File

@ -3277,6 +3277,7 @@ function get_attachment_taxonomies( $attachment, $output = 'names' ) {
* Handles mime-type-specific taxonomies such as attachment:image and attachment:video. * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
* *
* @since 3.5.0 * @since 3.5.0
*
* @see get_taxonomies() * @see get_taxonomies()
* *
* @param string $output Optional. The type of taxonomy output to return. Accepts 'names' or 'objects'. * @param string $output Optional. The type of taxonomy output to return. Accepts 'names' or 'objects'.

View File

@ -2200,6 +2200,7 @@ function add_existing_user_to_blog( $details = false ) {
* is specifically hooked into the {@see 'wpmu_activate_user'} action. * is specifically hooked into the {@see 'wpmu_activate_user'} action.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
*
* @see add_user_to_blog() * @see add_user_to_blog()
* *
* @param int $user_id User ID. * @param int $user_id User ID.

View File

@ -106,6 +106,7 @@ function register_nav_menus( $locations = array() ) {
* Unregisters a navigation menu location for a theme. * Unregisters a navigation menu location for a theme.
* *
* @since 3.1.0 * @since 3.1.0
*
* @global array $_wp_registered_nav_menus * @global array $_wp_registered_nav_menus
* *
* @param string $location The menu location identifier. * @param string $location The menu location identifier.

View File

@ -17,6 +17,7 @@ if ( ! function_exists( 'wp_set_current_user' ) ) :
* actions on users who aren't signed in. * actions on users who aren't signed in.
* *
* @since 2.0.3 * @since 2.0.3
*
* @global WP_User $current_user The current user object which holds the user data. * @global WP_User $current_user The current user object which holds the user data.
* *
* @param int $id User ID * @param int $id User ID

View File

@ -999,6 +999,7 @@ function _wp_privacy_statuses() {
* Arguments prefixed with an _underscore shouldn't be used by plugins and themes. * Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
* *
* @since 3.0.0 * @since 3.0.0
*
* @global array $wp_post_statuses Inserts new post status object into the list * @global array $wp_post_statuses Inserts new post status object into the list
* *
* @param string $post_status Name of the post status. * @param string $post_status Name of the post status.

View File

@ -1971,6 +1971,7 @@ function wp_localize_community_events() {
* the $_wp_admin_css_colors array value URL. * the $_wp_admin_css_colors array value URL.
* *
* @since 2.6.0 * @since 2.6.0
*
* @global array $_wp_admin_css_colors * @global array $_wp_admin_css_colors
* *
* @param string $src Source URL. * @param string $src Source URL.
@ -2183,7 +2184,7 @@ function wp_print_footer_scripts() {
} }
/** /**
* Wrapper for do_action('wp_enqueue_scripts') * Wrapper for do_action( 'wp_enqueue_scripts' ).
* *
* Allows plugins to queue scripts for the front end using wp_enqueue_script(). * Allows plugins to queue scripts for the front end using wp_enqueue_script().
* Runs first in wp_head() where all is_home(), is_page(), etc. functions are available. * Runs first in wp_head() where all is_home(), is_page(), etc. functions are available.

View File

@ -834,6 +834,7 @@ function switch_theme( $stylesheet ) {
* disable this functionality. * disable this functionality.
* *
* @since 1.5.0 * @since 1.5.0
*
* @see WP_DEFAULT_THEME * @see WP_DEFAULT_THEME
* *
* @return bool * @return bool
@ -2817,7 +2818,9 @@ function get_theme_support( $feature, ...$args ) {
* be used for child themes to override support from the parent theme. * be used for child themes to override support from the parent theme.
* *
* @since 3.0.0 * @since 3.0.0
*
* @see add_theme_support() * @see add_theme_support()
*
* @param string $feature The feature being removed. * @param string $feature The feature being removed.
* @return bool|void Whether feature was removed. * @return bool|void Whether feature was removed.
*/ */
@ -3240,6 +3243,7 @@ function _wp_customize_publish_changeset( $new_status, $old_status, $changeset_p
* transitioned into pending status by a contributor. * transitioned into pending status by a contributor.
* *
* @since 4.7.0 * @since 4.7.0
*
* @see wp_insert_post() * @see wp_insert_post()
* *
* @param array $post_data An array of slashed post data. * @param array $post_data An array of slashed post data.

View File

@ -9,11 +9,13 @@
/** /**
* Check WordPress version against the newest version. * Check WordPress version against the newest version.
* *
* The WordPress version, PHP version, and Locale is sent. Checks against the * The WordPress version, PHP version, and locale is sent.
* WordPress server at api.wordpress.org server. Will only check if WordPress *
* isn't installing. * Checks against the WordPress server at api.wordpress.org. Will only check
* if WordPress isn't installing.
* *
* @since 2.3.0 * @since 2.3.0
*
* @global string $wp_version Used to check against the newest WordPress version. * @global string $wp_version Used to check against the newest WordPress version.
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* @global string $wp_local_package Locale code of the package. * @global string $wp_local_package Locale code of the package.
@ -251,11 +253,13 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
/** /**
* Check plugin versions against the latest versions hosted on WordPress.org. * Check plugin versions against the latest versions hosted on WordPress.org.
* *
* The WordPress version, PHP version, and Locale is sent along with a list of * A list of all plugins installed is sent to WP, along with the site locale.
* all plugins installed. Checks against the WordPress server at *
* api.wordpress.org. Will only check if WordPress isn't installing. * Checks against the WordPress server at api.wordpress.org. Will only check
* if WordPress isn't installing.
* *
* @since 2.3.0 * @since 2.3.0
*
* @global string $wp_version The WordPress version string. * @global string $wp_version The WordPress version string.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
@ -442,11 +446,13 @@ function wp_update_plugins( $extra_stats = array() ) {
/** /**
* Check theme versions against the latest versions hosted on WordPress.org. * Check theme versions against the latest versions hosted on WordPress.org.
* *
* A list of all themes installed in sent to WP. Checks against the * A list of all themes installed is sent to WP, along with the site locale.
* WordPress server at api.wordpress.org. Will only check if WordPress isn't *
* installing. * Checks against the WordPress server at api.wordpress.org. Will only check
* if WordPress isn't installing.
* *
* @since 2.7.0 * @since 2.7.0
*
* @global string $wp_version The WordPress version string. * @global string $wp_version The WordPress version string.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.

View File

@ -803,6 +803,7 @@ function add_user_meta( $user_id, $meta_key, $meta_value, $unique = false ) {
* allows removing all metadata matching key, if needed. * allows removing all metadata matching key, if needed.
* *
* @since 3.0.0 * @since 3.0.0
*
* @link https://developer.wordpress.org/reference/functions/delete_user_meta/ * @link https://developer.wordpress.org/reference/functions/delete_user_meta/
* *
* @param int $user_id User ID * @param int $user_id User ID
@ -820,6 +821,7 @@ function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
* Retrieve user meta field for a user. * Retrieve user meta field for a user.
* *
* @since 3.0.0 * @since 3.0.0
*
* @link https://developer.wordpress.org/reference/functions/get_user_meta/ * @link https://developer.wordpress.org/reference/functions/get_user_meta/
* *
* @param int $user_id User ID. * @param int $user_id User ID.
@ -844,6 +846,7 @@ function get_user_meta( $user_id, $key = '', $single = false ) {
* If the meta field for the user does not exist, it will be added. * If the meta field for the user does not exist, it will be added.
* *
* @since 3.0.0 * @since 3.0.0
*
* @link https://developer.wordpress.org/reference/functions/update_user_meta/ * @link https://developer.wordpress.org/reference/functions/update_user_meta/
* *
* @param int $user_id User ID. * @param int $user_id User ID.
@ -1554,7 +1557,7 @@ function wp_insert_user( $userdata ) {
return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
} }
// hashed in wp_update_user(), plaintext if called directly. // Hashed in wp_update_user(), plaintext if called directly.
$user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass; $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
} else { } else {
$update = false; $update = false;
@ -2163,7 +2166,8 @@ All at ###SITENAME###
* complex user creation use wp_insert_user() to specify more information. * complex user creation use wp_insert_user() to specify more information.
* *
* @since 2.0.0 * @since 2.0.0
* @see wp_insert_user() More complete way to create a new user *
* @see wp_insert_user() More complete way to create a new user.
* *
* @param string $username The user's username. * @param string $username The user's username.
* @param string $password The user's password. * @param string $password The user's password.
@ -2629,6 +2633,7 @@ function wp_get_session_token() {
* Retrieve a list of sessions for the current user. * Retrieve a list of sessions for the current user.
* *
* @since 4.0.0 * @since 4.0.0
*
* @return array Array of sessions. * @return array Array of sessions.
*/ */
function wp_get_all_sessions() { function wp_get_all_sessions() {