How to add custom attributes (author, category) to the index?
-
Hello,
I am using the Yuto Search plugin and it works great for searching titles and content. Now, I want to enrich the search results by adding the author’s name and the post’s category.
Do you have, or could you please provide me with a working example of the PHP code needed to add custom data to the index?
I only have title and excerpt as a results, but really would love to add the category and author name as wellThank you very much in advance!
-
Hello @justgert ,
That’s great news — thank you for confirming!
We’re glad the dependency handle adjustment did the trick and that categories are now indexing properly.- Below is a complete example of the
yuto-custom-config.jsfile which you can load on the admin side. It’s also up to you whether you’d like to include author_name (and categories) as part of your searchable attributes or show it on the frontend template.
document.addEventListener("DOMContentLoaded", function () {
wp.hooks.addFilter(
"yuto_searchable_attributes",
"your_namespace",
your_prefix_change_searchable_attributes,
10,
);
function your_prefix_change_searchable_attributes(
searchableAttributes,
UID,
) {
searchableAttributes = ["categories"];
return searchableAttributes;
}
// Fetch term names (categories or tags) for a specific post
const getPostTermNames = async (term = "categories", postId) => {
try {
// Fetch the term objects (categories/tags) for the given post ID
const terms = await wp.apiFetch({
path:/wp/v2/${term}?post=${postId}&per_page=100,
});
// Map the term objects to extract only the name of each term
const termNames = terms.map((term) => term.name);
return termNames;
} catch (error) {
console.error("Error fetching the terms:", error);
return [];
}
};
// Fetch the author name for a specific post
const getPostAuthorName = async (postId) => {
try {
// First, fetch the post to get the author ID
const post = await wp.apiFetch({
path:/wp/v2/posts/${postId},
});
const authorId = post.author;
if (!authorId) {
return "";
}
// Fetch the author user object
const author = await wp.apiFetch({
path:/wp/v2/users/${authorId},
});
return author.name || "";
} catch (error) {
console.error("Error fetching the author:", error);
return "";
}
};
// Modify document data for a post to include category and tag names
const your_prefix_modify_documents_data = async (data, post, UID, restBase) => {
if ("posts" == restBase) {
// Fetch and add category names to the data
const categoriesNames = await getPostTermNames("categories", post.id);
data["categories"] = categoriesNames;
// Fetch post author and add to the data
data["author_name"] = await getPostAuthorName(post.id);
}
return data;
};
// Add 'categories' and 'tags' to filterable attributes for posts
wp.hooks.addFilter(
"yuto_modify_documents_data",
"your_namespace",
your_prefix_modify_documents_data,
);
});2. Thank you for raising this important point. You’re absolutely right — for large sites, relying solely on client-side API calls can add unnecessary load and isn’t the most efficient long-term solution.
In the meantime, we do provide a WP-CLI command that you can use to reindex and manage documents directly from the server. This can help bypass some of the limitations of client-side calls and is much more efficient for larger sites.
Please don’t hesitate to reach out if you run into anything else or have further ideas — your feedback helps us keep improving the plugin.
Regards,
Pono PressHello,
Thank you for your continued support. I have completed my testing and wanted to provide you with my final feedback on the indexing process for large sites (27,000+ posts) with version 0.1.3.
First, the good news: I can now successfully index custom attributes like
categoriesandtags, and authors. So the base functionality of the JavaScript hooks is working. However, there are two critical issues with the available indexing methods.1. The Client-Side (Browser) Indexing Method:
- Problem: When indexing from the admin page, my server’s CPU load is constantly at 100% and the server load average goes up to 30+.
- Symptom: The browser console shows over 2,000+ network errors (
net::ERR_FAILEDandnet::ERR_CERT_VERIFIER_CHANGED). - Diagnosis: The client-side method, which makes thousands of individual
wp.apiFetchcalls, is creating a “self-DDoS” effect. My server’s security and rate-limiting measures are triggered, which causes many of the API calls to fail. This results in an incomplete index where some posts have the custom attributes, and many do not. Hit and miss here.
Also the Undefined array key “adminAPIKey” in /www/wwwroot/www.mydomain.ext/wp-content/plugins/yuto/inc/admin/setting.php on line 157 is still present. Even after saving the settings again.
2. The Server-Side (WP-CLI) Indexing Method:
- Problem: When I try to use the
wp yuto build-index postscommand as you suggested, the process fails with a fatal PHP error. - Symptom: The command aborts after encountering this error:
PHP Fatal error: Uncaught TypeError: ftp_pwd(): Argument #1 ($ftp) must be of type FTP\Connection, null given in /wp-admin/includes/class-wp-filesystem-ftpext.php:230 - Diagnosis: The stack trace shows this error is triggered by a conflict with the a populair Member plugin, which makes an incompatible call to the WordPress Filesystem API within the WP-CLI environment.
Conclusion & Suggestion: Based on this, it seems both currently available methods are not viable for a large, production website with other complex plugins:
- The client-side method is not scalable and causes server overload and an incomplete index.
- The server-side WP-CLI method is not robust enough and can be broken by conflicts with other popular plugins.
The most stable, efficient, and professional solution for large sites would be a server-side PHP filter (like
yuto_document_map). This method would enrich the data in a single, fast PHP loop, avoiding both the server overload and the WP-CLI conflicts.Could you please consider re-implementing or fixing the server-side PHP filters in a future update? For users with large websites, this seems to be the only truly reliable path forward.Thank you again for your time and the great plugin.
Edit: typo
- Below is a complete example of the
You must be logged in to reply to this topic.
