Docs: Various fixes and improvements to inline documentation.
See #49572 git-svn-id: https://develop.svn.wordpress.org/trunk@48695 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
2ec18b9d8e
commit
1c6ca0998c
@ -1,17 +1,17 @@
|
||||
<?php
|
||||
/**
|
||||
* A pseudo-CRON daemon for scheduling WordPress tasks
|
||||
* A pseudo-cron daemon for scheduling WordPress tasks.
|
||||
*
|
||||
* WP Cron is triggered when the site receives a visit. In the scenario
|
||||
* WP-Cron is triggered when the site receives a visit. In the scenario
|
||||
* where a site may not receive enough visits to execute scheduled tasks
|
||||
* in a timely manner, this file can be called directly or via a server
|
||||
* CRON daemon for X number of times.
|
||||
* cron daemon for X number of times.
|
||||
*
|
||||
* Defining DISABLE_WP_CRON as true and calling this file directly are
|
||||
* mutually exclusive and the latter does not rely on the former to work.
|
||||
*
|
||||
* The HTTP request to this file will not slow down the visitor who happens to
|
||||
* visit when the cron job is needed to run.
|
||||
* visit when a scheduled cron event runs.
|
||||
*
|
||||
* @package WordPress
|
||||
*/
|
||||
@ -33,7 +33,7 @@ if ( ! empty( $_POST ) || defined( 'DOING_AJAX' ) || defined( 'DOING_CRON' ) ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell WordPress we are doing the CRON task.
|
||||
* Tell WordPress we are doing the cron task.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
|
@ -2240,11 +2240,11 @@ function wp_list_comments( $args = array(), $comments = null ) {
|
||||
/**
|
||||
* Outputs a complete commenting form for use within a template.
|
||||
*
|
||||
* Most strings and form fields may be controlled through the $args array passed
|
||||
* Most strings and form fields may be controlled through the `$args` array passed
|
||||
* into the function, while you may also choose to use the {@see 'comment_form_default_fields'}
|
||||
* filter to modify the array of default fields if you'd just like to add a new
|
||||
* one or remove a single field. All fields are also individually passed through
|
||||
* a filter of the {@see 'comment_form_field_$name'} where $name is the key used
|
||||
* a filter of the {@see 'comment_form_field_$name'} where `$name` is the key used
|
||||
* in the array of fields.
|
||||
*
|
||||
* @since 3.0.0
|
||||
|
@ -3564,7 +3564,7 @@ function preview_theme_ob_filter_callback( $matches ) {
|
||||
/**
|
||||
* Formats text for the rich text editor.
|
||||
*
|
||||
* The {@see 'richedit_pre'} filter is applied here. If $text is empty the filter will
|
||||
* The {@see 'richedit_pre'} filter is applied here. If `$text` is empty the filter will
|
||||
* be applied to an empty string.
|
||||
*
|
||||
* @since 2.0.0
|
||||
|
@ -993,7 +993,7 @@ function wp_embed_excerpt_attachment( $content ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Enqueue embed iframe default CSS and JS & fire do_action('enqueue_embed_scripts')
|
||||
* Enqueues embed iframe default CSS and JS.
|
||||
*
|
||||
* Enqueue PNG fallback CSS for embed iframe for legacy versions of IE.
|
||||
*
|
||||
|
@ -6821,7 +6821,7 @@ function mysql_to_rfc3339( $date_string ) {
|
||||
*
|
||||
* @param string $context Optional. Context in which the function is called. Accepts either 'admin',
|
||||
* 'image', or an arbitrary other context. If an arbitrary context is passed,
|
||||
* the similarly arbitrary {@see '{$context}_memory_limit'} filter will be
|
||||
* the similarly arbitrary {@see '$context_memory_limit'} filter will be
|
||||
* invoked. Default 'admin'.
|
||||
* @return bool|int|string The limit that was set or false on failure.
|
||||
*/
|
||||
|
@ -143,9 +143,9 @@ function add_rewrite_rule( $regex, $query, $after = 'bottom' ) {
|
||||
/**
|
||||
* Add a new rewrite tag (like %postname%).
|
||||
*
|
||||
* The $query parameter is optional. If it is omitted you must ensure that
|
||||
* you call this on, or before, the {@see 'init'} hook. This is because $query defaults
|
||||
* to "$tag=", and for this to work a new query var has to be added.
|
||||
* The `$query` parameter is optional. If it is omitted you must ensure that you call
|
||||
* this on, or before, the {@see 'init'} hook. This is because `$query` defaults to
|
||||
* `$tag=`, and for this to work a new query var has to be added.
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
|
@ -2407,6 +2407,9 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
|
||||
/**
|
||||
* Fires immediately after a new term is created, before the term cache is cleaned.
|
||||
*
|
||||
* The {@see 'create_$taxonomy'} hook is also available for targeting a specific
|
||||
* taxonomy.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param int $term_id Term ID.
|
||||
@ -2443,6 +2446,9 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
|
||||
/**
|
||||
* Fires after a new term is created, and after the term cache has been cleaned.
|
||||
*
|
||||
* The {@see 'created_$taxonomy'} hook is also available for targeting a specific
|
||||
* taxonomy.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param int $term_id Term ID.
|
||||
@ -2467,6 +2473,9 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
|
||||
/**
|
||||
* Fires after a term has been saved, and the term cache has been cleared.
|
||||
*
|
||||
* The {@see 'saved_$taxonomy'} hook is also available for targeting a specific
|
||||
* taxonomy.
|
||||
*
|
||||
* @since 5.5.0
|
||||
*
|
||||
* @param int $term_id Term ID.
|
||||
|
Loading…
Reference in New Issue
Block a user