Skip to content

Follow the WordPress documentation standards in functions.php docblocks #161

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaggieCabrera merged 1 commit into from
Oct 21, 2026
Merged

Follow the WordPress documentation standards in functions.php docblocks #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 12 additions & 3 deletions functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* Adds style.css and editor-style.css as editor stylesheets.
*
* @since Ipsum 1.0
*
* @return void
*/
function ipsum_editor_style() {
Expand All @@ -29,6 +30,7 @@ function ipsum_editor_style() {
* call merges with them.
*
* @since Ipsum 1.0
*
* @return void
*/
function ipsum_theme_support() {
Expand All @@ -39,9 +41,10 @@ function ipsum_theme_support() {

if ( ! function_exists( 'ipsum_styles' ) ) :
/**
* Enqueue styles.
* Enqueues styles.
*
* @since Ipsum 1.0
*
* @return void
*/
function ipsum_styles() {
Expand All @@ -64,6 +67,7 @@ function ipsum_styles() {
* Returns the comments call to action for the current post.
*
* @since Ipsum 1.0
*
* @param array $source_args Block binding source arguments.
* @param WP_Block $block_instance The block instance.
* @return string The call to action text.
Expand All @@ -86,6 +90,7 @@ function ipsum_comments_cta_binding( $source_args, $block_instance ) {
* Registers the comments call-to-action block binding source.
*
* @since Ipsum 1.0
*
* @return void
*/
function ipsum_register_block_bindings() {
Expand All @@ -107,8 +112,9 @@ function ipsum_register_block_bindings() {
* listed with proper titles and descriptions in the Site Editor.
*
* @since Ipsum 1.0
*
* @param array $default_template_types The default template types.
* @return array
* @return array The template types, with the sidebar variants added.
*/
function ipsum_sidebar_template_types( $default_template_types ) {
$default_template_types['index-sidebar'] = array(
Expand All @@ -129,6 +135,7 @@ function ipsum_sidebar_template_types( $default_template_types ) {
* Registers the pattern categories the theme's patterns use beyond core's.
*
* @since Ipsum 1.0
*
* @return void
*/
function ipsum_pattern_categories() {
Expand All @@ -154,8 +161,9 @@ function ipsum_pattern_categories() {
* the patterns set the name.
*
* @since Ipsum 1.0
*
* @param array $metadata Metadata for the block type being registered.
* @return array
* @return array The block metadata, with ARIA label support on the Search block.
*/
function ipsum_search_aria_label_support( $metadata ) {
if ( isset( $metadata['name'] ) && 'core/search' === $metadata['name'] ) {
Expand All @@ -174,6 +182,7 @@ function ipsum_search_aria_label_support( $metadata ) {
* so the block reads as a dark slab under every style variation.
*
* @since Ipsum 1.0
*
* @return void
*/
function ipsum_block_styles() {
Expand Down
Loading