Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.
Affects DocBlocks for the following core elements: * Markdown-indent a code snippet in the description for `wp_salt()` * Backtick-escape inline code in the return description for `get_avatar()` * Various markdown formatting in the description for `add_filter()` * Markdown-indent a code snippet in the description for `apply_filters()` * Backtick-escape inline code in the `@see` description for `apply_filters_ref_array()` * Backtick-escape inline code in the description for `do_action()` * Backtick-escape variables in the parameter and return descriptions for `do_action_ref_array()` * Various markdown formatting in the description for `get_plugin_data()` Props rarst. See #30473. Built from https://develop.svn.wordpress.org/trunk@30544 git-svn-id: http://core.svn.wordpress.org/trunk@30533 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
parent
9955384dbe
commit
188e47869f
|
|
@ -14,7 +14,6 @@
|
|||
* must not have any newlines or only parts of the description will be displayed
|
||||
* and the same goes for the plugin data. The below is formatted for printing.
|
||||
*
|
||||
* <code>
|
||||
* /*
|
||||
* Plugin Name: Name of Plugin
|
||||
* Plugin URI: Link to plugin information
|
||||
|
|
@ -33,20 +32,20 @@
|
|||
* across all sites in an installation. This will prevent a plugin from being
|
||||
* activated on a single site when Multisite is enabled.
|
||||
* * / # Remove the space to close comment
|
||||
* </code>
|
||||
*
|
||||
* Plugin data returned array contains the following:
|
||||
* 'Name' - Name of the plugin, must be unique.
|
||||
* 'Title' - Title of the plugin and the link to the plugin's web site.
|
||||
* 'Description' - Description of what the plugin does and/or notes
|
||||
* from the author.
|
||||
* 'Author' - The author's name
|
||||
* 'AuthorURI' - The authors web site address.
|
||||
* 'Version' - The plugin version number.
|
||||
* 'PluginURI' - Plugin web site address.
|
||||
* 'TextDomain' - Plugin's text domain for localization.
|
||||
* 'DomainPath' - Plugin's relative directory path to .mo files.
|
||||
* 'Network' - Boolean. Whether the plugin can only be activated network wide.
|
||||
*
|
||||
* - 'Name' - Name of the plugin, must be unique.
|
||||
* - 'Title' - Title of the plugin and the link to the plugin's web site.
|
||||
* - 'Description' - Description of what the plugin does and/or notes
|
||||
* - from the author.
|
||||
* - 'Author' - The author's name
|
||||
* - 'AuthorURI' - The authors web site address.
|
||||
* - 'Version' - The plugin version number.
|
||||
* - 'PluginURI' - Plugin web site address.
|
||||
* - 'TextDomain' - Plugin's text domain for localization.
|
||||
* - 'DomainPath' - Plugin's relative directory path to .mo files.
|
||||
* - 'Network' - Boolean. Whether the plugin can only be activated network wide.
|
||||
*
|
||||
* Some users have issues with opening large files and manipulating the contents
|
||||
* for want is usually the first 1kiB or 2kiB. This function stops pulling in
|
||||
|
|
@ -62,6 +61,7 @@
|
|||
*
|
||||
* @link https://core.trac.wordpress.org/ticket/5651 Previous Optimizations.
|
||||
* @link https://core.trac.wordpress.org/ticket/7372 Further and better Optimizations.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $plugin_file Path to the plugin file
|
||||
|
|
|
|||
|
|
@ -1772,7 +1772,6 @@ if ( !function_exists('wp_salt') ) :
|
|||
* {@link https://api.wordpress.org/secret-key/1.1/salt/ secret key created} just
|
||||
* for you.
|
||||
*
|
||||
* <code>
|
||||
* define('AUTH_KEY', ' Xakm<o xQy rw4EMsLKM-?!T+,PFF})H4lzcW57AF0U@N@< >M%G4Yt>f`z]MON');
|
||||
* define('SECURE_AUTH_KEY', 'LzJ}op]mr|6+![P}Ak:uNdJCJZd>(Hx.-Mh#Tz)pCIU#uGEnfFz|f ;;eU%/U^O~');
|
||||
* define('LOGGED_IN_KEY', '|i|Ux`9<p-h$aFf(qnT:sDO:D1P^wZ$$/Ra@miTJi9G;ddp_<q}6H1)o|a +&JCM');
|
||||
|
|
@ -1781,7 +1780,6 @@ if ( !function_exists('wp_salt') ) :
|
|||
* define('SECURE_AUTH_SALT', '!=oLUTXh,QW=H `}`L|9/^4-3 STz},T(w}W<I`.JjPi)<Bmf1v,HpGe}T1:Xt7n');
|
||||
* define('LOGGED_IN_SALT', '+XSqHc;@Q*K_b|Z?NC[3H!!EONbh.n<+=uKR:>*c(u`g~EJBf#8u#R{mUEZrozmm');
|
||||
* define('NONCE_SALT', 'h`GXHhD>SLWVfg1(1(N{;.V!MoE(SfbA_ksP@&`+AycHcAV$+?@3q+rxV{%^VyKT');
|
||||
* </code>
|
||||
*
|
||||
* Salting passwords helps against tools which has stored hashed values of
|
||||
* common dictionary strings. The added values makes it harder to crack.
|
||||
|
|
@ -2090,7 +2088,7 @@ if ( !function_exists( 'get_avatar' ) ) :
|
|||
* @param int $size Size of the avatar image
|
||||
* @param string $default URL to a default image to use if no avatar is available
|
||||
* @param string $alt Alternative text to use in image tag. Defaults to blank
|
||||
* @return string <img> tag for the user's avatar
|
||||
* @return string `<img>` tag for the user's avatar.
|
||||
*/
|
||||
function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
|
||||
if ( ! get_option('show_avatars') )
|
||||
|
|
|
|||
|
|
@ -45,22 +45,21 @@ if ( ! isset( $wp_current_filter ) )
|
|||
* the opportunity to modify a value by returning a new value.
|
||||
*
|
||||
* The following example shows how a callback function is bound to a filter hook.
|
||||
* Note that $example is passed to the callback, (maybe) modified, then returned:
|
||||
*
|
||||
* <code>
|
||||
* Note that `$example` is passed to the callback, (maybe) modified, then returned:
|
||||
*
|
||||
* function example_callback( $example ) {
|
||||
* // Maybe modify $example in some way
|
||||
* // Maybe modify $example in some way.
|
||||
* return $example;
|
||||
* }
|
||||
* add_filter( 'example_filter', 'example_callback' );
|
||||
* </code>
|
||||
*
|
||||
* Since WordPress 1.5.1, bound callbacks can take as many arguments as are
|
||||
* passed as parameters in the corresponding apply_filters() call. The $accepted_args
|
||||
* passed as parameters in the corresponding apply_filters() call. The `$accepted_args`
|
||||
* parameter allows for calling functions only when the number of args match.
|
||||
*
|
||||
* <strong>Note:</strong> the function will return true whether or not the callback
|
||||
* is valid. It is up to you to take care. This is done for optimization purposes,
|
||||
* *Note:* the function will return true whether or not the callback is valid.
|
||||
* It is up to you to take care. This is done for optimization purposes,
|
||||
* so everything is as quick as possible.
|
||||
*
|
||||
* @since 0.71
|
||||
|
|
@ -148,7 +147,7 @@ function has_filter($tag, $function_to_check = false) {
|
|||
* the $tag parameter.
|
||||
*
|
||||
* The function allows for additional arguments to be added and passed to hooks.
|
||||
* <code>
|
||||
*
|
||||
* // Our filter callback function
|
||||
* function example_callback( $string, $arg1, $arg2 ) {
|
||||
* // (maybe) modify $string
|
||||
|
|
@ -156,13 +155,13 @@ function has_filter($tag, $function_to_check = false) {
|
|||
* }
|
||||
* add_filter( 'example_filter', 'example_callback', 10, 3 );
|
||||
*
|
||||
* // Apply the filters by calling the 'example_callback' function we
|
||||
* // "hooked" to 'example_filter' using the add_filter() function above.
|
||||
* // - 'example_filter' is the filter hook $tag
|
||||
* // - 'filter me' is the value being filtered
|
||||
* // - $arg1 and $arg2 are the additional arguments passed to the callback.
|
||||
* /*
|
||||
* * Apply the filters by calling the 'example_callback' function we
|
||||
* * "hooked" to 'example_filter' using the add_filter() function above.
|
||||
* * - 'example_filter' is the filter hook $tag
|
||||
* * - 'filter me' is the value being filtered
|
||||
* * - $arg1 and $arg2 are the additional arguments passed to the callback.
|
||||
* $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
|
||||
* </code>
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
|
|
@ -171,8 +170,8 @@ function has_filter($tag, $function_to_check = false) {
|
|||
* @global array $wp_current_filter Stores the list of current filters with the current one last.
|
||||
*
|
||||
* @param string $tag The name of the filter hook.
|
||||
* @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
|
||||
* @param mixed $var Additional variables passed to the functions hooked to <tt>$tag</tt>.
|
||||
* @param mixed $value The value on which the filters hooked to `$tag` are applied on.
|
||||
* @param mixed $var Additional variables passed to the functions hooked to `$tag`.
|
||||
* @return mixed The filtered value after all hooked functions are applied to it.
|
||||
*/
|
||||
function apply_filters( $tag, $value ) {
|
||||
|
|
@ -224,10 +223,10 @@ function apply_filters( $tag, $value ) {
|
|||
/**
|
||||
* Execute functions hooked on a specific filter hook, specifying arguments in an array.
|
||||
*
|
||||
* @see apply_filters() This function is identical, but the arguments passed to the
|
||||
* functions hooked to <tt>$tag</tt> are supplied using an array.
|
||||
* @see 3.0.0
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @see apply_filters() This function is identical, but the arguments passed to the
|
||||
* functions hooked to `$tag` are supplied using an array.
|
||||
*
|
||||
* @global array $wp_filter Stores all of the filters
|
||||
* @global array $merged_filters Merges the filter hooks using this function.
|
||||
|
|
@ -434,17 +433,15 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
|
|||
/**
|
||||
* Execute functions hooked on a specific action hook.
|
||||
*
|
||||
* This function invokes all functions attached to action hook $tag. It is
|
||||
* This function invokes all functions attached to action hook `$tag`. It is
|
||||
* possible to create new action hooks by simply calling this function,
|
||||
* specifying the name of the new hook using the <tt>$tag</tt> parameter.
|
||||
* specifying the name of the new hook using the `$tag` parameter.
|
||||
*
|
||||
* You can pass extra arguments to the hooks, much like you can with
|
||||
* apply_filters().
|
||||
* {@see apply_filters()}.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
* @see apply_filters() This function works similar with the exception that nothing
|
||||
* is returned and only the functions or methods are called.
|
||||
* @global array $wp_filter Stores all of the filters
|
||||
* @global array $wp_actions Increments the amount of times action was triggered.
|
||||
*
|
||||
|
|
@ -533,8 +530,8 @@ function did_action($tag) {
|
|||
* @global array $wp_actions Increments the amount of times action was triggered.
|
||||
*
|
||||
* @param string $tag The name of the action to be executed.
|
||||
* @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
|
||||
* @return null Will return null if $tag does not exist in $wp_filter array
|
||||
* @param array $args The arguments supplied to the functions hooked to `$tag`.
|
||||
* @return null Will return null if `$tag` does not exist in `$wp_filter` array.
|
||||
*/
|
||||
function do_action_ref_array($tag, $args) {
|
||||
global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.1-beta2-30543';
|
||||
$wp_version = '4.1-beta2-30544';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue