Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update template descriptions with more detail #48934

Merged
merged 5 commits into from
Mar 9, 2023
Merged

Update template descriptions with more detail #48934

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d759d03
Update template descriptions with more detail
ntsekouras Mar 8, 2023
fda1f65
small tweaks
ntsekouras Mar 8, 2023
dcbdd62
fix tests
ntsekouras Mar 8, 2023
e1c8aaa
update 404 copy
ntsekouras Mar 8, 2023
3c08546
Fix type in non-existent
andrewserong Mar 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions lib/compat/wordpress-6.1/block-template-utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,6 @@
* @package gutenberg
*/

/**
* Updates the list of default template types, containing their
* localized titles and descriptions.
*
* We will only need to update `get_default_block_template_types` function.
*
* @param array $default_template_types The default template types.
*
* @return array The default template types.
*/
function gutenberg_get_default_block_template_types( $default_template_types ) {
if ( isset( $default_template_types['single'] ) ) {
$default_template_types['single'] = array(
'title' => _x( 'Single', 'Template name', 'gutenberg' ),
'description' => __( 'The default template for displaying any single post or attachment.', 'gutenberg' ),
);
}
if ( isset( $default_template_types['category'] ) ) {
$default_template_types['category'] = array(
'title' => _x( 'Category', 'Template name', 'gutenberg' ),
'description' => __( 'Displays latest posts from a single post category.', 'gutenberg' ),
);
}
return $default_template_types;
}
add_filter( 'default_template_types', 'gutenberg_get_default_block_template_types', 10 );


