WordPress.org

Make WordPress Core

Changeset 46695


Ignore:
Timestamp:
11/11/2019 12:03:53 AM (13 months ago)
Author:
SergeyBiryukov
Message:

Docs: Miscellaneous docblock corrections in wp-admin/includes/plugin.php.

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/plugin.php

    r46694 r46695  
    17571757
    17581758/**
    1759  * Get the url to access a particular menu page based on the slug it was registered with.
    1760  *
    1761  * If the slug hasn't been registered properly no url will be returned
     1759 * Get the URL to access a particular menu page based on the slug it was registered with.
     1760 *
     1761 * If the slug hasn't been registered properly, no URL will be returned.
    17621762 *
    17631763 * @since 3.0.0
     
    17651765 * @global array $_parent_pages
    17661766 *
    1767  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
    1768  * @param bool $echo Whether or not to echo the url - default is true
    1769  * @return string the url
     1767 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
     1768 * @param bool   $echo      Whether or not to echo the URL. Default true.
     1769 * @return string The menu page URL.
    17701770 */
    17711771function menu_page_url( $menu_slug, $echo = true ) {
     
    21872187 * @since 2.7.0
    21882188 *
    2189  * @param string $option_group A settings group name. This should match the group name used in register_setting().
     2189 * @param string $option_group A settings group name. This should match the group name
     2190 *                             used in register_setting().
    21902191 */
    21912192function settings_fields( $option_group ) {
     
    21962197
    21972198/**
    2198  * Clears the Plugins cache used by get_plugins() and by default, the Plugin Update cache.
     2199 * Clears the plugins cache used by get_plugins() and by default, the plugin updates cache.
    21992200 *
    22002201 * @since 3.7.0
    22012202 *
    2202  * @param bool $clear_update_cache Whether to clear the Plugin updates cache
     2203 * @param bool $clear_update_cache Whether to clear the plugin updates cache. Default true.
    22032204 */
    22042205function wp_clean_plugins_cache( $clear_update_cache = true ) {
     
    22422243 * @since 4.9.6
    22432244 *
    2244  * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
     2245 * @param string $plugin_name The name of the plugin or theme that is suggesting content
     2246 *                            for the site's privacy policy.
    22452247 * @param string $policy_text The suggested content for inclusion in the policy.
    22462248 */
     
    22882290 *
    22892291 * @param string $plugin Path to the plugin file relative to the plugins directory.
    2290  * @return bool True, if in the list of paused plugins. False, not in the list.
     2292 * @return bool True, if in the list of paused plugins. False, if not in the list.
    22912293 */
    22922294function is_plugin_paused( $plugin ) {
     
    23092311 * @since 5.2.0
    23102312 *
    2311  * @param string $plugin Path to the plugin file relative to the plugins
    2312  *                       directory.
    2313  * @return array|false Array of error information as it was returned by
    2314  *                     `error_get_last()`, or false if none was recorded.
     2313 * @param string $plugin Path to the plugin file relative to the plugins directory.
     2314 * @return array|false Array of error information as returned by `error_get_last()`,
     2315 *                     or false if none was recorded.
    23152316 */
    23162317function wp_get_plugin_error( $plugin ) {
     
    23402341 * @since 5.2.0
    23412342 *
    2342  * @param string $plugin       Single plugin to resume.
    2343  * @param string $redirect     Optional. URL to redirect to. Default empty string.
     2343 * @param string $plugin   Single plugin to resume.
     2344 * @param string $redirect Optional. URL to redirect to. Default empty string.
    23442345 * @return bool|WP_Error True on success, false if `$plugin` was not paused,
    23452346 *                       `WP_Error` on failure.
Note: See TracChangeset for help on using the changeset viewer.