WordPress.org
Get WordPress

Plugin Directory

Changeset 3369538


Ignore:
Timestamp:
09/29/2025 09:04:52 AM (4 months ago)
Author:
jdahir0789
Message:

Update readme file for SEO

Location:
hook-locator
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • hook-locator/tags/1.0/readme.txt

    r3365558 r3369538  
    1212License URI: https://www.gnu.org/licenses/gpl-2.0.html
    1313
    14 Find, search, and debug WordPress hooks instantly. A powerful developer tool to analyze actions, filters, and custom hooks in plugins and themes.
     14Professional WordPress hook analysis tool for developers. Search and analyze hook usage in plugins and themes with detailed code context.
    1515
    1616== Description ==
    1717
    18 Search and debug WordPress hooks with ease. Analyze actions & filters in plugins and themes using a fast, secure developer tool.
    19 
    20 ### Why Use Hook Locator?
    21 
    22 * **Find WordPress hooks instantly** – Search any hook name (`init`, `wp_head`, `save_post`, or custom hooks)
    23 * **Analyze plugins and themes** – Organized dropdowns for scanning specific directories
    24 * **Debug faster** – View exact file paths, line numbers, and code context with highlighting
    25 * **Optimize performance** – Detect unnecessary or conflicting hooks
    26 * **Improve code quality** – Ensure proper usage of actions and filters
    27 * **Developer-friendly UI** – Modern, professional, and follows WordPress admin design standards
    28 
    29 ### Key Features
    30 
    31 * **Advanced Hook Search** – Quickly find hooks in plugins, themes, or the entire site 
    32 * **Detailed Code Analysis** – Highlighted code snippets with surrounding context 
    33 * **Multiple Hook Types** – Detects `add_action`, `add_filter`, `do_action`, `apply_filters`, and more 
    34 * **Secure & Reliable** – Nonce verification, sanitization, and admin-only access 
    35 * **Performance Optimized** – Smart scanning with limits to prevent timeouts 
    36 * **Export & Copy Tools** – Copy code snippets or export results for documentation 
    37 * **Accessibility Ready** – Works with keyboard navigation and screen readers 
    38 * **Translation Ready** – Full internationalization support
    39 
    40 ### Perfect For
    41 
    42 * **Plugin Developers** – Debug hook conflicts and ensure compatibility 
    43 * **Theme Developers** – Analyze theme customization and hook usage 
    44 * **Auditors & Security Reviewers** – Check for unsafe or inefficient hook usage 
    45 * **WordPress Learners** – Understand how hooks work in real-world code 
    46 * **Site Maintainers** – Troubleshoot issues and optimize performance 
    47 
    48 ### How It Works
    49 
    50 1. Go to **Tools > Hook Locator** in your WordPress admin 
    51 2. Enter a hook name (e.g. `init`, `wp_head`, `save_post`) 
    52 3. Select a directory (all plugins, a specific plugin, or a theme) 
    53 4. Click **Search Hooks** 
    54 5. View results with file paths, line numbers, and hook types 
    55 6. Click any result for detailed highlighted code context 
    56 
    57 ---
    58 
    59 ### Debug WordPress Hooks with Ease
    60 
    61 Finding hooks in large WordPress sites can be overwhelming. Hook Locator gives developers a **fast, reliable, and professional way** to understand and debug how actions and filters are used—making development, optimization, and troubleshooting much easier.
    62 
    63 ---
    64 
    65 == Installation ==
    66 
    67 ### Automatic Installation
    68 1. In WordPress admin, go to **Plugins > Add New** 
    69 2. Search for **Hook Locator** 
    70 3. Click **Install Now** and then **Activate**
    71 
    72 ### Manual Installation
    73 1. Download the plugin ZIP file 
    74 2. Go to **Plugins > Add New > Upload Plugin** 
    75 3. Upload the ZIP and click **Install Now** 
    76 4. Activate the plugin 
    77 
    78 ### Getting Started
    79 1. Go to **Tools > Hook Locator** 
    80 2. Enter a hook name to search 
    81 3. Select plugins, themes, or all directories 
    82 4. Review results with file paths and code context 
    83 
    84 ---
    85 
    86 == Frequently Asked Questions ==
    87 
    88 = How do I find all hooks in a WordPress plugin? =
    89 Simply choose the plugin from the dropdown, leave the search input blank, and Hook Locator will scan and list all actions and filters inside that plugin.
    90 
    91 = Can I use Hook Locator to debug custom hooks? =
    92 Yes. It works with both core WordPress hooks and custom hooks defined by plugins, themes, or your own code.
    93 
    94 = Does Hook Locator slow down my site? =
    95 No. The plugin only runs in the admin panel when you perform a search. It does not load on the frontend and does not affect site performance.
    96 
    97 = What is the difference between Hook Locator and runtime hook loggers? =
    98 Hook Locator performs **static code analysis**. It scans the source code to detect all hook references, even those that might not run during a specific request. This makes it more complete and reliable compared to runtime loggers.
    99 
    100 = Can it help me fix plugin conflicts? =
    101 Yes. By showing you where hooks are added or triggered, Hook Locator helps identify conflicts between plugins or themes so you can resolve issues faster.
    102 
    103 = Does Hook Locator work with WordPress multisite? =
    104 Yes. It works on multisite installations. Each site can independently use Hook Locator to analyze its plugins and themes.
    105 
    106 = Is Hook Locator safe to use on production sites? =
    107 Absolutely. It only **reads** files; it never modifies code. All operations are restricted to administrators.
    108 
    109 ---
     18**Hook Locator** is the ultimate WordPress development tool for analyzing hook usage across your plugins and themes. Built for developers, it provides a professional admin interface to search, analyze, and understand WordPress hook implementations.
    11019
    11120== Screenshots ==
    … …  
    116254. Hook Type Detection – Color-coded badges for different hook functions 
    117265. Mobile Responsive – Works on desktops, tablets, and mobile devices 
     27
     28### Key Features
     29
     30* **Advanced Hook Search** - Find any WordPress hook across all plugins and themes
     31* **Organized Directory Selection** - Separate dropdowns for plugins and themes with clean organization 
     32* **Detailed Code Analysis** - View exact file locations with highlighted code context
     33* **Multiple Hook Types** - Supports add_action, add_filter, do_action, apply_filters, and more
     34* **Professional Interface** - Clean, modern admin UI following WordPress design standards
     35* **Performance Optimized** - Efficient scanning with built-in safeguards and limits
     36* **Security First** - Proper nonce verification, sanitization, and capability checks
     37* **Developer Tools** - Click-to-copy code snippets, keyboard shortcuts, and export features
     38
     39### Perfect For
     40
     41* **Plugin Developers** - Debug hook conflicts and understand plugin interactions
     42* **Theme Developers** - Analyze theme hook implementations and customizations 
     43* **Code Auditors** - Review hook usage patterns and security implementations
     44* **WordPress Learners** - Understand how WordPress hooks work in real code
     45* **Site Maintainers** - Debug issues and optimize hook performance
     46
     47### How It Works
     48
     491. **Search Interface** - Enter any hook name and select search location
     502. **Instant Results** - View all matching files with line numbers and hook types
     513. **Code Context** - Click any result to see highlighted code with surrounding lines
     524. **Analysis Tools** - Get insights about hook types, usage patterns, and best practices
     53
     54### WordPress Standards Compliant
     55
     56* **PHPCS/WPCS Compatible** - Follows all WordPress coding standards
     57* **Secure Implementation** - Proper sanitization, nonces, and capability checks
     58* **Performance Optimized** - Efficient file scanning with resource limits
     59* **Accessibility Ready** - Keyboard navigation and screen reader compatible
     60* **Translation Ready** - Full internationalization support
     61
     62== Installation ==
     63
     64### Automatic Installation
     651. Go to **Plugins > Add New** in your WordPress admin
     662. Search for "Hook Locator"
     673. Click **Install Now** and then **Activate**
     68
     69### Manual Installation
     701. Download the plugin ZIP file
     712. Go to **Plugins > Add New > Upload Plugin**
     723. Choose the ZIP file and click **Install Now**
     734. Activate the plugin
     74
     75### Getting Started
     761. Navigate to **Tools > Hook Locator** in your WordPress admin
     772. Enter a hook name (e.g., "init", "wp_head", "save_post")
     783. Select search location (All, specific plugin, or theme)
     794. Click **Search Hooks** to see results
     805. Click **View Details** on any result for code analysis
     81
     82== Frequently Asked Questions ==
     83
     84= Does this affect my site performance? =
     85
     86No! Hook Locator only runs in the WordPress admin when you actively search. There's no frontend code or background processing that affects your site's performance.
     87
     88= What file types does it search? =
     89
     90Hook Locator searches only PHP files (.php) since WordPress hooks are PHP-based. It automatically skips other file types for optimal performance.
     91
     92= Can I search for custom hooks? =
     93
     94Absolutely! Hook Locator finds any hook name you specify, including custom hooks created by plugins, themes, or your own code.
     95
     96= Is it safe to use on production sites? =
     97
     98Yes, Hook Locator is completely safe for production use. It only reads files and never modifies any code. All operations are restricted to users with administrator privileges.
     99
     100= Does it work with multisite? =
     101
     102Yes, Hook Locator works perfectly with WordPress multisite installations. Each site can use it independently to analyze their specific plugins and themes.
     103
     104= Can I export the search results? =
     105
     106Currently, you can copy individual code snippets to your clipboard. Future versions may include CSV/JSON export functionality based on user feedback.
     107
     108= What's the difference from other hook plugins? =
     109
     110Hook Locator focuses on static code analysis rather than runtime hook capture. This makes it more accurate, secure, and performant while providing deeper code insights.
    118111
    119112---

  • hook-locator/trunk/readme.txt

    r3365558 r3369538  
    1212License URI: https://www.gnu.org/licenses/gpl-2.0.html
    1313
    14 Find, search, and debug WordPress hooks instantly. A powerful developer tool to analyze actions, filters, and custom hooks in plugins and themes.
     14Professional WordPress hook analysis tool for developers. Search and analyze hook usage in plugins and themes with detailed code context.
    1515
    1616== Description ==
    1717
    18 Search and debug WordPress hooks with ease. Analyze actions & filters in plugins and themes using a fast, secure developer tool.
    19 
    20 ### Why Use Hook Locator?
    21 
    22 * **Find WordPress hooks instantly** – Search any hook name (`init`, `wp_head`, `save_post`, or custom hooks)
    23 * **Analyze plugins and themes** – Organized dropdowns for scanning specific directories
    24 * **Debug faster** – View exact file paths, line numbers, and code context with highlighting
    25 * **Optimize performance** – Detect unnecessary or conflicting hooks
    26 * **Improve code quality** – Ensure proper usage of actions and filters
    27 * **Developer-friendly UI** – Modern, professional, and follows WordPress admin design standards
    28 
    29 ### Key Features
    30 
    31 * **Advanced Hook Search** – Quickly find hooks in plugins, themes, or the entire site 
    32 * **Detailed Code Analysis** – Highlighted code snippets with surrounding context 
    33 * **Multiple Hook Types** – Detects `add_action`, `add_filter`, `do_action`, `apply_filters`, and more 
    34 * **Secure & Reliable** – Nonce verification, sanitization, and admin-only access 
    35 * **Performance Optimized** – Smart scanning with limits to prevent timeouts 
    36 * **Export & Copy Tools** – Copy code snippets or export results for documentation 
    37 * **Accessibility Ready** – Works with keyboard navigation and screen readers 
    38 * **Translation Ready** – Full internationalization support
    39 
    40 ### Perfect For
    41 
    42 * **Plugin Developers** – Debug hook conflicts and ensure compatibility 
    43 * **Theme Developers** – Analyze theme customization and hook usage 
    44 * **Auditors & Security Reviewers** – Check for unsafe or inefficient hook usage 
    45 * **WordPress Learners** – Understand how hooks work in real-world code 
    46 * **Site Maintainers** – Troubleshoot issues and optimize performance 
    47 
    48 ### How It Works
    49 
    50 1. Go to **Tools > Hook Locator** in your WordPress admin 
    51 2. Enter a hook name (e.g. `init`, `wp_head`, `save_post`) 
    52 3. Select a directory (all plugins, a specific plugin, or a theme) 
    53 4. Click **Search Hooks** 
    54 5. View results with file paths, line numbers, and hook types 
    55 6. Click any result for detailed highlighted code context 
    56 
    57 ---
    58 
    59 ### Debug WordPress Hooks with Ease
    60 
    61 Finding hooks in large WordPress sites can be overwhelming. Hook Locator gives developers a **fast, reliable, and professional way** to understand and debug how actions and filters are used—making development, optimization, and troubleshooting much easier.
    62 
    63 ---
    64 
    65 == Installation ==
    66 
    67 ### Automatic Installation
    68 1. In WordPress admin, go to **Plugins > Add New** 
    69 2. Search for **Hook Locator** 
    70 3. Click **Install Now** and then **Activate**
    71 
    72 ### Manual Installation
    73 1. Download the plugin ZIP file 
    74 2. Go to **Plugins > Add New > Upload Plugin** 
    75 3. Upload the ZIP and click **Install Now** 
    76 4. Activate the plugin 
    77 
    78 ### Getting Started
    79 1. Go to **Tools > Hook Locator** 
    80 2. Enter a hook name to search 
    81 3. Select plugins, themes, or all directories 
    82 4. Review results with file paths and code context 
    83 
    84 ---
    85 
    86 == Frequently Asked Questions ==
    87 
    88 = How do I find all hooks in a WordPress plugin? =
    89 Simply choose the plugin from the dropdown, leave the search input blank, and Hook Locator will scan and list all actions and filters inside that plugin.
    90 
    91 = Can I use Hook Locator to debug custom hooks? =
    92 Yes. It works with both core WordPress hooks and custom hooks defined by plugins, themes, or your own code.
    93 
    94 = Does Hook Locator slow down my site? =
    95 No. The plugin only runs in the admin panel when you perform a search. It does not load on the frontend and does not affect site performance.
    96 
    97 = What is the difference between Hook Locator and runtime hook loggers? =
    98 Hook Locator performs **static code analysis**. It scans the source code to detect all hook references, even those that might not run during a specific request. This makes it more complete and reliable compared to runtime loggers.
    99 
    100 = Can it help me fix plugin conflicts? =
    101 Yes. By showing you where hooks are added or triggered, Hook Locator helps identify conflicts between plugins or themes so you can resolve issues faster.
    102 
    103 = Does Hook Locator work with WordPress multisite? =
    104 Yes. It works on multisite installations. Each site can independently use Hook Locator to analyze its plugins and themes.
    105 
    106 = Is Hook Locator safe to use on production sites? =
    107 Absolutely. It only **reads** files; it never modifies code. All operations are restricted to administrators.
    108 
    109 ---
     18**Hook Locator** is the ultimate WordPress development tool for analyzing hook usage across your plugins and themes. Built for developers, it provides a professional admin interface to search, analyze, and understand WordPress hook implementations.
    11019
    11120== Screenshots ==
    … …  
    116254. Hook Type Detection – Color-coded badges for different hook functions 
    117265. Mobile Responsive – Works on desktops, tablets, and mobile devices 
     27
     28### Key Features
     29
     30* **Advanced Hook Search** - Find any WordPress hook across all plugins and themes
     31* **Organized Directory Selection** - Separate dropdowns for plugins and themes with clean organization 
     32* **Detailed Code Analysis** - View exact file locations with highlighted code context
     33* **Multiple Hook Types** - Supports add_action, add_filter, do_action, apply_filters, and more
     34* **Professional Interface** - Clean, modern admin UI following WordPress design standards
     35* **Performance Optimized** - Efficient scanning with built-in safeguards and limits
     36* **Security First** - Proper nonce verification, sanitization, and capability checks
     37* **Developer Tools** - Click-to-copy code snippets, keyboard shortcuts, and export features
     38
     39### Perfect For
     40
     41* **Plugin Developers** - Debug hook conflicts and understand plugin interactions
     42* **Theme Developers** - Analyze theme hook implementations and customizations 
     43* **Code Auditors** - Review hook usage patterns and security implementations
     44* **WordPress Learners** - Understand how WordPress hooks work in real code
     45* **Site Maintainers** - Debug issues and optimize hook performance
     46
     47### How It Works
     48
     491. **Search Interface** - Enter any hook name and select search location
     502. **Instant Results** - View all matching files with line numbers and hook types
     513. **Code Context** - Click any result to see highlighted code with surrounding lines
     524. **Analysis Tools** - Get insights about hook types, usage patterns, and best practices
     53
     54### WordPress Standards Compliant
     55
     56* **PHPCS/WPCS Compatible** - Follows all WordPress coding standards
     57* **Secure Implementation** - Proper sanitization, nonces, and capability checks
     58* **Performance Optimized** - Efficient file scanning with resource limits
     59* **Accessibility Ready** - Keyboard navigation and screen reader compatible
     60* **Translation Ready** - Full internationalization support
     61
     62== Installation ==
     63
     64### Automatic Installation
     651. Go to **Plugins > Add New** in your WordPress admin
     662. Search for "Hook Locator"
     673. Click **Install Now** and then **Activate**
     68
     69### Manual Installation
     701. Download the plugin ZIP file
     712. Go to **Plugins > Add New > Upload Plugin**
     723. Choose the ZIP file and click **Install Now**
     734. Activate the plugin
     74
     75### Getting Started
     761. Navigate to **Tools > Hook Locator** in your WordPress admin
     772. Enter a hook name (e.g., "init", "wp_head", "save_post")
     783. Select search location (All, specific plugin, or theme)
     794. Click **Search Hooks** to see results
     805. Click **View Details** on any result for code analysis
     81
     82== Frequently Asked Questions ==
     83
     84= Does this affect my site performance? =
     85
     86No! Hook Locator only runs in the WordPress admin when you actively search. There's no frontend code or background processing that affects your site's performance.
     87
     88= What file types does it search? =
     89
     90Hook Locator searches only PHP files (.php) since WordPress hooks are PHP-based. It automatically skips other file types for optimal performance.
     91
     92= Can I search for custom hooks? =
     93
     94Absolutely! Hook Locator finds any hook name you specify, including custom hooks created by plugins, themes, or your own code.
     95
     96= Is it safe to use on production sites? =
     97
     98Yes, Hook Locator is completely safe for production use. It only reads files and never modifies any code. All operations are restricted to users with administrator privileges.
     99
     100= Does it work with multisite? =
     101
     102Yes, Hook Locator works perfectly with WordPress multisite installations. Each site can use it independently to analyze their specific plugins and themes.
     103
     104= Can I export the search results? =
     105
     106Currently, you can copy individual code snippets to your clipboard. Future versions may include CSV/JSON export functionality based on user feedback.
     107
     108= What's the difference from other hook plugins? =
     109
     110Hook Locator focuses on static code analysis rather than runtime hook capture. This makes it more accurate, secure, and performant while providing deeper code insights.
    118111
    119112---
Note: See TracChangeset for help on using the changeset viewer.