-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add search results context block (#671)
* Add Search Results context block Initially built for DevHub, now required for Make Handbooks * Fix block registration path
- Loading branch information
1 parent
94f19f2
commit 718e2ce
Showing
4 changed files
with
144 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
<?php | ||
/** | ||
* Block Name: Search Results Context | ||
* Description: Displays context information for search results. | ||
* | ||
* @package wporg | ||
*/ | ||
|
||
namespace WordPressdotorg\MU_Plugins\Search_Results_Context; | ||
|
||
add_action( 'init', __NAMESPACE__ . '\init' ); | ||
|
||
/** | ||
* Render the block content. | ||
* | ||
* @return string Returns the block markup. | ||
*/ | ||
function render( $attributes ) { | ||
global $wp_query; | ||
|
||
if ( ! is_search() ) { | ||
return ''; | ||
} | ||
|
||
$results_count = $wp_query->found_posts; | ||
|
||
if ( 0 === $results_count ) { | ||
return; | ||
} | ||
|
||
$posts_per_page = get_query_var( 'posts_per_page' ); | ||
$current_page = get_query_var( 'paged' ) ?: 1; | ||
$first_result = ( $current_page - 1 ) * $posts_per_page + 1; | ||
$last_result = min( $current_page * $posts_per_page, $results_count ); | ||
|
||
$content = sprintf( | ||
/* translators: %1$s number of results; %2$s keyword. */ | ||
_n( | ||
'%1$s result found for "%2$s".', | ||
'%1$s results found for "%2$s".', | ||
$results_count, | ||
'wporg' | ||
), | ||
number_format_i18n( $results_count ), | ||
esc_html( $wp_query->query['s'] ), | ||
); | ||
|
||
$showing = sprintf( | ||
/* translators: %1$s number of first displayed result, %2$s number of last displayed result. */ | ||
'Showing results %1$s to %2$s.', | ||
number_format_i18n( $first_result ), | ||
number_format_i18n( $last_result ), | ||
); | ||
|
||
$wrapper_attributes = get_block_wrapper_attributes(); | ||
|
||
return sprintf( | ||
'<%1$s %2$s>%3$s %4$s</%1$s>', | ||
esc_attr( $attributes['tagName'] ), | ||
$wrapper_attributes, | ||
$content, | ||
$showing, | ||
); | ||
} | ||
|
||
/** | ||
* Registers the block using the metadata loaded from the `block.json` file. | ||
* Behind the scenes, it registers also all assets so they can be enqueued | ||
* through the block editor in the corresponding context. | ||
* | ||
* @see https://developer.wordpress.org/reference/functions/register_block_type/ | ||
*/ | ||
function init() { | ||
register_block_type( | ||
__DIR__ . '/build', | ||
array( | ||
'render_callback' => __NAMESPACE__ . '\render', | ||
) | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
{ | ||
"$schema": "https://schemas.wp.org/trunk/block.json", | ||
"apiVersion": 2, | ||
"name": "wporg/search-results-context", | ||
"version": "0.1.0", | ||
"title": "Search Results Context", | ||
"category": "design", | ||
"icon": "", | ||
"description": "Displays context information for search results.", | ||
"textdomain": "wporg", | ||
"attributes": { | ||
"tagName": { | ||
"type": "string", | ||
"default": "p" | ||
} | ||
}, | ||
"supports": { | ||
"align": true, | ||
"color": true, | ||
"html": false, | ||
"spacing": { | ||
"margin": true, | ||
"padding": true, | ||
"blockGap": false | ||
}, | ||
"typography": { | ||
"fontSize": true, | ||
"lineHeight": true, | ||
"__experimentalFontFamily": true, | ||
"__experimentalFontStyle": true, | ||
"__experimentalFontWeight": true, | ||
"__experimentalLetterSpacing": true, | ||
"__experimentalTextTransform": true, | ||
"__experimentalTextDecoration": true, | ||
"__experimentalDefaultControls": { | ||
"fontSize": true, | ||
"fontAppearance": true, | ||
"textTransform": true | ||
} | ||
} | ||
}, | ||
"editorScript": "file:./index.js", | ||
"viewScript": "file:./index.js" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { registerBlockType } from '@wordpress/blocks'; | ||
import { useBlockProps } from '@wordpress/block-editor'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import metadata from './block.json'; | ||
|
||
function Edit() { | ||
return <div { ...useBlockProps() }>Search Results Context</div>; | ||
} | ||
|
||
registerBlockType( metadata.name, { | ||
edit: Edit, | ||
save: () => null, | ||
} ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters