Make WordPress Core


Ignore:
Timestamp:
10/26/2019 08:42:00 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docblock fixes and improvements.

See #48303

File:
1 edited

Legend:

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

    r46091 r46594  
    13201320 * @param string $title Optional. Title to override the post's current title when generating the post name. Default null.
    13211321 * @param string $name  Optional. Name to override the post name. Default null.
    1322  * @return array Array containing the sample permalink with placeholder for the post name, and the post name.
     1322 * @return array {
     1323 *     Array containing the sample permalink with placeholder for the post name, and the post name.
     1324 *
     1325 *     @type string $0 The permalink with placeholder for the post name.
     1326 *     @type string $1 The post name.
     1327 * }
    13231328 */
    13241329function get_sample_permalink( $id, $title = null, $name = null ) {
     
    13841389     * @since 4.4.0
    13851390     *
    1386      * @param array   $permalink Array containing the sample permalink with placeholder for the post name, and the post name.
     1391     * @param array   $permalink {
     1392     *     Array containing the sample permalink with placeholder for the post name, and the post name.
     1393     *
     1394     *     @type string $0 The permalink with placeholder for the post name.
     1395     *     @type string $1 The post name.
     1396     * }
    13871397     * @param int     $post_id   Post ID.
    13881398     * @param string  $title     Post title.
     
    16381648
    16391649    if ( $user ) {
    1640 
    16411650        /**
    16421651         * Filters whether to show the post locked dialog.
    16431652         *
    1644          * Returning a falsey value to the filter will short-circuit displaying the dialog.
     1653         * Returning false from the filter will prevent the dialog from being displayed.
    16451654         *
    16461655         * @since 3.6.0
    16471656         *
    1648          * @param bool         $display Whether to display the dialog. Default true.
    1649          * @param WP_Post      $post    Post object.
    1650          * @param WP_User|bool $user    WP_User object on success, false otherwise.
     1657         * @param bool    $display Whether to display the dialog. Default true.
     1658         * @param WP_Post $post    Post object.
     1659         * @param WP_User $user    The user with the lock for the post.
    16511660         */
    16521661        if ( ! apply_filters( 'show_post_locked_dialog', true, $post, $user ) ) {
     
    16971706         * Filters whether to allow the post lock to be overridden.
    16981707         *
    1699          * Returning a falsey value to the filter will disable the ability
     1708         * Returning false from the filter will disable the ability
    17001709         * to override the post lock.
    17011710         *
    17021711         * @since 3.6.0
    17031712         *
    1704          * @param bool    $override Whether to allow overriding post locks. Default true.
     1713         * @param bool    $override Whether to allow the post lock to be overridden. Default true.
    17051714         * @param WP_Post $post     Post object.
    1706          * @param WP_User $user     User object.
     1715         * @param WP_User $user     The user with the lock for the post.
    17071716         */
    17081717        $override = apply_filters( 'override_post_lock', true, $post, $user );
Note: See TracChangeset for help on using the changeset viewer.