choose_primary_blog()
- Since
- 3.0.0
- Source
wp-admin/includes/ms.php:762
Description
This displays the user's primary site and allows the user to choose which site is primary.
Compatibility
- WordPress
- since 3.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Performance profile
How much work a call to choose_primary_blog() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Scales with input
- Instructions
- 30–53
- Plugin surface
- None
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 104.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below choose_primary_blog() - optionoption read or write
get_option()one call below choose_primary_blog()
Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost choose_primary_blog() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 30 | _e(), get_current_user_id(), get_blogs_of_user(), get_current_user_id(), get_user_meta(), _e() |
| always | 31–32 | _e(), get_current_user_id(), get_blogs_of_user(), get_current_user_id(), get_user_meta() |
$primary_blog === false | 43 | _e(), get_current_user_id(), get_blogs_of_user(), get_current_user_id(), get_user_meta(), reset(), get_home_url(), esc_url() |
| always | 45–46 | _e(), get_current_user_id(), get_blogs_of_user(), get_current_user_id(), get_user_meta(), reset(), get_current_user_id(), update_user_meta() |
$primary_blog !== false | 53 | _e(), get_current_user_id(), get_blogs_of_user(), get_current_user_id(), get_user_meta(), reset(), get_home_url(), esc_url(), get_current_user_id(), update_user_meta() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 104 instructions, 30–53 executed per call, 7 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 8
- _e()Displays translated text.
- get_blogs_of_user()Gets the sites a user belongs to.
- get_current_user_id()Gets the current user's ID.
- get_user_meta()Retrieves user meta field for a user.
- selected()Outputs the HTML selected attribute.
- esc_url()Checks and cleans a URL.
- get_home_url()Retrieves the URL for a given site where the front end is accessible.
- update_user_meta()Updates user meta field based on user ID.
Source code
function choose_primary_blog() { ?> <table class="form-table" role="presentation"> <tr> <?php /* translators: My Sites label. */ ?> <th scope="row"><label for="primary_blog"><?php _e( 'Primary Site' ); ?></label></th> <td> <?php $all_blogs = get_blogs_of_user( get_current_user_id() ); $primary_blog = (int) get_user_meta( get_current_user_id(), 'primary_blog', true ); if ( count( $all_blogs ) > 1 ) { $found = false; ?> <select name="primary_blog" id="primary_blog"> <?php foreach ( (array) $all_blogs as $blog ) { if ( $blog->userblog_id === $primary_blog ) { $found = true; } ?> <option value="<?php echo $blog->userblog_id; ?>"<?php selected( $primary_blog, $blog->userblog_id ); ?>><?php echo esc_url( get_home_url( $blog->userblog_id ) ); ?></option> <?php } ?> </select> <?php if ( ! $found ) { $blog = reset( $all_blogs ); update_user_meta( get_current_user_id(), 'primary_blog', $blog->userblog_id ); } } elseif ( 1 === count( $all_blogs ) ) { $blog = reset( $all_blogs ); echo esc_url( get_home_url( $blog->userblog_id ) ); if ( $blog->userblog_id !== $primary_blog ) { // Set the primary blog again if it's out of sync with blog list. update_user_meta( get_current_user_id(), 'primary_blog', $blog->userblog_id ); } } else { _e( 'Not available' ); } ?> </td> </tr> </table> <?php}Changelog
Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-admin/includes/ms.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.