Skip to content

Twenty Eleven: Improve PHP DocBlock compliance with documentation standards #10482

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

Closed
wants to merge 5 commits into from
+35 −16
Closed

Twenty Eleven: Improve PHP DocBlock compliance with documentation standards #10482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e7f332f
Twenty Eleven: Improve PHP DocBlock compliance with documentation sta…
huzaifaalmesbah Nov 7, 2025
bf87b33
Updated @since version number for twentyeleven_theme_options_help()
huzaifaalmesbah Nov 11, 2025
54e27a1
Added missing @since note for twentyeleven_option_page_capability()
huzaifaalmesbah Nov 11, 2025
a5ec617
Merge branch 'trunk' into update/twentyeleven-docblock-standards
westonruter Nov 25, 2025
aef0966
Add more specific types and fix a return type
westonruter Nov 25, 2025
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
43 changes: 29 additions & 14 deletions src/wp-content/themes/twentyeleven/inc/theme-options.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
*/

/**
* Properly enqueues styles and scripts for our theme options page.
* Enqueues styles and scripts for the theme options page.
*
* This function is attached to the admin_enqueue_scripts action hook.
*
Expand Down Expand Up @@ -75,6 +75,8 @@ function twentyeleven_theme_options_init() {
* By default, only administrators have either of these capabilities, but the desire here is
* to allow for finer-grained control for roles and users.
*
* @since Twenty Eleven 1.1
*
* @param string $capability The capability used for the page, which is manage_options by default.
* @return string The capability to actually use.
*/
Expand All @@ -84,7 +86,7 @@ function twentyeleven_option_page_capability( $capability ) {
add_filter( 'option_page_capability_twentyeleven_options', 'twentyeleven_option_page_capability' );

/**
* Adds a theme options page to the admin menu, including some help documentation.
* Adds the theme options page to the admin menu, including help documentation.
*
* This function is attached to the admin_menu action hook.
*
Expand All @@ -107,6 +109,11 @@ function twentyeleven_theme_options_add_page() {
}
add_action( 'admin_menu', 'twentyeleven_theme_options_add_page' );

/**
* Adds help documentation to the theme options page.
*
* @since Twenty Eleven 1.3
*/
function twentyeleven_theme_options_help() {

$help = '<p>' . __( 'Some themes provide customization options that are grouped together on a Theme Options screen. If you change themes, options may change or disappear, as they are theme-specific. Your current theme, Twenty Eleven, provides the following Theme Options:', 'twentyeleven' ) . '</p>' .
Expand Down Expand Up @@ -144,6 +151,8 @@ function twentyeleven_theme_options_help() {
* Returns an array of color schemes registered for Twenty Eleven.
*
* @since Twenty Eleven 1.0
*
* @return array<string, array<string, string>> An associative array of color scheme options.
*/
function twentyeleven_color_schemes() {
$color_scheme_options = array(
Expand All @@ -166,7 +175,7 @@ function twentyeleven_color_schemes() {
*
* @since Twenty Eleven 1.0
*
* @param array $color_scheme_options An associative array of color scheme options.
* @param array<string, array<string, string>> $color_scheme_options An associative array of color scheme options.
*/
return apply_filters( 'twentyeleven_color_schemes', $color_scheme_options );
}
Expand All @@ -175,6 +184,8 @@ function twentyeleven_color_schemes() {
* Returns an array of layout options registered for Twenty Eleven.
*
* @since Twenty Eleven 1.0
*
* @return array<string, array<string, string>> An associative array of layout options.
*/
function twentyeleven_layouts() {
$layout_options = array(
Expand All @@ -200,7 +211,7 @@ function twentyeleven_layouts() {
*
* @since Twenty Eleven 1.0
*
* @param array $layout_options An associative array of layout options.
* @param array<string, array<string, string>> $layout_options An associative array of layout options.
*/
return apply_filters( 'twentyeleven_layouts', $layout_options );
}
Expand All @@ -210,7 +221,7 @@ function twentyeleven_layouts() {
*
* @since Twenty Eleven 1.0
*
* @return array An array of default theme options.
* @return array<string, string> An array of default theme options.
*/
function twentyeleven_get_default_theme_options() {
$default_theme_options = array(
Expand All @@ -228,7 +239,7 @@ function twentyeleven_get_default_theme_options() {
*
* @since Twenty Eleven 1.0
*
* @param array $default_theme_options An array of default theme options.
* @param array<string, string> $default_theme_options An array of default theme options.
*/
return apply_filters( 'twentyeleven_default_theme_options', $default_theme_options );
}
Expand All @@ -240,7 +251,7 @@ function twentyeleven_get_default_theme_options() {
*
* @param string $color_scheme Optional. Color scheme.
* Default null (or the active color scheme).
* @return string The default link color.
* @return string|false The default link color, or false if not set.
*/
function twentyeleven_get_default_link_color( $color_scheme = null ) {
if ( null === $color_scheme ) {
Expand All @@ -260,6 +271,8 @@ function twentyeleven_get_default_link_color( $color_scheme = null ) {
* Returns the options array for Twenty Eleven.
*
* @since Twenty Eleven 1.0
*
* @return array<string, string> The theme options array.
*/
function twentyeleven_get_theme_options() {
return get_option( 'twentyeleven_theme_options', twentyeleven_get_default_theme_options() );
Expand Down Expand Up @@ -372,6 +385,7 @@ function twentyeleven_theme_options_render_page() {
* @since Twenty Eleven 1.0
*
* @param array $input An array of form input.
* @return array<string, string> An array of sanitized and validated form output.
*/
function twentyeleven_theme_options_validate( $input ) {
$defaults = twentyeleven_get_default_theme_options();
Expand Down Expand Up @@ -401,9 +415,9 @@ function twentyeleven_theme_options_validate( $input ) {
*
* @since Twenty Eleven 1.0
*
* @param array $output An array of sanitized form output.
* @param array $input An array of un-sanitized form input.
* @param array $defaults An array of default theme options.
* @param array<string, string> $output An array of sanitized form output.
* @param array $input An array of un-sanitized form input.
* @param array<string, string> $defaults An array of default theme options.
*/
return apply_filters( 'twentyeleven_theme_options_validate', $output, $input, $defaults );
}
Expand Down Expand Up @@ -486,7 +500,8 @@ function twentyeleven_print_link_color_style() {
*
* @since Twenty Eleven 1.0
*
* @param array $existing_classes An array of existing body classes.
* @param string[] $existing_classes An array of existing body classes.
* @return string[] The filtered array of body classes.
*/
function twentyeleven_layout_classes( $existing_classes ) {
$options = twentyeleven_get_theme_options();
Expand All @@ -511,8 +526,8 @@ function twentyeleven_layout_classes( $existing_classes ) {
*
* @since Twenty Eleven 1.0
*
* @param array $classes An array of body classes.
* @param string $current_layout The current theme layout.
* @param string[] $classes An array of body classes.
* @param string $current_layout The current theme layout.
*/
$classes = apply_filters( 'twentyeleven_layout_classes', $classes, $current_layout );

Expand All @@ -521,7 +536,7 @@ function twentyeleven_layout_classes( $existing_classes ) {
add_filter( 'body_class', 'twentyeleven_layout_classes' );

/**
* Implements Twenty Eleven theme options into Customizer
* Implements Twenty Eleven theme options into Customizer.
*
* @since Twenty Eleven 1.3
*
Expand Down
8 changes: 6 additions & 2 deletions src/wp-content/themes/twentyeleven/inc/widgets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ public function Twenty_Eleven_Ephemera_Widget() {
*
* @since Twenty Eleven 1.0
*
* @param array $args An array of standard parameters for widgets in this theme.
* @param array $instance An array of settings for this widget instance.
* @param array $args An array of standard parameters for widgets in this theme.
* @param array<string, string|int> $instance An array of settings for this widget instance.
*/
public function widget( $args, $instance ) {
$cache = wp_cache_get( 'widget_twentyeleven_ephemera', 'widget' );
Expand Down Expand Up @@ -156,6 +156,10 @@ public function widget( $args, $instance ) {
* where any validation should be dealt with.
*
* @since Twenty Eleven 1.0
*
* @param array $new_instance New widget instance.
* @param array $old_instance Original widget instance.
* @return array<string, string|int> Updated widget instance.
*/
public function update( $new_instance, $old_instance ) {
$instance = $old_instance;
Expand Down
Loading