Make WordPress Core


Ignore:
Timestamp:
11/04/2020 02:28:55 AM (3 years ago)
Author:
SergeyBiryukov
Message:

Docs: Adjust documentation for some WP_Post_Type properties:

  • Split the summary for $template per the documentation standards. The summary should be a single sentence.
  • Change the type for $template_lock to string|false, to clarify that true is not supported.
  • Fix typo in $delete_with_user description, adjust for better readability.

Follow-up to [49041], [49492].

See #46261.

File:
1 edited

Legend:

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

    r49492 r49494  
    251251     * Whether to delete posts of this type when deleting a user.
    252252     *
    253      * If true, posts of this type belonging to the user will be moved to Trash when then user is deleted.
    254      * If false, posts of this type belonging to the user will *not* be trashed or deleted.
    255      * If not set (the default), posts are trashed if post_type_supports( 'author' ).
    256      * Otherwise posts are not trashed or deleted. Default null.
     253     * - If true, posts of this type belonging to the user will be moved to Trash when the user is deleted.
     254     * - If false, posts of this type belonging to the user will *not* be trashed or deleted.
     255     * - If not set (the default), posts are trashed if post type supports the 'author' feature.
     256     *   Otherwise posts are not trashed or deleted.
     257     *
     258     * Default null.
    257259     *
    258260     * @since 4.6.0
     
    262264
    263265    /**
    264      * Array of blocks to use as the default initial state for an editor
    265      * session. Each item should be an array containing block name and
    266      * optional attributes.
     266     * Array of blocks to use as the default initial state for an editor session.
     267     *
     268     * Each item should be an array containing block name and optional attributes.
    267269     *
    268270     * Default empty array.
     
    278280     * Whether the block template should be locked if $template is set.
    279281     *
    280      * If set to 'all', the user is unable to insert new blocks, move existing blocks
    281      * and delete blocks.
    282      * If set to 'insert', the user is able to move existing blocks but is unable to insert
    283      * new blocks and delete blocks.
     282     * - If set to 'all', the user is unable to insert new blocks, move existing blocks
     283     *   and delete blocks.
     284     * - If set to 'insert', the user is able to move existing blocks but is unable to insert
     285     *   new blocks and delete blocks.
    284286     *
    285287     * Default false.
     
    288290     *
    289291     * @since 5.6.0
    290      * @var string|bool $template_lock
     292     * @var string|false $template_lock
    291293     */
    292294    public $template_lock = false;
Note: See TracChangeset for help on using the changeset viewer.