/**
* Retrieves a list of unified template objects based on a query.
*
Expand Down
143 changes: 143 additions & 0 deletions lib/compat/wordpress-6.2/block-template-utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,146 @@ function gutenberg_get_template_hierarchy( $slug, $is_custom = false, $template_
$template_hierarchy[] = 'index';
return $template_hierarchy;
}


/**
* Updates the list of default template types, containing their
* localized titles and descriptions.
*
* We will only need to update `get_default_block_template_types` function.
*
* @param array $default_template_types The default template types.
*
* @return array The default template types.
*/
function gutenberg_get_default_block_template_types( $default_template_types ) {
if ( isset( $default_template_types['index'] ) ) {
$default_template_types['index'] = array(
'title' => _x( 'Index', 'Template name', 'gutenberg' ),
'description' => __(
'Used as a fallback template for all pages when a more specific template is not defined.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['home'] ) ) {
$default_template_types['home'] = array(
'title' => _x( 'Home', 'Template name', 'gutenberg' ),
'description' => __(
'Displays the latest posts as either the site homepage or a custom page defined under reading settings. If it exists, the Front Page template overrides this template when posts are shown on the front page.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['front-page'] ) ) {
$default_template_types['front-page'] = array(
'title' => _x( 'Front Page', 'Template name', 'gutenberg' ),
'description' => __(
"Displays your site's front page, whether it is set to display latest posts or a static page. The Front Page template takes precedence over all templates.",
'gutenberg'
),
);
}
if ( isset( $default_template_types['singular'] ) ) {
$default_template_types['singular'] = array(
'title' => _x( 'Singular', 'Template name', 'gutenberg' ),
'description' => __(
'Displays any single entry, such as a post or a page. This template will serve as a fallback when a more specific template (e.g., Single Post, Page, or Attachment) cannot be found.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['single'] ) ) {
$default_template_types['single'] = array(
'title' => _x( 'Single', 'Template name', 'gutenberg' ),
'description' => __( 'Displays single posts on your website unless a custom template has been applied to that post or a dedicated template exists.', 'gutenberg' ),
);
}
if ( isset( $default_template_types['page'] ) ) {
$default_template_types['page'] = array(
'title' => _x( 'Page', 'Template name', 'gutenberg' ),
'description' => __( 'Display all static pages unless a custom template has been applied or a dedicated template exists.', 'gutenberg' ),
);
}
if ( isset( $default_template_types['archive'] ) ) {
$default_template_types['archive'] = array(
'title' => _x( 'Archive', 'Template name', 'gutenberg' ),
'description' => __(
'Displays any archive, including posts by a single author, category, tag, taxonomy, custom post type, and date. This template will serve as a fallback when more specific templates (e.g., Category or Tag) cannot be found.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['author'] ) ) {
$default_template_types['author'] = array(
'title' => _x( 'Author', 'Template name', 'gutenberg' ),
'description' => __(
"Displays a single author's post archive. This template will serve as a fallback when a more a specific template (e.g., Author: Admin) cannot be found.",
'gutenberg'
),
);
}
if ( isset( $default_template_types['category'] ) ) {
$default_template_types['category'] = array(
'title' => _x( 'Category', 'Template name', 'gutenberg' ),
'description' => __(
'Displays a post category archive. This template will serve as a fallback when more specific template (e.g., Category: Recipes) cannot be found.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['taxonomy'] ) ) {
$default_template_types['taxonomy'] = array(
'title' => _x( 'Taxonomy', 'Template name', 'gutenberg' ),
'description' => __(
'Displays a custom taxonomy archive. Like categories and tags, taxonomies have terms which you use to classify things. For example: a taxonomy named "Art" can have multiple terms, such as "Modern" and "18th Century." This template will serve as a fallback when a more specific template (e.g, Taxonomy: Art) cannot be found.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['date'] ) ) {
$default_template_types['date'] = array(
'title' => _x( 'Date', 'Template name', 'gutenberg' ),
'description' => __( 'Displays a post archive when a specific date is visited (e.g., example.com/2023/).', 'gutenberg' ),
);
}
if ( isset( $default_template_types['tag'] ) ) {
$default_template_types['tag'] = array(
'title' => _x( 'Tag', 'Template name', 'gutenberg' ),
'description' => __(
'Displays a post tag archive. This template will serve as a fallback when more specific template (e.g., Tag: Pizza) cannot be found.',
'gutenberg'
),
);
}
if ( isset( $default_template_types['attachment'] ) ) {
$default_template_types['attachment'] = array(
'title' => _x( 'Media', 'Template name', 'gutenberg' ),
'description' => __( 'Displays when a visitor views the dedicated page that exists for any media attachment.', 'gutenberg' ),
);
}
if ( isset( $default_template_types['search'] ) ) {
$default_template_types['search'] = array(
'title' => _x( 'Search', 'Template name', 'gutenberg' ),
'description' => __( 'Displays when a visitor performs a search on your website.', 'gutenberg' ),
);
}
if ( isset( $default_template_types['privacy-policy'] ) ) {
$default_template_types['privacy-policy'] = array(
'title' => _x( 'Privacy Policy', 'Template name', 'gutenberg' ),
'description' => __(
"Displays your site's Privacy Policy page.",
'gutenberg'
),
);
}
if ( isset( $default_template_types['404'] ) ) {
$default_template_types['404'] = array(
'title' => _x( '404', 'Template name', 'gutenberg' ),
'description' => __( 'Displays when a visitor views a non-existant page, such as a dead link or a mistyped URL.', 'gutenberg' ),
andrewserong marked this conversation as resolved.
Show resolved Hide resolved
);
}

return $default_template_types;
}
add_filter( 'default_template_types', 'gutenberg_get_default_block_template_types', 10 );
6 changes: 4 additions & 2 deletions packages/e2e-tests/specs/site-editor/settings-sidebar.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,13 @@ describe( 'Settings sidebar', () => {

expect( templateCardBeforeNavigation ).toMatchObject( {
title: 'Index',
description: 'Displays posts.',
description:
'Used as a fallback template for all pages when a more specific template is not defined.',
} );
expect( templateCardAfterNavigation ).toMatchObject( {
title: 'Singular',
description: 'Displays a single post or page.',
description:
'Displays any single entry, such as a post or a page. This template will serve as a fallback when a more specific template (e.g., Single Post, Page, or Attachment) cannot be found.',
} );
} );
} );
Expand Down
2 changes: 1 addition & 1 deletion packages/edit-post/src/components/sidebar/post-template/create-modal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export default function PostTemplateCreateModal( { onClose } ) {
placeholder={ DEFAULT_TITLE }
disabled={ isBusy }
help={ __(
'Describe the template, e.g. "Post with sidebar". Custom templates can be applied to any post or page.'
'Describe the template, e.g. "Post with sidebar". A custom template can be manually applied to any post or page.'
) }
/>
<HStack justify="right">
Expand Down
2 changes: 1 addition & 1 deletion packages/edit-site/src/components/add-new-template/new-template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export default function NewTemplate( {
}

const customTemplateDescription = __(
'Custom templates can be applied to any post or page.'
'A custom template can be manually applied to any post or page.'
);

return (
Expand Down