WordPress.org

Make WordPress Core

Changeset 48695


Ignore:
Timestamp:
07/30/2020 07:12:02 PM (2 months ago)
Author:
johnbillion
Message:

Docs: Various fixes and improvements to inline documentation.

See #49572

Location:
trunk/src
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-cron.php

    r47198 r48695  
    11<?php
    22/**
    3  * A pseudo-CRON daemon for scheduling WordPress tasks
     3 * A pseudo-cron daemon for scheduling WordPress tasks.
    44 *
    5  * WP Cron is triggered when the site receives a visit. In the scenario
     5 * WP-Cron is triggered when the site receives a visit. In the scenario
    66 * where a site may not receive enough visits to execute scheduled tasks
    77 * in a timely manner, this file can be called directly or via a server
    8  * CRON daemon for X number of times.
     8 * cron daemon for X number of times.
    99 *
    1010 * Defining DISABLE_WP_CRON as true and calling this file directly are
     
    1212 *
    1313 * The HTTP request to this file will not slow down the visitor who happens to
    14  * visit when the cron job is needed to run.
     14 * visit when a scheduled cron event runs.
    1515 *
    1616 * @package WordPress
     
    3434
    3535/**
    36  * Tell WordPress we are doing the CRON task.
     36 * Tell WordPress we are doing the cron task.
    3737 *
    3838 * @var bool
  • trunk/src/wp-includes/comment-template.php

    r48597 r48695  
    22412241 * Outputs a complete commenting form for use within a template.
    22422242 *
    2243  * Most strings and form fields may be controlled through the $args array passed
     2243 * Most strings and form fields may be controlled through the `$args` array passed
    22442244 * into the function, while you may also choose to use the {@see 'comment_form_default_fields'}
    22452245 * filter to modify the array of default fields if you'd just like to add a new
    22462246 * one or remove a single field. All fields are also individually passed through
    2247  * a filter of the {@see 'comment_form_field_$name'} where $name is the key used
     2247 * a filter of the {@see 'comment_form_field_$name'} where `$name` is the key used
    22482248 * in the array of fields.
    22492249 *
  • trunk/src/wp-includes/deprecated.php

    r48575 r48695  
    35653565 * Formats text for the rich text editor.
    35663566 *
    3567  * The {@see 'richedit_pre'} filter is applied here. If $text is empty the filter will
     3567 * The {@see 'richedit_pre'} filter is applied here. If `$text` is empty the filter will
    35683568 * be applied to an empty string.
    35693569 *
  • trunk/src/wp-includes/embed.php

    r48574 r48695  
    994994
    995995/**
    996  * Enqueue embed iframe default CSS and JS & fire do_action('enqueue_embed_scripts')
     996 * Enqueues embed iframe default CSS and JS.
    997997 *
    998998 * Enqueue PNG fallback CSS for embed iframe for legacy versions of IE.
  • trunk/src/wp-includes/functions.php

    r48621 r48695  
    68226822 * @param string $context Optional. Context in which the function is called. Accepts either 'admin',
    68236823 *                        'image', or an arbitrary other context. If an arbitrary context is passed,
    6824  *                        the similarly arbitrary {@see '{$context}_memory_limit'} filter will be
     6824 *                        the similarly arbitrary {@see '$context_memory_limit'} filter will be
    68256825 *                        invoked. Default 'admin'.
    68266826 * @return bool|int|string The limit that was set or false on failure.
  • trunk/src/wp-includes/rewrite.php

    r47808 r48695  
    144144 * Add a new rewrite tag (like %postname%).
    145145 *
    146  * The $query parameter is optional. If it is omitted you must ensure that
    147  * you call this on, or before, the {@see 'init'} hook. This is because $query defaults
    148  * to "$tag=", and for this to work a new query var has to be added.
     146 * The `$query` parameter is optional. If it is omitted you must ensure that you call
     147 * this on, or before, the {@see 'init'} hook. This is because `$query` defaults to
     148 * `$tag=`, and for this to work a new query var has to be added.
    149149 *
    150150 * @since 2.1.0
  • trunk/src/wp-includes/taxonomy.php

    r48665 r48695  
    24082408     * Fires immediately after a new term is created, before the term cache is cleaned.
    24092409     *
     2410     * The {@see 'create_$taxonomy'} hook is also available for targeting a specific
     2411     * taxonomy.
     2412     *
    24102413     * @since 2.3.0
    24112414     *
     
    24442447     * Fires after a new term is created, and after the term cache has been cleaned.
    24452448     *
     2449     * The {@see 'created_$taxonomy'} hook is also available for targeting a specific
     2450     * taxonomy.
     2451     *
    24462452     * @since 2.3.0
    24472453     *
     
    24672473    /**
    24682474     * Fires after a term has been saved, and the term cache has been cleared.
     2475     *
     2476     * The {@see 'saved_$taxonomy'} hook is also available for targeting a specific
     2477     * taxonomy.
    24692478     *
    24702479     * @since 5.5.0
Note: See TracChangeset for help on using the changeset viewer.